Spread WPF 17
GrapeCity.Windows.SpreadSheet.Data Namespace / Worksheet Class
Properties Methods Events

In This Topic
    Worksheet Class Members
    In This Topic

    The following tables list the members exposed by Worksheet.

    Public Constructors
     NameDescription
    Public ConstructorWorksheet ConstructorOverloaded.   
    Top
    Public Properties
     NameDescription
    Public PropertyActiveCellGets the active cell in the sheet.  
    Public PropertyActiveColumnGets the active column in the sheet.  
    Public PropertyActiveColumnIndexGets or sets the column index of the active cell in the sheet.  
    Public PropertyActiveRowGets the active row in the sheet.  
    Public PropertyActiveRowIndexGets or sets the row index of the active cell in the sheet.  
    Public PropertyAutoGenerateColumnsGets or sets whether to automatically generate the columns for a sheet based on the data source.  
    Public PropertyCalcManager  
    Public PropertyCellsGets the two-dimensional collection of Cell objects.  
    Public PropertyChartsGets the charts.  
    Public PropertyColumnCountGets or sets the number of columns in the sheet.  
    Public PropertyColumnHeaderGets the column header area of the sheet.  
    Public PropertyColumnHeaderSpanModelGets the column header span model.  
    Public PropertyColumnRangeGroupGets the column range group.  
    Public PropertyColumnsGets the one-dimensional collection of Column objects.  
    Public PropertyConditionalFormatsGets the conditional format for the sheet.  
    Public PropertyCustomFunctionsGets the name of all custom functions.  
    Public PropertyCustomNamesGets all custom names.  
    Public PropertyDataAutoHeadingsGets or sets whether to automatically generate column names for a sheet based on the data source.  
    Public PropertyDataSourceGets or sets the data source that populates the sheet.  
    Public PropertyDefaultColumnWidthGets or sets the default column width.  
    Public PropertyDefaultRowHeightGets or sets the default row height.  
    Public PropertyDefaultStyleGets or sets default style information for the workbook.  
    Public PropertyFloatingObjectsGets the floating objects.  
    Public PropertyFrozenColumnCountGets or sets the number of nonscrolling columns on the leading edge of this sheet.  
    Public PropertyFrozenRowCountGets or sets the number of nonscrolling rows on the leading edge of this sheet.  
    Public PropertyFrozenTrailingColumnCountGets or sets the number of nonscrolling columns on the trailing edge of this sheet.  
    Public PropertyFrozenTrailingRowCountGets or sets the number of nonscrolling rows on the trailing edge of this sheet.  
    Public PropertyGridLineColorGets or sets the gridline color.  
    Public PropertyItemOverloaded. Gets a new cell with a specified tag, or returns null if there is no cell with the specified tag.  
    Public PropertyLastNonEmptyRowIndexGets the last nonempty bound row index on the sheet.  
    Public PropertyNameGets or sets the name of the sheet.  
    Public PropertyNamedStylesGets or sets a collection of StyleInfo objects for this sheet.  
    Public PropertyNonEmptyRowCountGets the number of rows in cell blocks that contain data, styles, tags, or sparklines.  
    Public PropertyPicturesGets the pictures.  
    Public PropertyPrintInfoGets or sets the print information for printing to PDF.  
    Public PropertyProtectGets or sets whether cells on this sheet that are marked as protected are uneditable.  
    Public PropertyReferenceStyleGets or sets the style for cell and range references in cell formulas on this sheet.  
    Public PropertyRowCountGets or sets the number of rows in the sheet.  
    Public PropertyRowFilterGets or sets the row filter for the sheet.  
    Public PropertyRowHeaderGets the row header area of the sheet.  
    Public PropertyRowHeaderSpanModelGets the row header span model.  
    Public PropertyRowRangeGroupGets the row range group.  
    Public PropertyRowsGets the one-dimensional collection of Row objects.  
    Public PropertySelectionBackgroundGets or sets a Brush object for the selection style.  
    Public PropertySelectionBorderColorGets or sets a Color object for the selection style.  
    Public PropertySelectionBorderThemeColorGets or sets a string object for the selection style.  
    Public PropertySelectionPolicyGets or sets whether users can select ranges of items.  
    Public PropertySelectionsReturns a collection of selected cell ranges.  
    Public PropertySelectionUnitGets or sets whether users can select cells, rows, or columns.  
    Public PropertySheetTabColorA color object used to represent the sheet tab color.  
    Public PropertySheetTabThemeColorA theme color used to represent the sheet tab color.  
    Public PropertyShowGridLineDetermines whether to show gridlines.  
    Public PropertySpanModelGets the sheet span model.  
    Public PropertyStartingColumnNumberGets or sets the number or letter displayed in the first column header in this sheet.  
    Public PropertyStartingRowNumberGets or sets the number or letter displayed in the first row header in this sheet.  
    Public PropertySurfaceChartsGets the surface charts.  
    Public PropertyTagGets or sets the tag.  
    Public PropertyTouchSelectionGripperBackgroundColorGets or sets a Color object for the selection style.  
    Public PropertyTouchSelectionGripperBackgroundThemeColorGets or sets a string object for the selection style.  
    Public PropertyVisibleGets or sets a value that indicates whether to display the sheet.  
    Public PropertyWorkbookGets the parent workbook for this sheet.  
    Public PropertyZoomFactorGets or sets the scaling factor for displaying this sheet.  
    Top
    Public Methods
     NameDescription
    Public MethodAddChartOverloaded. Adds the chart in the sheet.  
    Public MethodAddColumnsOverloaded. Adds the column or columns to the data model at the specified index.  
    Public MethodAddColumnViewportAdds the column viewport.  
    Public MethodAddCustomFunctionAdds the specified user-defined custom function to the collection.  
    Public MethodAddPictureOverloaded. Adds the picture.  
    Public MethodAddRowsOverloaded. Adds rows in this sheet.  
    Public MethodAddRowViewportAdds the row viewport.  
    Public MethodAddSelectionOverloaded. Adds a cell range to the selection.  
    Public MethodAddSpanCellOverloaded. Adds a span of cells in this sheet in the specified sheet area.  
    Public MethodAddSurfaceChartOverloaded. Adds the surface chart.  
    Public MethodAddTableOverloaded. Adds a range table with a specified size to the sheet.  
    Public MethodBindDataColumnBinds the column to the data source column for a sheet.  
    Public MethodClearOverloaded. Clears the specified area.  
    Public MethodClearCustomFunctionsRemoves all user-defined custom functions (FunctionInfo object) on this sheet.  
    Public MethodClearCustomNameClears the specified name in the name collection.  
    Public MethodClearCustomNamesRemoves all custom names on this sheet.  
    Public MethodClearSelectionOverloaded. Clears the specified selection range from the selection list, if one exists.  
    Public MethodClearSelectionsClears the selections.  
    Public MethodClearSpanCellsClears the span that contains a specified anchor cell from a range of cells in the specified sheet area.  
    Public MethodCopyToCopies data from one range to another.  
    Public MethodExtendSelectionSpecifies the last cell in the selection of cells.  
    Public MethodFillAutoOverloaded. Fills the specified range in the specified direction.  
    Public MethodFillDateOverloaded. Fills the specified range when the source value type is date.  
    Public MethodFillGrowthOverloaded. Fills the specified range growth trend when the source value type is number.  
    Public MethodFillLinearOverloaded. Fills the specified range linear trend when the source value type is number.  
    Public MethodFindChartFinds the chart with specified name.  
    Public MethodFindFloatingObjectFinds the floating object with specified name.  
    Public MethodFindFormulasGets formulas in the specified area.  
    Public MethodFindPictureFinds the picture with specified name.  
    Public MethodFindSurfaceChartFinds the surface chart with specified name.  
    Public MethodFindTableOverloaded. Gets the table of the specified cell.  
    Public MethodGetActiveColumnViewportIndexGets the index of the active column viewport.  
    Public MethodGetActiveRowViewportIndexGets the index of the active row viewport.  
    Public MethodGetActualColumnVisibleGets whether a column in the specified sheet area is displayed.  
    Public MethodGetActualColumnWidthOverloaded. Gets the width in pixels for the specified column in the specified sheet area.  
    Public MethodGetActualRowHeightOverloaded. Gets the height in pixels for the specified row in the specified sheet area.  
    Public MethodGetActualRowVisibleGets whether the control displays the specified row in the specified sheet area.  
    Public MethodGetActualStyleInfoOverloaded. Gets the actual style information for a specified cell in the specified sheet area.  
    Public MethodGetArrayOverloaded. Gets an object array from a specified range of cells.  
    Public MethodGetArrayFormulaGets the formula in the specified area in this sheet.  
    Public MethodGetColumnAutoTextGets the automatic text displayed in the column header for the specified column.  
    Public MethodGetColumnDataTypeGets the column data type at the specified position.  
    Public MethodGetColumnLabelOverloaded. Gets the text in the specified column header cell.  
    Public MethodGetColumnResizableOverloaded. Gets a value that indicates whether the user can resize a specified column in the specified sheet area.  
    Public MethodGetColumnViewportCountGets the column viewport count.  
    Public MethodGetColumnVisibleOverloaded. Gets whether a column in this sheet is displayed.  
    Public MethodGetColumnWidthOverloaded. Gets the width in pixels for the specified column in the specified sheet area.  
    Public MethodGetCsvOverloaded. Gets the CSV text from a range.  
    Public MethodGetCustomFunctionGets the specified user-defined custom function.  
    Public MethodGetCustomNameFinds the specified custom name.  
    Public MethodGetDataColumnNameGets the column name at the specified position.  
    Public MethodGetDrawingObjectGets the data bar object or icon object of the current sheet in the specified range.  
    Public MethodGetFillText  
    Public MethodGetFormulaGets the formula in the specified cell in this sheet.  
    Public MethodGetGridLineGets the control gridline; the gridline color is based on the ShowGridLine property.  
    Public MethodGetLastDirtyColumnGets the last dirty column index.  
    Public MethodGetLastDirtyRowGets the last dirty row index.  
    Public MethodGetNonEmptyColumnsReturns a list of nonempty column indexes.  
    Public MethodGetNonEmptyRowsReturns a list of nonempty row indexes.  
    Public MethodGetRowAutoTextGets the automatic text displayed in the row header for the specified row.  
    Public MethodGetRowHeightOverloaded. Gets the height using the specified unit type for the specified row in the specified sheet area.  
    Public MethodGetRowLabelOverloaded. Gets the text in the specified row header cell.  
    Public MethodGetRowResizableOverloaded. Gets a value that indicates whether users can resize the specified row in the specified sheet area.  
    Public MethodGetRowViewportCountGets the row viewport count.  
    Public MethodGetRowVisibleOverloaded. Gets whether the control displays the specified row.  
    Public MethodGetSpanCellOverloaded. Gets the range of cells that are spanned at a specified cell in this sheet.  
    Public MethodGetSparklineGets the sparkline for the specified cell.  
    Public MethodGetStyleInfoOverloaded. Gets the style information of the specified cell, row, or column.  
    Public MethodGetStyleNameOverloaded. Gets the name of the style assigned to a cell, column, row, or default model in the specified sheet area.  
    Public MethodGetTablesGets the sheet tables.  
    Public MethodGetTagOverloaded. Gets the application-defined tag value for the specified cell, column, row, or entire sheet in the specified sheet area.  
    Public MethodGetTextOverloaded. Gets the formatted text in the cell in the specified sheet area using the IFormatter object for the cell.  
    Public MethodGetValueOverloaded. Gets unformatted data from the specified cell.  
    Public MethodGetViewportHeightGets the height of the viewport.  
    Public MethodGetViewportInfoGets the viewport information of the current sheet.  
    Public MethodGetViewportLeftColumnGets the viewport left column.  
    Public MethodGetViewportTopRowGets the viewport top row.  
    Public MethodGetViewportWidthGets the width of the viewport.  
    Public MethodGroupSparklineGroups the sparklines.  
    Public MethodInvalidateFormulasInvalidates all formulas that are intersected with a specified range.  
    Public MethodIsAnyCellInColumnSelectedDetermines whether any cell in the specified column is in the selection.  
    Public MethodIsAnyCellInRowSelectedDetermines whether any cell in the specified row is in the selection.  
    Public MethodIsColumnBoundGets whether the specified column is bound to a data source.  
    Public MethodIsRowBoundGets whether the specified row is bound to a data source.  
    Public MethodIsSelectedDetermines whether the specified cell is in the selection.  
    Public MethodIsValidDetermines whether the specified cell value is valid.  
    Public MethodMoveTableOverloaded. Changes the table location.  
    Public MethodMoveToMoves data from one range to another.  
    Public MethodNextActualVisibleColumnGets the index of the next visible column from the current column.  
    Public MethodNextActualVisibleRowGets the index of the next visible row from the current row.  
    Public MethodNextNonEmptyColumnOverloaded. Returns the next nonempty column index for the specified column.  
    Public MethodNextNonEmptyRowOverloaded. Returns the next nonempty row index for the specified column.  
    Public MethodOpenCsvOverloaded. Loads the CSV (comma-separated values) file.  
    Public MethodOpenTextFileOverloaded. Loads the CSV file with the specified separator.  
    Public MethodOpenXmlOverloaded. Loads the XML stream to build a new worksheet.  
    Public Methodstatic (Shared in Visual Basic)ParseCsvParses the string to a two dimensional array.  
    Public MethodPreviousActualVisibleColumnGets the index of the previous visible column from the current column.  
    Public MethodPreviousActualVisibleRowGets the index of the previous visible row from the current row.  
    Public MethodRecalculateOverloaded. Evaluates all the cell formulas on the sheet that have changed since the last calculation cycle.  
    Public MethodReloadBindingDataReloads the binding data.  
    Public MethodRemoveChartRemoves the chart with specified name.  
    Public MethodRemoveColumnsOverloaded. Removes the column or columns on this sheet at the specified index.  
    Public MethodRemoveColumnViewportRemoves the column viewport.  
    Public MethodRemoveCustomFunctionsRemoves the specified user-defined custom function.  
    Public MethodRemoveFloatingObjectRemoves the floating object with the specified name.  
    Public MethodRemovePictureRemoves the picture with the specified name.  
    Public MethodRemoveRowsOverloaded. Removes the row or rows on this sheet at the specified index.  
    Public MethodRemoveRowViewportRemoves the row viewport.  
    Public MethodRemoveSpanCellOverloaded. Removes the span that contains a specified anchor cell from a range of cells in the specified sheet area.  
    Public MethodRemoveSparklineRemoves the sparkline of the specified cell.  
    Public MethodRemoveSurfaceChartRemoves the surface chart with the specified name.  
    Public MethodRemoveTableOverloaded. Removes a specified table.  
    Public MethodResetTouchSelectionGripperBackgroundColorResets the color of the touch selection gripper background.  
    Public MethodResetTouchSelectionGripperBackgroundThemeColorResets the theme color of the touch selection gripper background.  
    Public MethodResizeTableOverloaded. Changes the table size.  
    Public MethodResumeCalcServiceResumes the calculation service.  
    Public MethodResumeSpanModelEventResumes the SpanModel, RowHeaderSpanModel, and ColumnHeaderSpanModel events.  
    Public MethodSaveCsvOverloaded. Saves the CSV (comma-separated values) file.  
    Public MethodSaveHtmlOverloaded. Saves the data on the sheet to the HTML file.  
    Public MethodSavePdfOverloaded. Saves the sheet to the specified PDF file.  
    Public MethodSaveTextFileRangeOverloaded. Saves the range of cells in the sheet as delimited text and saves to a stream with the specified delimiters.  
    Public MethodSaveXmlOverloaded. Saves the worksheet to an XML stream.  
    Public MethodSearchOverloaded. Searches the text in the cells in the specified sheet for the specified string with the specified criteria and start and end location, and whether to search notes and tags as well.  
    Public MethodSetActiveCellOverloaded. Sets the active cell on this sheet.  
    Public MethodSetActiveViewportSets the active viewport.  
    Public MethodSetArrayOverloaded. Sets the values in the specified two-dimensional array of objects into the specified range of cells on this sheet.  
    Public MethodSetArrayFormulaSets an array formula in a specified cell area in the specified sheet area.  
    Public MethodSetBorderOverloaded. Sets the border for the specified area.  
    Public MethodSetColumnLabelSets the value for a specified cell in a column header on this sheet.  
    Public MethodSetColumnResizableOverloaded. Sets whether users can resize individual columns in the specified sheet area.  
    Public MethodSetColumnVisibleSets whether a column in the specified sheet area is displayed.  
    Public MethodSetColumnWidthSets the width using the specified unit type for the specified columns in this sheet.  
    Public MethodSetCsvOverloaded. Sets CSV text in the sheet.  
    Public MethodSetCustomNameOverloaded. Sets a custom name using the specified formula.  
    Public MethodSetDataSourceSets the data source that populates the sheet.  
    Public MethodSetExcelReadService  
    Public MethodSetFormulaOverloaded. Sets a formula in a specified cell in the specified sheet area.  
    Public MethodSetRowHeightSets the height using the specified unit type for the specified row in the specified sheet area.  
    Public MethodSetRowLabelSets the value for a specified cell in a row header on this sheet.  
    Public MethodSetRowResizableOverloaded. Sets whether users can resize the specified row in the specified sheet area.  
    Public MethodSetRowVisibleSets whether the control displays the specified row in the specified sheet area.  
    Public MethodSetSelectionOverloaded. Selects the specified cells.  
    Public MethodSetSparklineOverloaded. Sets the sparkline to a cell.  
    Public MethodSetStyleInfoOverloaded. Sets the style for the specified cell, row, or column.  
    Public MethodSetStyleNameOverloaded. Sets the style for the specified cell, column, row, or default model to the specified style name.  
    Public MethodSetTagOverloaded. Sets the application-defined tag value for the specified cell, column, row, or entire sheet for the specified sheet area.  
    Public MethodSetTextOverloaded. Sets the formatted text in the cell in the specified sheet area using the IFormatter object for the cell.  
    Public MethodSetValueOverloaded. Sets the value for the specified cell in the specified sheet area.  
    Public MethodSetViewportHeightSets the height of the viewport.  
    Public MethodSetViewportInfoSets the viewport information to the current sheet.  
    Public MethodSetViewportWidthSets the width of the viewport.  
    Public MethodSortRangeSorts a range of cells in this sheet in the data model.  
    Public MethodSuspendCalcServiceSuspends the calculation service.  
    Public MethodSuspendSpanModelEventSuspends the SpanModel, RowHeaderSpanModel, and ColumnHeaderSpanModel events.  
    Public MethodUngroupSparklineUngroups the sparklines in the group.  
    Top
    Public Events
     NameDescription
    Public EventCellChangedOccurs when a change is made to a cell or range of cells in this sheet that may require the cell or range of cells to be repainted.  
    Public EventChartChangedOccurs when the chart has changed.  
    Public EventChartSelectionChangedOccurs when the chart selection has changed.  
    Public EventColumnChangedOccurs when a change is made to a column or range of columns in this sheet that may require the column or range of columns to be repainted.  
    Public EventColumnsSwappedOccurs when two columns are swapped during sorting.  
    Public EventFloatingObjectChangedOccurs when the floating object has changed.  
    Public EventFloatingObjectSelectionChangedOccurs when the floating object selection has changed.  
    Public EventPictureChangedOccurs when the picture has changed.  
    Public EventPictureSelectionChangedOccurs when the picture selection has changed.  
    Public EventPropertyChangedOccurs when the user changes a sheet property.  
    Public EventRowChangedOccurs when a change is made to a row or range of rows in this sheet that may require the row or range of rows to be repainted.  
    Public EventRowsSwappedOccurs when two rows are swapped during sorting.  
    Public EventSelectionChangedOccurs when selections are changed that may require the selection area to be repainted.  
    Public EventSurfaceChartChangedOccurs when the chart has changed.  
    Public EventSurfaceChartSelectionChangedOccurs when the chart selection has changed.  
    Top
    See Also

    Reference

    Worksheet Class
    GrapeCity.Windows.SpreadSheet.Data Namespace