Worksheet class - xlsio library

Constructors

Worksheet(Workbook workbook): Creates an instance of Worksheet.

Properties

activePane ↔ ActivePane: getter/setter pair
algorithmName ↔ String?: Alogrithm name to protect/unprotect worksheet.
getter/setter pair
autoFilters → AutoFilterCollection: no setter
book ↔ Workbook: getter/setter pair
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
defaultMaxHeight → double: Maximum row height in points.
final
defaultValues → List<bool>: Represents the defeault values for sheet Protection.
final
dvTable → DataValidationTable: Represents the method to create an instance for table if it is null
no setter
flag → List<bool>: Represent the flag for sheet protection.
final
hashCode → int: The hash code for this object.
no setterinherited
hashValue ↔ List<int>: Hash value to ensure the sheet protected password.
getter/setter pair
horizontalSplit ↔ int: getter/setter pair
hyperlinkRelationId → List<String>: Represent the hyperlink relation id
final
hyperlinks → HyperlinkCollection: Gets/Sets a hyperlink collections in the worksheet.
no setter
index ↔ int: Represent the worksheet index.
getter/setter pair
isfreezePane ↔ bool: getter/setter pair
isPassword ↔ int: 16-bit hash value of the password.
getter/setter pair
isPasswordProtected ↔ bool: Gets a value indicating whether worksheet is protected with password.
getter/setter pair
isRightToLeft ↔ bool: Indicates whether worksheet is displayed right to left.FALSE by default
getter/setter pair
isSummaryRowBelow → bool: set summary row below
final
isTapColorApplied ↔ bool: Determine whether the tab color is applied on the worksheet or not.
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
protectionAttributes → List<String>: Represents Protection Attributes
final
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
saltValue ↔ List<int>: Random generated Salt for the sheet password.
getter/setter pair
showGridlines ↔ bool: Sets the grid line visible. True if grid lines are visible. otherwise, False.
getter/setter pair
spinCount → int: Spin count to loop the hash algorithm.
final
standardHeight → double: Standard column width.
final
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
tableCount → int: Represents the getter to get the table count
no setter
topLeftCell ↔ String: getter/setter pair
verticalSplit ↔ int: getter/setter pair
visibility ↔ WorksheetVisibility: Get the visibility of worksheet.
getter/setter pair
workbook → Workbook: Represents parent workbook.
no setter

Methods

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.
autoFitToRow(int rowIndex, int firstColumn, int lastColumn) → void: Autofits row by checking only the cells in the row that are specified by column range.
checkRange(int row, int column) → void: Checks if specified cell has correct row and column index.
clear() → void: Clear the worksheet.
createCondFormatCollectionWrapper(Range range, String value) → ConditionalFormats: Creates collection with specified argument.
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.
evaluateFileColumnWidth(double realWidth) → double: Converts width displayed by Excel to width that should be written into file.
getColumnIndex(String columnName) → int: Converts column name into index.
getColumnWidth(int iColumnIndex) → double: Returns the width of the specified column.
getColumnWidthInPixels(int iColumnIndex) → int: Returns width of the specified column in pixels.
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.
getValueRowCol(int iRow, int iColumn) → Object: Get the value from the specified cell.
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.
innerSetRowHeight(int iRowIndex, double value, bool bIsBadFontHeight, int units) → void: Sets inner row height.
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.
inherited
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.
setValueRowCol(String value, int iRow, int iColumn) → void: Sets value for the specified cell.
toString() → String: A string representation of this object.
inherited
unfreezePanes() → void: Removes the existing freeze panes from the worksheet.

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Methods

convertSecondsMinutesToHours(String value, double dNumber) → String: Convert seconds into minute and minutes into hour.
getPasswordHash(String password) → int: Returns hash value for the password string.