GridWorksheet (Aspose.Cells for Java)

java.lang.Object
- com.aspose.gridweb.Control
- - com.aspose.gridweb.GridWorksheet

```
public class GridWorksheet
extends Control
```
Encapsulates the object that represents a single worksheet.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addAutoFilter(int row, int startColumn, int endColumn)` Sets the range to which the specified AutoFilter applies.
`void`	`addCustomFilter(int row, java.lang.String critira)` Add custom filter for the specified row.
`void`	`autoFitColumn(int columnIndex)` Autofits the column width.
`void`	`autoFitColumn(int columnIndex, int firstRow, int lastRow)` Autofits the column width.
`void`	`autoFitColumns()`
`void`	`autoFitRow(int rowIndex)` Autofits the row height.
`void`	`autoFitRow(int rowIndex, int firstColumn, int lastColumn)` Autofits the row height.
`void`	`autoFitRow(int startRow, int endRow, int startColumn, int endColumn)` Autofits row height in a rectangle range.
`void`	`autoFitRows()` Autofits all rows in this worksheet.
`void`	`autoFitRows(boolean onlyAuto)` Autofits all rows in this worksheet.
`void`	`autoFitRows(int startRow, int endRow)` Autofits row height in a range.
`java.lang.Object`	`calculateFormula(java.lang.String formula)` Calculates a formula.
`void`	`clearComments()` Clears all comments in designer spreadsheet.
`void`	`copy(GridWorksheet sourceSheet)` Copies contents and formats from another worksheet.
`void`	`createSubtotal(int columnNameRowIndex, int dataRows, int groupByColumnIndex, int subtotalFunction, int[] subtotalColumnIndexList)` Creates subtotal in the sheet.
`void`	`createSubtotal(int columnNameRowIndex, int dataRows, int groupByColumnIndex, int subtotalFunction, int[] subtotalColumnIndexList, java.lang.String functionLabel, GridTableItemStyle grandCellStyle, GridTableItemStyle subtotalCellStyle, int numberType, java.lang.String customString)` Creates subtotal in the sheet.
`void`	`filterString(int column, java.lang.String criteria)` Sets the filter for the column.notice we shall call AddAutoFilter before calling of filterString The filter criteria string.
`void`	`freezePanes(int row, int column, int freezedRows, int freezedColumns)` Freezes panes at the specified cell in the worksheet.
`void`	`freezePanes(java.lang.String cellName, int freezedRows, int freezedColumns)` Freezes panes at the specified cell in the worksheet.
`java.lang.String`	`getActiveCell()` Gets the active cell in the worksheet.
`byte[]`	`getBackgroundImage()` Gets worksheet background image.
`GridCells`	`getCells()` Gets the `GridCell` collection.
`java.lang.String`	`getCodeName()` Represents worksheet code name.
`java.lang.String`	`getColumnCaption(int column)` Gets the column caption.
`java.lang.String`	`getColumnHeaderToolTip(int colIndex)` Gets the columnheader's tooltip text.
`boolean`	`getColumnReadonly(int columnIndex)` Gets if a column is readonly.
`GridCommentCollection`	`getComments()` Gets the `GridComment` collection.
`boolean`	`getDisplayRightToLeft()` Indicates if the specified worksheet is displayed from right to left instead of from left to right.
`boolean`	`getDisplayZeros()` True if zero values are displayed.
`int`	`getFirstVisibleColumn()` Represents first visible column index.
`int`	`getFirstVisibleRow()` Represents first visible row index.
`int[]`	`getFreezedPanes()` Gets the freeze panes.
`GridCell`	`getGridActiveCell()` Gets the active cell in the worksheet.
`GridHyperlinkCollection`	`getHyperlinks()` Gets the `GridHyperlinkCollection` collection.
`int`	`getIndex()` Gets the index of sheet in the worksheet collection.
`boolean`	`getIsReadonly(int row, int col)` Gets whether the cell is readonly.this is an extended attribute of GridWeb ,it will not keep in actual excel file
`java.lang.String`	`getName()` Gets the name of the worksheet.
`boolean`	`getOutlineShown()` Indicates whether show outline.
`GridPictureCollection`	`getPictures()` Gets a `getPictures()` collection.
`GridPivotTableCollection`	`getPivotTables()` Gets the pivotTables in the worksheet.
`java.lang.String`	`getRowCaption(int row)` Gets the row caption.
`java.lang.String`	`getRowHeaderToolTip(int rowIndex)` Gets the rowheader's tooltip text.
`boolean`	`getRowReadonly(int rowIndex)` Gets if a row is readonly.
`boolean`	`getSelected()` Indicates whether this worksheet is selected when the workbook is opened.
`GridShapeCollection`	`getShapes()` Gets a `getPictures()` collection.
`double`	`getStandardHeight()` Gets the default row height in this worksheet,in unit of points.
`int`	`getStandardHeightPixels()` Gets the default row height in this worksheet,in unit of pixels.
`Color`	`getTabColor()` Represents worksheet tab color.
`GridValidationCollection`	`getValidations()` Gets the data validation setting collection in the worksheet.
`boolean`	`getVisible()` Indicates whether this sheet's name is shown in the sheet tabs of the control.
`GridWorkbook`	`getWorkbook()` Gets the `GridWorkbook` object of the worksheet collection.
`int`	`getZoom()` Represents the scaling factor in percentage.
`void`	`groupRows(int firstIndex, int lastIndex, boolean isHidden)` Groups rows.
`boolean`	`isGridlinesVisible()` Gets a value indicating whether the grid lines are visible.Default is true.
`boolean`	`isProtected()` Indicates if the worksheet is protected.
`boolean`	`isSummaryRowBelow()` Indicates if the summary row will be positioned below the detail rows in the outline.
`void`	`moveTo(int index)` Moves the sheet to another location in the spreadsheet.
`void`	`refreshFilter()` Refresh auto filters to hide or unhide the rows.
`void`	`removeAutoFilter()` Remove the auto filter of the worksheet.
`void`	`removeSubtotal()` Removes subtotal created by the CreateSubtotal method in the sheet.
`void`	`resetFilter(int fieldIndex)` The integer offset of the field on which you want to apply ,based on the first filter column (from the left of the list; the leftmost field is field 0).
`void`	`setActiveCell(java.lang.String value)` Sets the active cell in the worksheet.
`void`	`setAllCellsEditable()` Makes all cells editable.this is extended attribute
`void`	`setAllCellsReadonly()` Makes all cells readonly.this is extended attribute notice this attribute can not keep in actual cell,if you want to keep protect please use setProtect
`void`	`setBackgroundImage(byte[] value)` Sets worksheet background image.
`void`	`setColumnCaption(int column, java.lang.String caption)` Sets the caption for the column.please note this is an extension attribute and can not keep in excel file
`void`	`setColumnHeaderToolTip(int colIndex, java.lang.String toolTip)` Sets the columnheader's tooltip text.
`void`	`setColumnReadonly(int columnIndex, boolean isReadonly)` Sets a column to readonly so user can't delete it from client side.
`void`	`setDisplayRightToLeft(boolean value)` Indicates if the specified worksheet is displayed from right to left instead of from left to right.
`void`	`setDisplayZeros(boolean value)` True if zero values are displayed.
`void`	`setEditableRange(int startRow, int startColumn, int rows, int columns)` Makes a range of cells editable.
`void`	`setFirstVisibleColumn(int value)` Represents first visible column index.
`void`	`setFirstVisibleRow(int value)` Represents first visible row index.
`void`	`setGridActiveCell(GridCell value)` Sets the active cell in the worksheet.
`void`	`setGridlinesVisible(boolean value)` Sets a value indicating whether the grid lines are visible.Default is true.
`void`	`setIsReadonly(int row, int col, boolean value)` Sets whether the cell is readonly.this is an extended attribute of GridWeb ,it will not keep in actual excel file
`void`	`setName(java.lang.String value)` Sets the name of the worksheet.
`void`	`setOutlineShown(boolean value)` Indicates whether show outline.
`void`	`setProtect()` Protects worksheet.
`void`	`setReadonlyRange(int startRow, int startColumn, int rows, int columns)` Makes a range of cells readonly.
`void`	`setRowCaption(int row, java.lang.String caption)` Sets the caption for the row.
`void`	`setRowHeaderToolTip(int rowIndex, java.lang.String toolTip)` Sets the rowheader's tooltip text.
`void`	`setRowReadonly(int rowIndex, boolean isReadonly)` Sets a row to readonly so user can't delete it from client side.
`void`	`setSelected(boolean value)` Indicates whether this worksheet is selected when the workbook is opened.
`void`	`setStandardHeight(double value)` Sets the default row height in this worksheet,in unit of points.
`void`	`setStandardHeightPixels(int value)` Sets the default row height in this worksheet,in unit of pixels.
`void`	`setSummaryRowBelow(boolean value)` Indicates if the summary row will be positioned below the detail rows in the outline.
`void`	`setTabColor(Color value)` Represents worksheet tab color.
`void`	`setVisible(boolean value)` Indicates whether this sheet's name is shown in the sheet tabs of the control.
`void`	`setZoom(int value)` Represents the scaling factor in percentage.
`void`	`unFreezePanes()` Unfreezes panes in the worksheet.
`void`	`unGroupRows(int firstIndex, int lastIndex)` Ungroups rows.
`void`	`unProtect()` unProtects worksheet.

Methods inherited from class com.aspose.gridweb.Control
getUniqueID

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getName
```
public java.lang.String getName()
```
    Gets the name of the worksheet.
    Remarks
    The max length of sheet name is 31. And you cannot assign same name(case insensitive) to two worksheets. For example, you cannot set "SheetName1" to the first worksheet and set "SHEETNAME1" to the second worksheet.
  - setName
```
public void setName(java.lang.String value)
```
    Sets the name of the worksheet.
    Remarks
    The max length of sheet name is 31. And you cannot assign same name(case insensitive) to two worksheets. For example, you cannot set "SheetName1" to the first worksheet and set "SHEETNAME1" to the second worksheet.
  - copy
```
public void copy(GridWorksheet sourceSheet)
```
    Copies contents and formats from another worksheet.
    
    Parameters:
    sourceSheet - Source worksheet.
  - isProtected
```
public boolean isProtected()
```
    Indicates if the worksheet is protected.
  - getIndex
```
public int getIndex()
```
    Gets the index of sheet in the worksheet collection.
  - getWorkbook
```
public GridWorkbook getWorkbook()
```
    Gets the GridWorkbook object of the worksheet collection.
  - getComments
```
public GridCommentCollection getComments()
```
    Gets the GridComment collection.
  - getCells
```
public GridCells getCells()
```
    Gets the GridCell collection.
  - isGridlinesVisible
```
public boolean isGridlinesVisible()
```
    Gets a value indicating whether the grid lines are visible.Default is true.
  - setGridlinesVisible
```
public void setGridlinesVisible(boolean value)
```
    Sets a value indicating whether the grid lines are visible.Default is true.
  - unFreezePanes
```
public void unFreezePanes()
```
    Unfreezes panes in the worksheet.
  - getActiveCell
```
public java.lang.String getActiveCell()
```
    Gets the active cell in the worksheet.
  - setActiveCell
```
public void setActiveCell(java.lang.String value)
```
    Sets the active cell in the worksheet.
  - getDisplayZeros
```
public boolean getDisplayZeros()
```
    True if zero values are displayed.
  - setDisplayZeros
```
public void setDisplayZeros(boolean value)
```
    True if zero values are displayed.
  - getDisplayRightToLeft
```
public boolean getDisplayRightToLeft()
```
    Indicates if the specified worksheet is displayed from right to left instead of from left to right. Default is false.
  - setDisplayRightToLeft
```
public void setDisplayRightToLeft(boolean value)
```
    Indicates if the specified worksheet is displayed from right to left instead of from left to right. Default is false.
  - getOutlineShown
```
public boolean getOutlineShown()
```
    Indicates whether show outline.
  - setOutlineShown
```
public void setOutlineShown(boolean value)
```
    Indicates whether show outline.
  - getSelected
```
public boolean getSelected()
```
    Indicates whether this worksheet is selected when the workbook is opened.
  - setSelected
```
public void setSelected(boolean value)
```
    Indicates whether this worksheet is selected when the workbook is opened.
  - freezePanes
```
public void freezePanes(java.lang.String cellName,
               int freezedRows,
               int freezedColumns)
```
    Freezes panes at the specified cell in the worksheet.
    Remarks
    Row index and column index cannot all be zero. Number of rows and number of columns also cannot all be zero.
    
    Parameters:
    cellName - Cell name.
    freezedRows - Number of visible rows in top pane, no more than row index.
    freezedColumns - Number of visible columns in left pane, no more than column index.
  - freezePanes
```
public void freezePanes(int row,
               int column,
               int freezedRows,
               int freezedColumns)
```
    Freezes panes at the specified cell in the worksheet.
    Remarks
    Row index and column index cannot all be zero. Number of rows and number of columns also cannot all be zero.
    
    The first two parameters specify the freezed position and the last two parameters specify the area freezed on the left top pane.
    
    Parameters:
    row - Row index.
    column - Column index.
    freezedRows - Number of visible rows in top pane, no more than row index.
    freezedColumns - Number of visible columns in left pane, no more than column index.
  - getFreezedPanes
```
public int[] getFreezedPanes()
```
    Gets the freeze panes.
    
    Returns:
    Return null means the worksheet is not frozen 0:Row index;1:column;2:freezedRows;3:freezedRows
  - getPictures
```
public GridPictureCollection getPictures()
```
    Gets a getPictures() collection.
  - getShapes
```
public GridShapeCollection getShapes()
```
    Gets a getPictures() collection.
  - getHyperlinks
```
public GridHyperlinkCollection getHyperlinks()
```
    Gets the GridHyperlinkCollection collection.
  - getValidations
```
public GridValidationCollection getValidations()
```
    Gets the data validation setting collection in the worksheet.
  - addAutoFilter
```
public void addAutoFilter(int row,
                 int startColumn,
                 int endColumn)
```
    Sets the range to which the specified AutoFilter applies.
    
    Parameters:
    row - Row index.
    startColumn - Start column index.
    endColumn - End column Index.
  - filterString
```
public void filterString(int column,
                java.lang.String criteria)
```
    Sets the filter for the column.notice we shall call AddAutoFilter before calling of filterString The filter criteria string. notice we use comma->"," as split char,so the cell value you want to filter shall not contains with comma filterString(10,"123,456") means column 10 shall contain 123 or 456, filterString(10,"123") means column10 shall contain 123 the column index value split with comma,eg. 123,456,789 or abc
  - refreshFilter
```
public void refreshFilter()
```
    Refresh auto filters to hide or unhide the rows.
  - removeAutoFilter
```
public void removeAutoFilter()
```
    Remove the auto filter of the worksheet.
  - resetFilter
```
public void resetFilter(int fieldIndex)
```
    The integer offset of the field on which you want to apply ,based on the first filter column (from the left of the list; the leftmost field is field 0).
  - addCustomFilter
```
public void addCustomFilter(int row,
                   java.lang.String critira)
```
    Add custom filter for the specified row.
    Remarks
    The filter criteria string. notice we use , and ; as split char,so the cell value shall not contains with those split char below are the criteria string examples //column 0 with value 12.3 CELL0 = 12.3 //column 1 with value ABC CELL1 = ABC //column 0 with value 123 or 456 or ABC and column 1 with value ABC CELL0 = 123,456,ABC; CELL1 = ABC
  - getVisible
```
public boolean getVisible()
```
    Indicates whether this sheet's name is shown in the sheet tabs of the control.
    
    Overrides:
    
    getVisible in class Control
  - setVisible
```
public void setVisible(boolean value)
```
    Indicates whether this sheet's name is shown in the sheet tabs of the control.
    
    Overrides:
    
    setVisible in class Control
  - moveTo
```
public void moveTo(int index)
```
    Moves the sheet to another location in the spreadsheet.
    
    Parameters:
    index - Destination sheet index.
  - getFirstVisibleRow
```
public int getFirstVisibleRow()
```
    Represents first visible row index.
  - setFirstVisibleRow
```
public void setFirstVisibleRow(int value)
```
    Represents first visible row index.
  - getFirstVisibleColumn
```
public int getFirstVisibleColumn()
```
    Represents first visible column index.
  - setFirstVisibleColumn
```
public void setFirstVisibleColumn(int value)
```
    Represents first visible column index.
  - getZoom
```
public int getZoom()
```
    Represents the scaling factor in percentage. It should be between 10 and 400.
  - setZoom
```
public void setZoom(int value)
```
    Represents the scaling factor in percentage. It should be between 10 and 400.
  - getTabColor
```
public Color getTabColor()
```
    Represents worksheet tab color.
    Remarks
    This feature is only supported in ExcelXP(Excel2002) and above version. If you save file as Excel97 or Excel2000 format, it will be omitted.
  - setTabColor
```
public void setTabColor(Color value)
```
    Represents worksheet tab color.
    Remarks
    This feature is only supported in ExcelXP(Excel2002) and above version. If you save file as Excel97 or Excel2000 format, it will be omitted.
  - clearComments
```
public void clearComments()
```
    Clears all comments in designer spreadsheet.
  - getCodeName
```
public java.lang.String getCodeName()
```
    Represents worksheet code name.
    Remarks
    You cannot change the code name while the template file contains VBA/macro.
  - getBackgroundImage
```
public byte[] getBackgroundImage()
```
    Gets worksheet background image.
  - setBackgroundImage
```
public void setBackgroundImage(byte[] value)
```
    Sets worksheet background image.
  - calculateFormula
```
public java.lang.Object calculateFormula(java.lang.String formula)
```
    Calculates a formula.
    
    Parameters:
    formula -
    
    Returns:
  - setProtect
```
public void setProtect()
```
    Protects worksheet.
    Remarks
    This method protects worksheet without password. It can protect worksheet in all versions of Excel file.
  - unProtect
```
public void unProtect()
```
    unProtects worksheet.
  - autoFitColumn
```
public void autoFitColumn(int columnIndex,
                 int firstRow,
                 int lastRow)
```
    Autofits the column width.
    Remarks
    This method autofits a row based on content in a range of cells within the row.
    
    Parameters:
    columnIndex - Column index.
    firstRow - First row index.
    lastRow - Last row index.
  - autoFitColumn
```
public void autoFitColumn(int columnIndex)
```
    Autofits the column width.
    Remarks
    AutoFitColumn is an imprecise function.
    
    Parameters:
    columnIndex - Column index.
  - autoFitRows
```
public void autoFitRows()
```
    Autofits all rows in this worksheet.
  - autoFitColumns
```
public void autoFitColumns()
```
  - autoFitRow
```
public void autoFitRow(int rowIndex,
              int firstColumn,
              int lastColumn)
```
    Autofits the row height.
    Remarks
    This method autofits a row based on content in a range of cells within the row.
    
    Parameters:
    rowIndex - Row index.
    firstColumn - First column index.
    lastColumn - Last column index.
  - autoFitRows
```
public void autoFitRows(boolean onlyAuto)
```
    Autofits all rows in this worksheet.
    
    Parameters:
    onlyAuto - True,only autofits the row height when row height is not customed.
  - autoFitRows
```
public void autoFitRows(int startRow,
               int endRow)
```
    Autofits row height in a range.
    
    Parameters:
    startRow - Start row index.
    endRow - End row index.
  - autoFitRow
```
public void autoFitRow(int startRow,
              int endRow,
              int startColumn,
              int endColumn)
```
    Autofits row height in a rectangle range.
    
    Parameters:
    startRow - Start row index.
    endRow - End row index.
    startColumn - Start column index.
    endColumn - End column index.
  - autoFitRow
```
public void autoFitRow(int rowIndex)
```
    Autofits the row height.
    Remarks
    AutoFitRow is an imprecise function.
    
    Parameters:
    rowIndex - Row index.
  - setAllCellsReadonly
```
public void setAllCellsReadonly()
```
    Makes all cells readonly.this is extended attribute notice this attribute can not keep in actual cell,if you want to keep protect please use setProtect
  - setAllCellsEditable
```
public void setAllCellsEditable()
```
    Makes all cells editable.this is extended attribute
  - getColumnCaption
```
public java.lang.String getColumnCaption(int column)
```
    Gets the column caption. If the caption is not set, returns empty string.
    
    Parameters:
    column - Column index.
    
    Returns:
    The column caption. If the caption is not set, returns empty string.
  - setColumnCaption
```
public void setColumnCaption(int column,
                    java.lang.String caption)
```
    Sets the caption for the column.please note this is an extension attribute and can not keep in excel file
    
    Parameters:
    column - Column index.
    caption - The column caption. Pass null or empty string if you want cancel the caption.
  - getRowCaption
```
public java.lang.String getRowCaption(int row)
```
    Gets the row caption. If the caption is not set, returns empty string.
    
    Parameters:
    row - Row index.
    
    Returns:
    The row caption. If the caption is not set, returns empty string.
  - setRowCaption
```
public void setRowCaption(int row,
                 java.lang.String caption)
```
    Sets the caption for the row.
    
    Parameters:
    row - Row index.
    caption - The row caption. Pass null or empty string if you want cancel the caption.
  - getRowHeaderToolTip
```
public java.lang.String getRowHeaderToolTip(int rowIndex)
```
    Gets the rowheader's tooltip text.
    
    Parameters:
    rowIndex - The row's index.
    
    Returns:
    The tooltip text.
  - setRowHeaderToolTip
```
public void setRowHeaderToolTip(int rowIndex,
                       java.lang.String toolTip)
```
    Sets the rowheader's tooltip text.
    
    Parameters:
    rowIndex - The row's index.
    toolTip - The tooltip text.
  - getColumnHeaderToolTip
```
public java.lang.String getColumnHeaderToolTip(int colIndex)
```
    Gets the columnheader's tooltip text.
    
    Parameters:
    colIndex - The column's index.
    
    Returns:
    The tooltip text.
  - setColumnHeaderToolTip
```
public void setColumnHeaderToolTip(int colIndex,
                          java.lang.String toolTip)
```
    Sets the columnheader's tooltip text.
    
    Parameters:
    colIndex - The column's index.
    toolTip - The tooltip text.
  - getPivotTables
```
public GridPivotTableCollection getPivotTables()
```
    Gets the pivotTables in the worksheet.
  - getIsReadonly
```
public boolean getIsReadonly(int row,
                    int col)
```
    Gets whether the cell is readonly.this is an extended attribute of GridWeb ,it will not keep in actual excel file
  - setIsReadonly
```
public void setIsReadonly(int row,
                 int col,
                 boolean value)
```
    Sets whether the cell is readonly.this is an extended attribute of GridWeb ,it will not keep in actual excel file
  - setEditableRange
```
public void setEditableRange(int startRow,
                    int startColumn,
                    int rows,
                    int columns)
```
    Makes a range of cells editable. http://docs.aspose.com:8082/docs/display/cellsnet/Protecting+Cells Make all cells read only by calling the SetAllCellsReadonly method. then call this method to Specify the range of cells that to be editable
    
    Parameters:
    startRow - The start row of the range.
    startColumn - The start column of the range.
    rows - The number of the rows.
    columns - The number of the columns.
  - setReadonlyRange
```
public void setReadonlyRange(int startRow,
                    int startColumn,
                    int rows,
                    int columns)
```
    Makes a range of cells readonly. http://docs.aspose.com:8082/docs/display/cellsnet/Protecting+Cells First make all cells editable by calling the SetAllCellsEditable method. then call this method to Specify the range of cells that to be readonly
    
    Parameters:
    startRow - The start row of the range.
    startColumn - The start column of the range.
    rows - The number of the rows.
    columns - The number of the columns.
  - groupRows
```
public void groupRows(int firstIndex,
             int lastIndex,
             boolean isHidden)
```
    Groups rows.
    
    Parameters:
    firstIndex - The first row index to be grouped.
    lastIndex - The last row index to be grouped.
    isHidden - Specifies if the grouped rows are hidden.
  - unGroupRows
```
public void unGroupRows(int firstIndex,
               int lastIndex)
```
    Ungroups rows.
    Remarks
    Only removes outter group info.
    
    Parameters:
    firstIndex - The first row index to be ungrouped.
    lastIndex - The last row index to be ungrouped.
  - setRowReadonly
```
public void setRowReadonly(int rowIndex,
                  boolean isReadonly)
```
    Sets a row to readonly so user can't delete it from client side. this is extended method of GridWeb specifically,it will not keep and take affect in actual excel file
    
    Parameters:
    rowIndex - row index.
    isReadonly - true or false.
  - setColumnReadonly
```
public void setColumnReadonly(int columnIndex,
                     boolean isReadonly)
```
    Sets a column to readonly so user can't delete it from client side. this is extended method of GridWeb specifically,it will not keep and take affect in actual excel file
    
    Parameters:
    columnIndex - column index.
    isReadonly - true or false.
  - getRowReadonly
```
public boolean getRowReadonly(int rowIndex)
```
    Gets if a row is readonly. this is extended method of GridWeb specifically,it will not keep and take affect in actual excel file
    
    Parameters:
    rowIndex - row index.
    
    Returns:
    If readonly returns true.
  - getColumnReadonly
```
public boolean getColumnReadonly(int columnIndex)
```
    Gets if a column is readonly. this is extended method of GridWeb specifically,it will not keep and take affect in actual excel file
    
    Parameters:
    columnIndex - column index.
    
    Returns:
    If readonly returns true.
  - getStandardHeight
```
public double getStandardHeight()
```
    Gets the default row height in this worksheet,in unit of points.
  - setStandardHeight
```
public void setStandardHeight(double value)
```
    Sets the default row height in this worksheet,in unit of points.
  - getStandardHeightPixels
```
public int getStandardHeightPixels()
```
    Gets the default row height in this worksheet,in unit of pixels.
  - setStandardHeightPixels
```
public void setStandardHeightPixels(int value)
```
    Sets the default row height in this worksheet,in unit of pixels.
  - getGridActiveCell
```
public GridCell getGridActiveCell()
```
    Gets the active cell in the worksheet.
  - setGridActiveCell
```
public void setGridActiveCell(GridCell value)
```
    Sets the active cell in the worksheet.
  - isSummaryRowBelow
```
public boolean isSummaryRowBelow()
```
    Indicates if the summary row will be positioned below the detail rows in the outline.
  - setSummaryRowBelow
```
public void setSummaryRowBelow(boolean value)
```
    Indicates if the summary row will be positioned below the detail rows in the outline.
  - createSubtotal
```
public void createSubtotal(int columnNameRowIndex,
                  int dataRows,
                  int groupByColumnIndex,
                  int subtotalFunction,
                  int[] subtotalColumnIndexList,
                  java.lang.String functionLabel,
                  GridTableItemStyle grandCellStyle,
                  GridTableItemStyle subtotalCellStyle,
                  int numberType,
                  java.lang.String customString)
```
    Creates subtotal in the sheet.
    
    Parameters:
    columnNameRowIndex - The row index of the column name row.
    dataRows - The number of the data rows.
    groupByColumnIndex - The column index of the column to be grouped.
    subtotalFunction - SubtotalFunction. The subtotal function type.
    subtotalColumnIndexList - The column indexes to be subtotaled.
    functionLabel - The label of subtotal function.
    grandCellStyle - The style of the grand total line.
    subtotalCellStyle - The style of the subtotal line.
    numberType - NumberType. The number type of the subtotal result cells.
    customString - The custome format string of the subtotal result cells. Can be null.
  - createSubtotal
```
public void createSubtotal(int columnNameRowIndex,
                  int dataRows,
                  int groupByColumnIndex,
                  int subtotalFunction,
                  int[] subtotalColumnIndexList)
```
    Creates subtotal in the sheet.
    
    Parameters:
    columnNameRowIndex - The row index of the column name row.
    dataRows - The number of the data rows.
    groupByColumnIndex - The column index of the column to be grouped.
    subtotalFunction - SubtotalFunction. The subtotal function type.
    subtotalColumnIndexList - The column indexes to be subtotaled.
  - removeSubtotal
```
public void removeSubtotal()
```
    Removes subtotal created by the CreateSubtotal method in the sheet.

Class GridWorksheet

Method Summary

Methods inherited from class com.aspose.gridweb.Control

Methods inherited from class java.lang.Object

Method Detail

getName

setName

copy

isProtected

getIndex

getWorkbook

getComments

getCells

isGridlinesVisible

setGridlinesVisible

unFreezePanes

getActiveCell

setActiveCell

getDisplayZeros

setDisplayZeros

getDisplayRightToLeft

setDisplayRightToLeft

getOutlineShown

setOutlineShown

getSelected

setSelected

freezePanes

freezePanes

getFreezedPanes

getPictures

getShapes

getHyperlinks

getValidations

addAutoFilter

filterString

refreshFilter

removeAutoFilter

resetFilter

addCustomFilter

getVisible

setVisible

moveTo

getFirstVisibleRow

setFirstVisibleRow

getFirstVisibleColumn

setFirstVisibleColumn

getZoom

setZoom

getTabColor

setTabColor

clearComments

getCodeName

getBackgroundImage

setBackgroundImage

calculateFormula

setProtect

unProtect

autoFitColumn

autoFitColumn

autoFitRows

autoFitColumns

autoFitRow

autoFitRows

autoFitRows

autoFitRow

autoFitRow

setAllCellsReadonly

setAllCellsEditable

getColumnCaption

setColumnCaption

getRowCaption

setRowCaption

getRowHeaderToolTip

setRowHeaderToolTip

getColumnHeaderToolTip

setColumnHeaderToolTip

getPivotTables

getIsReadonly

setIsReadonly

setEditableRange