Spread ASP.NET 14
FarPoint.Web.Spread Assembly / FarPoint.Web.Spread Namespace / SheetView Class
Fields Properties Methods


In This Topic
    SheetView Class Members
    In This Topic

    The following tables list the members exposed by SheetView.

    Public Constructors
     NameDescription
    Public ConstructorOverloaded.   
    Top
    Protected Fields
     NameDescription
    Protected FieldSpecifies a list of child views in a hierarchical display for this sheet.  
    Protected FieldSpecifies the parent view for this sheet.  
    Top
    Public Properties
     NameDescription
    Public PropertyGets or sets the active chart.  
    Public PropertyGets or sets the active column.  
    Public PropertyGets or sets the active image.  
    Public PropertyGets or sets the active row.  
    Public PropertyGets or sets the current active skin.  
    Public PropertyGets or sets whether to allow the user to move columns.  
    Public PropertyGets or sets whether a user can delete a row in the sheet.  
    Public PropertyGets or sets whether a user can group rows.  
    Public PropertyGets or sets whether a user can insert a row in the sheet.  
    Public PropertyGets or sets whether to allow incremental loads to the client on demand when the user is scrolling.  
    Public PropertyGets or sets whether the sheet displays the number of pages and the arrows for navigating to other pages in the sheet.  
    Public PropertyGets or sets whether to allow the user to move rows.  
    Public PropertyGets or sets whether users can sort rows in the sheet.  
    Public PropertyGets or sets whether to allow the sheet corner to be a structure table.  
    Public PropertyGets or sets whether to allow the user to enter formulas in a cell in the control.  
    Public PropertyGets or sets whether to allow virtual paging to load data when the user is scrolling.  
    Public PropertyGets the alternating rows in the specified portion of the sheet.  
    Public PropertyGets or sets whether the control automatically recalculates each formula in the sheet when the contents of dependent cells change.  
    Public PropertyGets or sets the AutoFilterMode which indicates which filtering UI is used.  
    Public PropertyGets or sets whether to generate the columns automatically based on the data source.  
    Public PropertyGets or sets whether a postback to the server automatically occurs when the user interacts with the sheet.  
    Public PropertyGets or sets the background color of the sheet.  
    Public PropertyGets the cells in the data area of the sheet.  
    Public PropertyGets or sets the cell spacing to use in the displayed HTML page.  
    Public PropertyGets the charts.  
    Public PropertyGets the number of child views in a hierarchical display for this sheet.  
    Public PropertyWhen this property is true and client script is enabled, the spread will expand the row in a hierarchical view when the row header cell is clicked; otherwise, the spread will expand the row only when the expand image is clicked.  
    Public PropertyGets or sets the column information for the sheet.  
    Public PropertyGets or sets the number of columns in the sheet.  
    Public PropertyGets the column footers for the sheet.  
    Public PropertyGets or sets the data for the column footer.  
    Public PropertyGets or sets the column footer height.  
    Public PropertyGets or sets the row information for the column footer.  
    Public PropertyGets or sets the spanned cells for the column footer.  
    Public PropertyGets or sets the cell types and other style settings for cells in the column footer.  
    Public PropertyGets or sets whether the column footers are visible.  
    Public PropertyGets the column headers for the sheet.  
    Public PropertyGets or sets which column header row displays the filtering indicator when there are multiple column header rows.  
    Public PropertyGets or sets whether column headers display letters or numbers or are blank.  
    Public PropertyGets or sets which column header row displays the automatic text when there are multiple column header rows.  
    Public PropertyGets or sets the data for the column header.  
    Public PropertyGets or sets the column header height.  
    Public PropertyGets or sets the row information for the column header.  
    Public PropertyGets or sets the spanned cells for the column header.  
    Public PropertyGets or sets the cell types and other style settings for cells in the column header.  
    Public PropertyGets or sets whether the column headers are visible.  
    Public PropertyGets the columns in the data area of the sheet.  
    Public PropertyGets or sets the conditional formatting model.  
    Public PropertyGets or sets the context menu style.  
    Public PropertyGets or sets the current page.  
    Public PropertyGets or sets whether a bound sheet automatically sets the cell type for the cells in a column.  
    Public PropertyGets or sets the data key for this sheet.  
    Public PropertyGets or sets an array of strings that contains the names of the key fields for the data source for this sheet.  
    Public PropertyGets or sets the data member for this sheet.  
    Public PropertyGets or sets the data for the sheet.  
    Public PropertyGets or sets the data source for this sheet.  
    Public PropertyGets or sets the unique identifier of the data source for this sheet.  
    Public PropertyGets or sets the default column width in pixels for all columns in the sheet.  
    Public PropertyGets or sets the default row height in pixels for all rows in the sheet.  
    Public PropertyGets or sets the default style information for the cells in this sheet.  
    Public PropertyGets or sets the name of the default style for the cells in this sheet.  
    Public PropertyGets or sets the name of the method to call in order to delete data.  
    Public PropertyGets or sets the row with the cell that is being edited.  
    Public PropertyThe number of columns in the editing form.  
    Public PropertyGets or sets whether to enable the row edit template.  
    Public PropertyGets or sets whether the rows are expandable.  
    Public PropertyGets or sets FilterBarInfo for filterBar  
    Public PropertyGets the active FpSpread from the SheetView.  
    Public PropertyGets or sets the number of frozen (non-scrollable) columns for this sheet.  
    Public PropertyGets or sets the number of frozen (non-scrollable) rows for this sheet.  
    Public PropertyGets or sets which ImageUrl of the cursor is displayed when the mouse is on the gray area of the sheet.  
    Public PropertyGets or sets which type of cursor is displayed when the mouse is on the gray area of the sheet.  
    Public PropertyGets or sets the color of the grid lines in the sheet.  
    Public PropertyGets or sets whether to display grid lines in the sheet.  
    Public PropertyGets or sets the grouping bar background color.  
    Public PropertyGets or sets the grouping bar height.  
    Public PropertyGets or sets the group bar text.  
    Public PropertyGets or sets whether the grouping bar is visible.  
    Public PropertyGets or sets the collection of group footer information objects.  
    Public PropertyGets or sets whether the footer of the grouping bar is visible.  
    Public PropertyGets or sets the collection of group information objects.  
    Public PropertyGets or sets grouping policy to collapse or expand rows when grouping occurs.  
    Public PropertyGets or sets the maximum grouping level.  
    Public PropertyGets or sets the background image of the header area that does not contain column header or row header cells.  
    Public PropertyGets or sets the color of the header area that does not contain column header or row header cells.  
    Public PropertyGets or sets if the hidden rows are ignored when paging.  
    Public PropertyGet the image collection  
    Public PropertyGets or sets the name of the method to call in order to insert data.  
    Public PropertyGets or sets whether the control tracks the current sheet view state.  
    Public PropertyGets or sets the name of the data item type in model binding.  
    Public PropertyGets or sets whether circular references in the sheet are evaluated.  
    Public PropertyGets or sets the type of layout mode.  
    Public PropertyGets or sets the number of rows to load initially to the client.  
    Public PropertyGets or sets the row index (from bottom to top) in the view from where spread loads the next set of rows after scrolling to this position.  
    Public PropertyGets or sets a period of time (in milliseconds) when spread loads the next set of rows.  
    Public PropertyGets or sets the LoadOnDemandMode property. In Standard mode, spread loads the next set of rows, if after scrolling, there are no bottom rows (in the view) that are hidden. In Background mode, spread loads the next set of rows after a period of time or after the user scrolls to the row at the LoadOffsetFromBottom position.  
    Public PropertyGets or sets the LoadOnDemandTriggerMode property. If trigger mode is Timed, spread loads the next set of rows after a period of time until there are no rows to load. If trigger mode is OffsetBased, spread only loads the next set of rows if the user scrolls to the row at the LoadOffsetFromBottom position.  
    Public PropertyGets or sets the number of rows to include in incremental loads on demand.  
    Public PropertyGets or sets the background color of locked cells on this sheet.  
    Public PropertyGets or sets the foreground color of locked cells on this sheet.  
    Public PropertyGets or sets the maximum amount of change below which iterations stop when circular references are evaluated for the sheet.  
    Public PropertyGets or sets the formula recalculation iteration count for the sheet.  
    Public PropertyGets or sets the style for the message row.  
    Public PropertyGets or sets a collection of styles.  
    Public PropertyGets a value that is one more than the index of the last column on this sheet that contains data.  
    Public PropertyGets a value that is one more than the index of the last row on this sheet that contains data.  
    Public PropertyGets or sets the operation mode of the sheet.  
    Public PropertyGets or sets whether to show the maximum number of rows on the last page.  
    Public PropertyGets or sets the number of rows to display at a time.  
    Public PropertyGets the reference to the parent sheet (SheetView object).  
    Public PropertyGets the index of the parent row in a hierarchical display.  
    Public PropertyGets or sets the index of the preview row column.  
    Public PropertyGets or sets the style information for the preview row.  
    Public PropertyGets or sets the preview row template.  
    Public PropertyGets or sets whether to display the preview row.  
    Public PropertyGets or sets a PrintInfo object that determines printing behavior for the sheet.  
    Public PropertyGets or sets whether users can edit cells marked as locked.  
    Public PropertyGets or sets the cell reference style.  
    Public PropertyGets the name of the data relation in a hierarchical display.  
    Public PropertyGets or sets whether the FarPoint Spread always displays the editor if the editor is defined for a cell.  
    Public PropertyGets or sets the row information for the sheet.  
    Public PropertyGets or sets the number of rows in the sheet.  
    Public PropertyGets or sets the row edit template.  
    Public PropertyGets or sets the row filter for the sheet.  
    Public PropertyGets the row headers for the sheet.  
    Public PropertyGets or sets whether row headers display letters or numbers or are blank.  
    Public PropertyGets or sets which row header column displays the automatic text when there are multiple row header columns.  
    Public PropertyGets or sets the column information for the row header.  
    Public PropertyGets or sets the data for the row header.  
    Public PropertyGets or sets the spanned cells for the row header.  
    Public PropertyGets or sets the cell types and other style settings for cells in the row header.  
    Public PropertyGets or sets whether the row headers are visible.  
    Public PropertyGets or sets the row header column width.  
    Public PropertyGets the rows in the data area of the sheet.  
    Public PropertyGets or sets the scrolling content tip columns.  
    Public PropertyGets or sets the hidden delay of the scrolling content tip in milliseconds.  
    Public PropertyGets or sets the maximum height in pixels for the scrolling content tip.  
    Public PropertyGets or sets a value that indicates whether to display the scrolling content tip.  
    Public PropertyGets or sets the background color for selected cells.  
    Public PropertyGets or sets the backcolor style for the display of selected cells.  
    Public PropertyGets or sets the settings for the selection border.  
    Public PropertyGets or sets the text color for selected cells.  
    Public PropertyGets or sets the selections for the sheet.  
    Public PropertyGets or sets the selection policy.  
    Public PropertyGets or sets the name of the method to call in order to read data.  
    Public PropertyGets the sheet corner for the sheet.  
    Public PropertyGets or sets the column information for the sheet corner.  
    Public PropertyGets or sets the data for the sheet corner.  
    Public PropertyGets or sets the row information for the sheet corner.  
    Public PropertyGets or sets the spanned cells for the sheet corner.  
    Public PropertyGets or sets the style information for the sheet corner.  
    Public PropertyGets or sets the cell types and other style settings for cells in the sheet corner.  
    Public PropertyGets or sets the name of the style for the sheet corner.  
    Public PropertyGets or sets the name of the sheet.  
    Public PropertyGets or sets whether the frozen indicator should be displayed.  
    Public PropertyGets the model index of the column last sorted.  
    Public PropertyGets or sets the spanned cells for the sheet.  
    Public PropertyGets or sets the sparkline container.  
    Public PropertyGets or sets the number displayed in the first column header.  
    Public PropertyGets or sets the number displayed in the first row header.  
    Public PropertyGets or sets the number of the first page to display in the page navigation aids.  
    Public PropertyGets or sets the cell types and other style settings for the sheet.  
    Public PropertyGets the title information of the sheet.  
    Public PropertyGets or sets the row to display as the top row in the sheet.  
    Public PropertyGets or sets the name of the method to call in order to update data.  
    Public PropertyGets or sets the custom format string to show in the text tip during virtual scroll paging. Default pattern is "Page {page} of {count}", where {page} will be replaced for page index and {count} will be replaced for page count.  
    Public PropertyIndicates the number of additional rows that are displayed from previous pages before the top of the current page. The default value is zero. This setting only has an effect when AllowVirtualScrollPaging is true.  
    Public PropertyGets or sets whether to display the sheet.  
    Public PropertyGets the worksheet template.  
    Top
    Public Methods
     NameDescription
    Public MethodOverloaded. Adds the chart control.  
    Public MethodAdds columns to the data model at the specified index.  
    Public MethodOverloaded.   
    Public MethodAdds rows to the data model.  
    Public MethodAdds the unbound row to the data source.  
    Public MethodAdds a span of cells to a sheet.  
    Public MethodOverloaded. Adds the sparkline.  
    Public MethodAdds the sparkline.  
    Public MethodAdds unbound rows to the data model.  
    Public MethodAutomatically filters the rows in the specified column according to the specified filter.  
    Public MethodResets the filters on the rows in the specified column.  
    Public MethodOverloaded. Removes all of the conditional formatting from the cell at the specified row and column.  
    Public MethodRemoves all of the conditional formatting from the sheet.  
    Public MethodRemoves all of the data, formatting, formulas, and notes from a range of cells on this sheet.  
    Public MethodClears the row filter for this sheet.  
    Public MethodClears all sparkline groups.  
    Public MethodClears all sparklines.  
    Public MethodExpands or collapses all the levels of hierarchy  
    Public MethodExpands or collapses the specified row in the hierarchical display.  
    Public MethodGets the child view in a hierarchical display with the specified row and data relation index.  
    Public MethodGets a cell with a specific tag on the sheet.  
    Public MethodGets the cell type for a cell at the specified row and column.  
    Public MethodGets the name of the child data relation in a hierarchical display at the specified index.  
    Public MethodGets a child sheet in a hierarchical display for the specified row and the specified relation index.  
    Public MethodGets whether the child view is displayed in a hierarchical display.  
    Public MethodOverloaded. Gets a tab-delimited string that contains the formatted text in a specified range.  
    Public MethodGets a tab-delimited string that contains the unformatted text in a specified range.  
    Public MethodGets whether this column contains a column filter definition.  
    Public MethodGets the automatic text displayed in the specified column header.  
    Public MethodGets a column on this sheet with a specific tag.  
    Public MethodGets the text in the column header cell at the specified row and column.  
    Public MethodGets whether or how cells in a column on this sheet that have the same content are joined in a single cell across multiple rows.  
    Public MethodGets whether the user can resize a specified column.  
    Public MethodGets the sort indicator to display at the specified column.  
    Public MethodGets whether a column is displayed.  
    Public MethodGets the width of the specified column in pixels.  
    Public MethodOverloaded. Gets all the conditional formatting in the specified cell range.  
    Public MethodOverloaded. Gets the string value for a custom name on this sheet from the model.  
    Public MethodGets the identifier for the specified row if it is visible.  
    Public MethodGets the default editor used to edit the cell.  
    Public MethodGets the default renderer used to render the cell.  
    Public MethodGets the filter items to be displayed in the drop-down list for the specified column.  
    Public MethodGets the editor used to edit a cell at the specified row and column.  
    Public MethodGets the formula of the specified cell on this sheet.  
    Public MethodGets the formatter used to format a cell at the specified row and column.  
    Public MethodGets the formula in the cell at the specified row and column.  
    Public MethodGets the group footer information for the sheet.  
    Public MethodGets the group information for the sheet.  
    Public MethodGets the index in the model for the specified column.  
    Public MethodGets a row index in a model for a specified row in a sheet.  
    Public MethodGets the cell note for a cell at the specified row and column.  
    Public MethodGets the renderer used to render a cell at the specified row and column.  
    Public MethodGets the automatic text displayed in the specified row header.  
    Public MethodGets whether the row on this sheet is expandable in the hierarchical display.  
    Public MethodGets a row on this sheet with a specific tag.  
    Public MethodGets the height of the specified row.  
    Public MethodGets the text in the specified row header cell.  
    Public MethodGets whether or how cells in a row on this sheet that have the same content are joined into a single cell across multiple columns.  
    Public MethodGets whether the user can resize the specified row.  
    Public MethodGets whether a row is displayed.  
    Public MethodGets an ordered array of FarPoint.Web.Spread.Model.CellRange objects, from largest to smallest, containing the selected cells on the sheet with minimal overlap between the ranges.  
    Public MethodGets the span of cells at a specified cell.  
    Public MethodGets the sparkline information.  
    Public MethodGets the composite cell style information for a cell at the specified row and column.  
    Public MethodGets the application-defined tag value for the specified cell, column, row, or entire sheet.  
    Public MethodGets the formatted text in the cell using the IFormatter object for the cell.  
    Public MethodGets the unbound value for a cell at the specified row and column.  
    Public MethodGets the valid conditional format.  
    Public MethodGets unformatted data from a cell at the specified row and column.  
    Public MethodGets the sheet column index for a specified model column.  
    Public MethodGets a sheet row index for the specified model row.  
    Public MethodOverloaded. Groups the sparkline and sets the type of the new group.  
    Public MethodGets whether the column is bound to a data source column.  
    Public MethodGets whether the specified row is bound to a data source.  
    Public MethodGets whether the row is expanded in the hierarchical display.  
    Public MethodLoads formulas that are deserialized, but not parsed yet, to be used after all sheets have been created and deserialized.  
    Public MethodOverloaded. Loads a text file with the specified name into the sheet.  
    Public MethodLoads a saved view state for a sheet.  
    Public MethodMoves the column or columns to a specified location.  
    Public MethodMoves the row or rows to a specified location.  
    Public MethodOverloaded. Opens a sheet saved as XML from the specified file and loads it into the sheet.  
    Public MethodOverloaded. Opens an Excel file and loads the specified Excel sheet into this sheet.  
    Public MethodEvaluates all the formulas in the sheet that have changed since the last calculation cycle.  
    Public MethodEvaluates all the formulas in the sheet (including those that have not changed since the last calculation cycle).  
    Public MethodRemoves the columns at the specified index.  
    Public MethodRemoves the rows at the specified index.  
    Public MethodRemoves the span from a range of cells that contain a specified anchor cell.  
    Public MethodSets the sheet to its default values.  
    Public MethodResets all column indexes in the sheet to be the same as the column indexes in the corresponding data model.  
    Public MethodResets all row indexes in the sheet to be the same as the row indexes in the corresponding data model.  
    Public MethodOverloaded. Saves the contents of the sheet to XML in the specified file.  
    Public MethodOverloaded. Saves the sheet as HTML content to the stream  
    Public MethodOverloaded. Saves the sheet to a text file with the specified name.  
    Public MethodOverloaded. Saves the range of cells (and may include headers) to a text file as specified.  
    Public MethodSaves the current view state of the sheet.  
    Public MethodSets whether to display the child view in a hierarchical display.  
    Public MethodSets a tab-delimited string that contains the formatted text in a specified range.  
    Public MethodSets a tab-delimited string that contains the unformatted text in a specified range.  
    Public MethodSets the value for a specified cell in a column header.  
    Public MethodSets whether or how cells in a column on this sheet that have the same content are joined in a single cell across multiple rows.  
    Public MethodSets whether users can resize individual columns.  
    Public MethodSets the sort indicator to display at the specified column.  
    Public MethodSets whether a column is displayed.  
    Public MethodSets the width of the specified column in pixels.  
    Public MethodOverloaded. Sets conditional formatting for a specified cell on the sheet based on specified rules.  
    Public MethodSets a formula in a specified cell on this sheet.  
    Public MethodSets the formula for a specified cell.  
    Public MethodBinds the model column to the data source column.  
    Public MethodSets the cell note for a specified cell.  
    Public MethodSets whether the row on this sheet can be expanded to show the child view in the hierarchical display.  
    Public Method

    Sets the height of the specified row in pixels.

     
    Public MethodSets the value for a specified cell in the row header.  
    Public MethodSets whether or how cells in a row on this sheet that have the same content are joined into a single cell across multiple columns.  
    Public MethodSets whether users can resize individual rows.  
    Public MethodSets whether a row is displayed.  
    Public MethodSets the style for a cell, a column, a row, or an entire sheet.  
    Public MethodSets the application-defined tag value for the specified cell, column, row, or entire sheet.  
    Public MethodSets the formatted text in the cell using the IFormatter object for the cell.  
    Public MethodSets the value for a cell at the specified row and column.  
    Public MethodSorts a range of cells in the data model.  
    Public MethodOverloaded. Sorts all the columns in the sheet according to the specified parameters.  
    Public MethodOverloaded. Sorts all the rows in the sheet according to the specified parameters.  
    Public MethodReturns the name of the sheet.  
    Public MethodOverloaded. Ungroups the sparkline.  
    Top
    Protected Methods
     NameDescription
    Protected MethodCreates the column axis model.  
    Protected MethodCreates the data model.  
    Protected MethodCreates the row axis model.  
    Protected MethodCreates the selection model.  
    Protected MethodCreates the span model.  
    Protected MethodCreates the style model.  
    Protected MethodCalls GetPagingSupport of the DataModel, selects data to data source view.  
    Protected MethodGets a name for the child view in a hierarchical display based on the row index and the relation index.  
    Protected MethodProcesses the addition of the specified rows to the column footer in the data model.  
    Protected MethodProcesses the addition of the specified rows to the column header in the data model.  
    Protected MethodProcesses the addition of columns to the data model and updates the other models and internal variables of the fpSpread component.  
    Protected MethodProcesses the addition of columns to the row header of the sheet.  
    Protected MethodProcesses the addition of rows to the data model.  
    Protected MethodProcesses the change to the sheet data model and synchronizes the models.  
    Protected MethodProcesses the removal of rows from the column header.  
    Protected MethodProcesses the removal of rows from the column header.  
    Protected MethodProcesses the removal of the specified columns from the data model.  
    Protected MethodProcesses the removal of columns from the row header.  
    Protected MethodProcesses the removal of the specified rows from the data model.  
    Protected MethodDetermines whether the print information should be serialized.  
    Top
    See Also