Worksheet class

Represents a worksheet in a workbook.


Worksheet(Workbook workbook)
Creates an instance of Worksheet.


autoFilters AutoFilterCollection
no setter
calcEngine CalcEngine?
Gets or sets the a CalcEngine object.
getter/setter pair
chartCount int
Represents the chart count in the workbook.
getter/setter pair
charts ChartHelper?
Sets a Chart helper in the worksheet.
getter/setter pair
columns ColumnCollection
Represents all the columns in the specified worksheet.
no setter
conditionalFormats List<_ConditionalFormatsImpl>
Gets/Sets a Conditional Format collections in the worksheet.
getter/setter pair
hashCode int
The hash code for this object.
no setterinherited
Gets/Sets a hyperlink collections in the worksheet.
no setter
index int
Represent the worksheet index.
getter/setter pair
isRightToLeft bool
Indicates whether worksheet is displayed right to left.FALSE by default
getter/setter pair
mergeCells MergedCellCollection
Gets/Sets a merged cell collections in the worksheet.
getter/setter pair
name String
Returns or sets the name of the worksheet.
getter/setter pair
names Names
Represents worksheet named range collection.
no setter
pageSetup PageSetup
Represents the page setup settings for the worksheet.
no setter
pictures PicturesCollection
Gets/Sets a pictures collections in the worksheet.
no setter
rows RowCollection
Gets/Sets a rows collections in the worksheet.
no setter
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
showGridlines bool
Sets the grid line visible. True if grid lines are visible. otherwise, False.
getter/setter pair
tabColor String
Get the tab color for the worksheet.
getter/setter pair
tableCollection ExcelTableCollection
Get a collection of tables in the worksheet. Read-only.
no setter
visibility WorksheetVisibility
Get the visibility of worksheet.
getter/setter pair
workbook Workbook
Represents parent workbook.
no setter


autoFitColumn(int colIndex) → void
Changes the width of the specified column to achieve the best fit.
autoFitRow(int rowIndex) → void
Changes the height of the specified row to achieve the best fit.
checkRange(int row, int column) → void
Checks if specified cell has correct row and column index.
deleteColumn(int columnIndex, [int? columnCount]) → void
Delete the Column in the Worksheet.
deleteRow(int rowIndex, [int? rowCount]) → void
Delete the Row in the Worksheet.
enableSheetCalculations() → void
Enables the calculation support.
getColumnIndex(String columnName) int
Converts column name into index.
getColumnWidth(int iColumnIndex) double
Returns the width of the specified column.
getFirstColumn() int
Gets the first column index.
getFirstRow() int
Get the index of the first row in UsedRange.
getLastColumn() int
Gets the last column index / column count.
getLastRow() int
get the index of the last row in UsedRange.
getRangeByIndex(int rowIndex, int columnIndex, [int lastRowIndex = -1, int lastColumnIndex = -1]) Range
Get range by index value.
getRangeByName(String cellReference) Range
Get range by Name.
getRowHeight(int iRow) double
Returns the height of the specified row.
importData(List<ExcelDataRow> excelDataRows, int rowIndex, int colIndex) → void
Imports collection of ExcelDataRows into a worksheet.
importList(List<Object?> arrObject, int firstRow, int firstColumn, bool isVertical) int
Imports an array of objects into a worksheet with specified alignment.
insertColumn(int columnIndex, [int? columnCount, ExcelInsertOptions? insertOptions]) → void
Inserts an empty column for the specified column index.
insertRow(int rowIndex, [int? rowCount, ExcelInsertOptions? insertOptions]) → void
Inserts an empty row in the specified row index.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
protect(String password, [ExcelSheetProtectionOption? options]) → void
Protect the worksheet with specific protection options and password.
setColumnWidthInPixels(int iColumnIndex, int columnWidth) → void
Sets column width in pixels for the specified row.
setRowHeightInPixels(int iRowIndex, double rowHeight) → void
Sets Rows Heights in pixels for the specified column.
toString() String
A string representation of this object.
unfreezePanes() → void
Removes the existing freeze panes from the worksheet.


operator ==(Object other) bool
The equality operator.