Document Solutions for Excel, .NET Edition | Document Solutions
GrapeCity.Documents.Excel Namespace / IWorksheet Interface
Properties Methods Events

In This Topic
    IWorksheet Interface Members
    In This Topic

    The following tables list the members exposed by IWorksheet.

    Public Properties
     NameDescription
    PropertyActiveCell Gets the active cell.  
    PropertyActivePaneReturns the IPane object that represents the active pane of the worksheet.  
    PropertyAutoFilterReturns an IAutoFilter object if filtering is on. Returns nothing if filtering is off (read-only).  
    PropertyAutoFilterModeGets or sets whether the AutoFilter drop-down arrows are currently displayed on the sheet. This property is independent of the AutoFilterMode property (read or write).  
    PropertyAutoGenerateColumns Gets or sets whether to generate columns automatically while binding data.  
    PropertyBackgroundPicture Gets or sets the background graphic for a worksheet.  
    PropertyBackgroundPicturesReturns a GrapeCity.Documents.Excel.Drawing.IBackgroundPictures object that represents all the backgound pictures on the worksheet or chart sheet (read-only).  
    PropertyCellsReturns the IRange object that represents all the cells on the worksheet (not just the cells that are currently in use). This object is read-only.  
    PropertyCellType Gets or sets the cell type for current sheet.  
    PropertyColumnCount Gets or sets the column count of the worksheet when exported to JSON.  
    PropertyColumnsReturns the IRange object that represents all the columns on the specified worksheet (read-only).  
    PropertyCommentsReturns the IComments collection that represents all the comments for the specified worksheet (read-only).  
    PropertyCommentsThreadedReturns the ICommentsThreaded collection that represents all the threaded comments for the specified worksheet (read-only).  
    PropertyControls Gets the control collection of this worksheet.  
    PropertyDataSource Gets or sets the data source of data binding for current sheet.  
    PropertyFilterMode Gets whether the worksheet is in filter mode (read-only).  
    PropertyFixedPageBreaks Gets or sets whether the horizontal and vertical page breaks are fixed when inserting/deleting rows/columns.  
    PropertyFreezeColumn Gets the frozen column.  
    PropertyFreezeRow Gets the frozen row.  
    PropertyFreezeTrailingColumn Gets the number of trailing frozen columns of the sheet.  
    PropertyFreezeTrailingRow Gets the number of trailing frozen rows of the sheet.  
    PropertyFrozenLineColor Gets or sets the color of frozen line.  
    PropertyHPageBreaks Get the collection of horizontal page breaks within the print area.  
    PropertyHyperlinks Provides access to the collection of Hyperlinks contained in the worksheet.  
    PropertyIndex Gets or sets the index number of the object within the collection of similar objects.  
    PropertyName Gets or sets the name of the object (read or write).  
    PropertyNamesReturns the INames collection that represents all the worksheet-specific names (names defined with the "WorksheetName!" prefix). This is a read-only Names object.  
    PropertyOutlineReturns an IOutline object that represents the outline for the specified worksheet (read-only).  
    PropertyOutlineColumn Gets the outline column for the worksheet.  
    PropertyPageSetup Returns a PageSetup object that contains all the page setup settings for the specified object.  
    PropertyPanes Worksheet panes.  
    PropertyPivotTablesReturns an object that represents either a single PivotTable report (a IPivotTables object) or a collection of all the PivotTable reports (IPivotTables object) on a worksheet (read-only).  
    PropertyProtection Gets or sets the protection status of the worksheet.  
    PropertyProtectionSettingsReturns the IProtectionSettings object that represents the protection options of the worksheet.  
    PropertyRangeReturns an instance of IRange which provides access to cell values, formulas, formatting and other cell properties and methods.  
    PropertyRowCount Gets or sets the row count of the worksheet when exported to JSON.  
    PropertyRowsReturns the IRange object that represents all the rows on the specified worksheet. This is read-only Range object.  
    PropertySelection Gets the selection range.  
    PropertyShapesReturns a GrapeCity.Documents.Excel.Drawing.IShapes object that represents all the shapes on the worksheet or chart sheet (read-only).  
    PropertySheetView Returns an object that represents the view settings of this worksheet(read-only).  
    PropertyShowColumnOutline Gets or sets whether to display the column outline. The default value is true, and this property only applies when interacting with SJS.  
    PropertyShowRowOutline Gets or sets whether to display the row outline. The default value is true, and this property only applies when interacting with SJS.  
    PropertySort Returns the sorted values in the current worksheet (read-only).  
    PropertySplitColumn Gets the split column.  
    PropertySplitRow Gets the split row.  
    PropertyStandardHeight Gets or sets the standard (default) height(in points) of all the rows in the worksheet (read-only).  
    PropertyStandardHeightInPixel Gets or sets the standard (default) height(in pixels) of all the rows in the worksheet (read-only).  
    PropertyStandardWidth Gets or sets the standard (default) width(in points) of all the columns in the worksheet (read or write).  
    PropertyStandardWidthInPixel Gets or sets the standard (default) width(in pixels) of all the columns in the worksheet (read or write).  
    PropertyTabColor Gets or sets the primary color of the tab.  
    PropertyTablesReturns a collection of ITable objects in the worksheet. This is a read-only ListObjects collection.  
    PropertyTag Gets or sets the tag for current sheet.  
    PropertyType Gets the sheet's type.  
    PropertyUsedRangeReturns the IRange object that represents the used range on the specified worksheet, its behavior is equivalent to GetUsedRange(UsedRangeType.Axis | UsedRangeType.Data | UsedRangeType.Comment | UsedRangeType.Style | UsedRangeType.Merge)  
    PropertyVisibleDetermines whether the object is visible (read or write Visibility).  
    PropertyVPageBreaks Get the collection of vertical page breaks within the print area.  
    PropertyWorkbook Returns the workbook.  
    Top
    Public Methods
     NameDescription
    MethodActivate Makes the current sheet the active sheet. This is equivalent to clicking the sheet's tab.  
    MethodCopy Copies the sheet to the end of the specified workbook.  
    MethodCopyAfter Copies the sheet to the location after the specified sheet.  
    MethodCopyBefore Copies the sheet to the location before the specified sheet.  
    MethodDelete Deletes the object.  
    MethodEvaluateOverloaded.  Converts a Microsoft Excel name to an object or a value.  
    MethodFreezePanes Freezes panes at the specified position.  
    MethodFreezeTrailingPanes Freezes trailing panes at the specified position.  
    MethodFromJsonOverloaded.  Generates a worksheet from the JSON string.  
    MethodGetUsedRange Gets the used range.  
    MethodMove Moves the sheet to the end of the specified workbook.  
    MethodMoveAfter Moves the sheet to the location after the specified sheet.  
    MethodMoveBefore Moves the sheet to the location before the specified sheet.  
    MethodPrintOut Prints the worksheet.  
    MethodProtect Protects a worksheet so that it cannot be modified.  
    MethodSaveOverloaded.  Saves current worksheet to file.  
    MethodSelect Selects the object.  
    MethodShowAllData Makes all rows of the currently filtered list visible. If AutoFilter is in use, this method changes the arrows to "All."  
    MethodSplitPanes Splits panes at the specified position.  
    MethodToImageOverloaded.  Saves the worksheet to the specified image file.  
    MethodToJsonOverloaded.  Generates a JSON string from the worksheet.  
    MethodUnfreezePanes Unfreezes panes.  
    MethodUnfreezeTrailingPanes Unfreezes trailing panes.  
    MethodUnprotect Removes protection from the worksheet.  
    MethodUnsplitPanes Unsplits panes.  
    Top
    Public Events
     NameDescription
    EventActivated Occurs when the worksheet is activated.  
    EventBeforeDelete Occurs before the worksheet is deleted.  
    EventChanged Occurs when something changes in the cells.  
    EventDeactivated Occurs when the worksheet is deactivated.  
    EventSelectionChange Occurs when the selection changes on a worksheet.  
    Top
    See Also

    Reference

    IWorksheet Interface
    GrapeCity.Documents.Excel Namespace