Document Solutions for Excel, Java Edition | Document Solutions
com.grapecity.documents.excel Package / IWorksheet Interface
Methods

In This Topic
    IWorksheet Interface Members
    In This Topic

    The following tables list the members exposed by IWorksheet.

    Public Methods
     NameDescription
     MethodMakes the current sheet the active sheet. This is equivalent to clicking the sheet's tab.  
     MethodOverloaded. Applies auto merge for a range. The auto merge direction is Column. The auto merge mode is Free. The auto merge selection mode is Source.  
     MethodOverloaded. Copies the sheet to the end of the current workbook.  
     MethodCopies the sheet to the location after the specified sheet.  
     MethodCopies the sheet to the location before the specified sheet.  
     MethodDeletes the object.  
     MethodOverloaded. Converts a Microsoft Excel name to an object or a value.  
     MethodFreezes panes at the specified position.  
     MethodFreezes trailing panes at the specified position.  
     MethodOverloaded. Generates a worksheet from the json string.  
     MethodOccurs when the worksheet is activated.  
     MethodGets the active cell.  
     MethodReturns the IPane object that represents the active pane of the worksheet.  
     MethodReturns an IAutoFilter object if filtering is on. Returns nothing iffiltering is off.  
     MethodGets whether the AutoFilter drop-down arrows are currently displayed on the sheet.  
     MethodGets whether to generate columns automatically while binding data.  
     MethodGets a list of IAutoMergeRangeInfo objects that represent all auto merge range information of the current worksheet.  
     MethodGets the background graphic for this worksheet.  
     MethodReturns a com.grapecity.documents.excel.drawing.IBackgroundPictures object that represents all the backgound pictures on theworksheet or chart sheet.  
     MethodOccurs before the worksheet is deleted.  
     MethodReturns the IRange object that represents all the cells on theworksheet (not just the cells that are currently in use).  
     MethodGets the cell type for sheet.  
     MethodOccurs when something changes in the cells.  
     MethodGets the column count of the worksheet.  
     MethodReturns the IRange object that represents all the columns on thespecified worksheet.  
     MethodReturns the IComments collection that represents all the comments forthe specified worksheet.  
     MethodReturns the ICommentsThreaded collection that represents all the threaded comments forthe specified worksheet.  
     MethodGets the control collection of this worksheet.  
     MethodGets the data source of data binding for current sheet.  
     MethodOccurs when the worksheet is deactivated.  
     MethodGets whether the worksheet is in filter mode.  
     MethodGets whether the horizontal and vertical page breaks are fixed when inserting/deleting rows/columns.  
     MethodGets the frozen column.  
     MethodGets the frozen row.  
     MethodGets the number of trailing frozen columns of the sheet.  
     MethodGets the number of trailing frozen rows of the sheet.  
     MethodGets the color of frozen line.  
     MethodGet the collection of horizontal page breaks within the print area.  
     MethodProvides access to the collection of Hyperlinks contained in the worksheet.  
     MethodGets the index number of the object within the collection of similar objects.  
     MethodGets the name of the object.  
     MethodReturns the INames collection that represents all theworksheet-specific names (names defined with the "WorksheetName!" prefix).  
     MethodReturns an IOutline object that represents the outline for thespecified worksheet.  
     MethodGets the outline column for the worksheet.  
     MethodReturns a IPageSetup object that contains all the page setup settingsfor the specified object.  
     MethodWorksheet panes.  
     MethodReturns an object that represents either a single PivotTable report a IPivotTables object or a collection of all the PivotTables report IPivotTables object on a worksheet.  
     MethodGets the protection status of the worksheet.  
     MethodReturns the IProtectionSettings object that represents the protectionoptions of the worksheet.  
     MethodOverloaded. Gets the IRange object with the specified reference.  
     MethodGets the row count of the worksheet.  
     MethodReturns the IRange object that represents all the rows on thespecified worksheet.  
     MethodGet the IScenarios object that represents the collection of What-If analysis scenarios in the worksheet.  
     MethodGets the selection range.  
     MethodOccurs when the selection changes on a worksheet.  
     MethodReturns a com.grapecity.documents.excel.drawing.IShapes object that represents all the shapes on theworksheet or chart sheet.  
     MethodReturns an object that represents the view settings of this worksheet.  
     MethodGets whether to display the column outline. The default value is true, and this property only applies when interacting with SJS.  
     MethodGets whether to display the row outline. The default value is true, and this property only applies when interacting with SJS.  
     MethodReturns the sorted values in the current worksheet.  
     MethodGets the split column.  
     MethodGets the split row.  
     MethodGets the standard (default) height(in points) of all the rows in the worksheet in points.  
     MethodGets the standard (default) height(in pixels) of all the rows in the worksheet in points.  
     MethodGets the standard (default) width(in points) of all the columns in the worksheet.  
     MethodGets the standard (default) width(in pixels) of all the columns in the worksheet.  
     MethodGets the primary color of the tab.  
     MethodReturns a collection of ITable objects in the worksheet.  
     MethodGets the tag of sheet.  
     MethodGets the sheet's type.  
     MethodOverloaded. Gets the used range, its behavior is equivalent to getUsedRange(EnumSet.of(UsedRangeType.Axis, UsedRangeType.Data, UsedRangeType.Comment, UsedRangeType.Style, UsedRangeType.Merge))  
     MethodGets whether the object is visible.  
     MethodGet the collection of vertical page breaks within the print area.  
     MethodReturns the workbook.  
     MethodOverloaded. Moves the sheet to the end of the current workbook.  
     MethodMoves the sheet to the location after the specified sheet.  
     MethodMoves the sheet to the location before the specified sheet.  
     MethodOverloaded. Protects a worksheet so that it cannot be modified.  
     MethodOverloaded. Saves current worksheet to the specified file.  
     MethodOverloaded. Selects the object.  
     MethodSets whether the AutoFilter drop-down arrows are currently displayed on the sheet.  
     MethodSets whether to generate columns automatically while binding data.  
     MethodSets the background graphic for this worksheet.  
     MethodSets the cell type for sheet.  
     MethodSets the column count of the worksheet.  
     MethodSets the data source of data binding for current sheet.  
     MethodSets whether the horizontal and vertical page breaks are fixed when inserting/deleting rows/columns.  
     MethodSets the color of frozen line.  
     MethodSets the index number of the object within the collection of similar objects.  
     MethodSets the name of the object.  
     MethodSets the protection status of the worksheet.  
     MethodSets the row count of the worksheet.  
     MethodSets whether to display the column outline. The default value is true, and this property only applies when interacting with SJS..  
     MethodSets whether to display the row outline. The default value is true, and this property only applies when interacting with SJS..  
     MethodSets the standard (default) height(in points) of all the rows in the worksheet in points.  
     MethodSets the standard (default) height(in pixels) of all the rows in the worksheet in points.  
     MethodSets the standard (default) width(in points) of all the columns in the worksheet.  
     MethodSets the standard (default) width(in pixels) of all the columns in the worksheet.  
     MethodSets the primary color of the tab.  
     MethodSets the tag for sheet.  
     MethodSets whether the object is visible.  
     MethodMakes all rows of the currently filtered list visible. If AutoFilter is in use, this method changes the arrows to "All."  
     MethodSplits panes at the specified position.  
     MethodOverloaded. Saves the sheet to the specified image file.  
     MethodOverloaded. Generates a json string from the worksheet.  
     MethodUnfreezes panes.  
     MethodUnfreezes trailing panes.  
     MethodOverloaded. Removes protection from the worksheet.  
     MethodUnsplits panes.  
    Top
    See Also