Spread Windows Forms 17
GrapeCity.Spreadsheet Assembly / GrapeCity.Spreadsheet Namespace / Worksheet Class
Properties Methods


In This Topic
    Worksheet Class Members
    In This Topic

    The following tables list the members exposed by Worksheet.

    Public Properties
     NameDescription
    Public PropertyActiveCellGets an IRange object that represents the active cell.  
    Public PropertyAutoFilterGets the filter of this Worksheet.  
    Public PropertyAutoFilterModeGets a value that indicates whether the AutoFilter drop-down arrows are currently displayed on the sheet.  
    Public PropertyBackgroundImageGets the background image of this worksheet.  
    Public PropertyBehaviorsGets or sets the behaviors of operations.  
    Public PropertyCellsGets an IRange instance which represents the entire worksheet cells.  
    Public PropertyCircularReferenceGets an IRange object that that represents the range containing the first circular reference on the sheet.  
    Public PropertyColumnCountOverridden. Gets or sets the number of columns in this Worksheet.  
    Public PropertyColumnFooterGets the column footer of a worksheet.  
    Public PropertyColumnHeaderGets the column header of a worksheet.  
    Public PropertyColumnsGet an IRange object that represents all the columns on the worksheet.  
    Public PropertyComments  
    Public PropertyCommentsThreadedGets an ICommentsThreaded collection that represents all the top-level/root comments (no replies) for the specified worksheet. Includes legacy and modern comments.  
    Public PropertyDataManagerGets or sets the data source of this worksheet.  
    Public PropertyDataValidationsGets the GrapeCity.SpreadsheetValidations object which manages all data validations in this Worksheet.  
    Public PropertyDrawingGets the GrapeCity.Spreadsheet.Drawing.WorksheetDrawing object contains all drawing objects within the worksheet.  
    Public PropertyEnableCalculationGets or sets a value indicating whether calculation engine automatically recalculates the worksheet when necessary. (Inherited from GrapeCity.Spreadsheet.WorksheetBase)
    Public PropertyEnableSelectionGets or sets what can be selected on the sheet.  
    Public PropertyFormatConditionsGets the conditional formatting manager.  
    Public PropertyFrozenTrailingRowCountGets the number of non-scrolling rows on the trailing edge of this sheet.  
    Public PropertyIndexGets the index number of the worksheet within the collection of worksheets.  
    Public PropertyLayoutManagerGets the layout manager of this worksheet.  
    Public PropertyLocksGets the protected data of this worksheet.  
    Public PropertyNameOverridden. Gets or sets the name of worksheet.  
    Public PropertyNamesGets a Names collection that represents all the worksheet-specific names (names defined with the "WorksheetName!" prefix).  
    Public PropertyNextGets a Worksheet that represents the next sheet.  
    Public PropertyOptionsGets the WorksheetOptions object that represents all options of the IWorksheet.  
    Public PropertyOwnerGets the owner worksheet.  
    Public PropertyPageSetupGets the page setup of the worksheet.  
    Public PropertyPreviousGets a Worksheet that represents the previous sheet.  
    Public PropertyProtectionGets an IProtection object that represents the protection options of the worksheet.  
    Public PropertyProtectionModeGets a ProtectionMode value indicating whether this worksheet is protected.  
    Public PropertyRowCountOverridden. Gets or sets the number of rows in this Worksheet.  
    Public PropertyRowHeaderGets the row header of a worksheet.  
    Public PropertyRowsGet an IRange object that represents all the rows on the worksheet.  
    Public PropertySelectionGets the current selected cell(s).  
    Public PropertySortGets the sort object.  
    Public PropertySparklinesGets the sparkline storage of this worksheet.  
    Public PropertySubTypeGets the worksheet sub-type.  
    Public PropertyTabColorGets or sets the color of the tab.  
    Public PropertyTablesGets the Tables object which manages all tables in this Worksheet.  
    Public PropertyTagGets or sets the object that contains data about the worksheet.  
    Public PropertyViewGets the worksheet view of this Worksheet object.  
    Public PropertyVisibleGets or sets a SheetVisibility value that determines whether the worksheet is visible.  
    Public PropertyWorkbookGets the Workbook object contains current Worksheet object.  
    Public PropertyWorkbookSetGets the WorkbookSet object contains current Worksheet object.  
    Top
    Public Methods
     NameDescription
    Public MethodActivateMakes the current sheet the active sheet.  
    Public MethodAggregateOverloaded. Get the aggregate value of the specified cell range.  
    Public MethodApplyStyleExtendAllow other products use modifier to modify the extended data of style in worksheet's range.  
    Public MethodApplyStyleFormatterAllow other products use modifier to modify the extended data of style in worksheet's range.  
    Public MethodCalculateOverloaded. Calculates this worksheet.  
    Public MethodClearRemoves all the data and formulas from the specified range of cells.  
    Public MethodClearShapesRemoves all shapes from the specified range of cells.  
    Public MethodContainsArrayFormulaGets a bool indicate if the reference contains ArrayFormulaExpression.  
    Public MethodContainsHiddenNoteGet a value indicate current worksheet contain at least one note is being hidden.  
    Public MethodContainsLockedCellOverloaded. Determines whether the specified range contains at least one locked cell.  
    Public MethodCopyCopies the data from a range of cells to a specified range of cells.  
    Public MethodCreateAutoFilterCreates the automatic filter.  
    Public MethodCreateExpressionViewCreates the expression view which binds the specified formula to a cell range.  
    Public MethodDeleteDeletes this Worksheet from its owner Workbook.  
    Public MethodDuplicateNameGenereates a new worksheet name from the naem of this worksheet.  
    Public MethodEnsureCalculatedEnsure that all data in specify range is calculated (Inherited from GrapeCity.Spreadsheet.WorksheetBase)
    Public MethodEvaluateEvaluates the specified expression again a context cell.  
    Public MethodFindBackupRangeFinds the suitable range to backup that the original worksheet can be restored correctly later (used by Clipboard Cut for example)  
    Public MethodGetAppliedRangeRefines the selection which is used to execute an UI command.  
    Public MethodGetCommentStorageGet Comment Storage  
    Public MethodGetDynamicArrayRangeGets the dynamic array cell range.  
    Public MethodGetExpressionGets the formula, as an expression value, for the cell of the specified row and column of this sheet. (Inherited from GrapeCity.Spreadsheet.WorksheetBase)
    Public MethodGetExpression2Gets the formula, as an expression value, for the cell of the specified row and column of this sheet.  
    Public MethodGetFormattedValueGets the formatted value from the specified cell on this sheet.  
    Public MethodGetFormulaGets the formula for the cell of the specified row and column of this sheet.  
    Public MethodGetHashCodeReturns a hash code for this instance. (Inherited from GrapeCity.Spreadsheet.WorksheetBase)
    Public MethodGetHyperlinkOverloaded. Gets the hyperlink of the specified cell.  
    Public MethodGetNonEmptyAreaGets the minimum cell range which contains all non-empty data of the worksheet.  
    Public MethodGetNumberFormatOverloaded. Gets the number format from the specified cell on this sheet.  
    Public MethodGetPreferredPrintAreaGets the preferred print area.  
    Public MethodGetRichValueOverloaded. Gets the richvalue in the table data range  
    Public MethodGetStyleFormatGets the style format of the specified cell on this worksheet.  
    Public MethodGetTextOverloaded. Gets the displayed text of the specified value base on the target cell in this sheet.  
    Public MethodGetTextToColumnsCountDetermines the how many columns can be extracted from source range data.  
    Public MethodGetUnspilledValueGets raw data from the specified cell on this sheet. The spilled value will be skipped. (Inherited from GrapeCity.Spreadsheet.WorksheetBase)
    Public MethodGetValueOverloaded. Overridden. Gets the value at the specified location of the 2-dimensions matrix.  
    Public MethodHasHeadersDetermines whether the specified row has headers.  
    Public MethodInsertColumnsInserts column(s) to the Worksheet at the specified position.  
    Public MethodInsertRowsInserts row(s) to the Worksheet at the specified position.  
    Public MethodIsBindingDataGets a boolean value indicating whether the worksheet is bind to a data source. (Inherited from GrapeCity.Spreadsheet.WorksheetBase)
    Public MethodIsCommentStorageAvailableGets a boolean value indicating whether there is a cell comment in this worksheet.  
    Public MethodIsDrawingObjectAvailableIndicates whether there is drawing object in this worksheet.  
    Public MethodIsEmptyOverloaded. Gets a boolean value indicating whether the cell contains empty data.  
    Public MethodIsHyperlinkAvailableCheck if there is a hyperlink from the specified range.  
    Public MethodIsSortAvailableGets a boolean value indicating whether worksheet has sort object.  
    Public MethodIsSparklineAvailableGets a value indicating whether there is sparkline in the worksheet.  
    Public MethodIsSpilledCellGets a value indicating whether the cell is spilled.  
    Public MethodIsValidDetermines whether the specified range is valid.  
    Public MethodMoveOverloaded. Moves the data from a range of cells to the specified location.  
    Public MethodNextNonEmptyCellGets the nearest next column which contains data in the specified row.  
    Public MethodNextNonEmptyColumnInRowFind the next non-empty data column in a row.  
    Public MethodNextNonEmptyRowInColumnFind the next non- empty row data in a column (Inherited from GrapeCity.Spreadsheet.WorksheetBase)
    Public MethodNotifyDataChangedNotifies the data change.  
    Public MethodParseFormulaParses the specified formula to expression.  
    Public MethodPreviousNonEmptyCellGets the nearest previous column which contains data in the specified row.  
    Public MethodPreviousNonEmptyColumnInRowFind the previous non-empty data column in a row  
    Public MethodPreviousNonEmptyRowInColumnFind the previous non-empty data row in a column (Inherited from GrapeCity.Spreadsheet.WorksheetBase)
    Public MethodProtectProtects a worksheet so that it cannot be modified.  
    Public MethodRangeOverloaded. Get an IRange object that represents a cell or a range of cells.  
    Public MethodRefineAccessibleRangeReference(Reference)Refines the range references to remove whole row / column. All references are assumed as absolute. (Inherited from GrapeCity.Spreadsheet.WorksheetBase)
    Public MethodRemoveColumnsRemoves one or more columns starting with the column at the specified position.  
    Public MethodRemoveRowsRemoves one or more rows starting with the row at the specified position.  
    Public MethodRetargetStructuredReferenceExpressionInRangeRetarget all StructuredReferenceExpression in range  
    Public MethodSaveAsOverloaded. Saves this IWorksheet to the specified System.IO.Stream.  
    Public MethodSelectSelects the sheet.  
    Public MethodSelectNeighborNonEmptyCellsGet the cell range around the specified cell which contains data.  
    Public MethodSetAutoRowHeightSets the automatic size to a specific row.  
    Public MethodSetBackgroundPictureOverloaded. Sets the background graphic for a worksheet.  
    Public MethodSetColumnCountSets the number of columns in this Worksheet.  
    Public MethodSetExpressionSets the GrapeCity.CalcEngine.Expression value for the cell of the specified cell range.  
    Public MethodSetFormulaSets the formula text for the cell of the specified cell range.  
    Public MethodSetFormulaArraySets the formula text for the cell of the specified cell range.  
    Public MethodSetRowCountSets the number of rows in this Worksheet.  
    Public MethodSetStyleFormatOverloaded. Sets the style format for a specific cell on this worksheet.  
    Public MethodSetValueOverloaded. Sets an object array into a specified range of cells.  
    Public MethodSwapSwaps the specified ranges of cells.  
    Public MethodToStringReturns a string that represents the current object.  
    Public MethodUnparseFormulaParses the specified formula to expression.  
    Public MethodUnprotectUnprotects the worksheet which is protected by password.  
    Public MethodVisitHyperlinkMarks that the hyperlink is visited.  
    Top
    Protected Methods
     NameDescription
    Protected MethodAddChartObjectAdd empty chart object to current worksheet.  
    Protected MethodAfterVisibleChangedAfter worksheet visible changed.  
    Protected MethodChangeVisibleChange Visibility of worksheet.  
    Protected MethodExportExtensionData  
    Protected MethodGet3DReferenceIndexOverridden. Get the 3D-Reference index of this GrapeCity.CalcEngine.IReferenceSource object.  
    Protected MethodImportExtensionData  
    Protected MethodOnRowColumnChanged  
    Protected MethodPasteCorePastes the contents of the Clipboard onto the sheet.  
    Protected MethodProcessAutoRowHeightExtraSupport some extra logic for process auto row height.  
    Top
    See Also

    Reference

    Worksheet Class
    GrapeCity.Spreadsheet Namespace