Static $tStatic nextGets or sets the default column width including padding, in 256ths of the '0' digit character width in the workbook's default font.
The default column width is the width of all columns which do not have their width set.
The value assigned must be between 0 and 65535. Invalid values will be automatically adjusted to valid values.
Setting or getting this property is equivalent to calling setDefaultColumnWidth or getDefaultColumnWidth using the WorksheetColumnWidthUnit value of Character256th.
The default column width including padding, in 256ths of the '0' digit character width in the workbook's default font.Gets or sets the default row height in twips (1/20th of a point).
The default row height is the height of all rows which do not have their height explicitly set to a positive number.
If the assigned value is -1, the default row height will then be calculated based on the default font for the workbook, and subsequently getting this property will return the font-based default row height.
The default row height in twips (1/20th of a point).ArgumentOutOfRangeException The value assigned is outside the value range of -1 and 8192.
Gets the object which controls the display of the worksheet.
The display options include any settings which affect the display of the worksheet when viewed in Microsoft Excel. These settings will not affect the printed worksheet or the data stored in the worksheet.
The object which controls the display of the worksheet.Exposes methods to identify a region in the worksheet and to apply filters and optionally sort criteria to that region.
Returns a boolean indicating if the Sheet has been protected with a password.
When protecting a Sheet, a password is optional. The HasProtectionPassword will return true if the Sheet is currently protected (see isProtected) and a password was specified when it was protected.
Gets the zero-based index of this worksheet in its parent Workbook.worksheets collection.
Negative one indicates the worksheet has been removed from its parent collection.
The zero-based index of this worksheet in its parent Worksheets collection.Returns a boolean indicating if the Worksheet has been protected.
The IsProtected property will return true if the Worksheet is currently protected. When a Worksheet is protected only unprotected cells may be edited. In addition, other operations may be limited based on the properties of the WorksheetProtection which may be accessed using the Protection property.
Gets or sets the sheet name.
The sheet name is case-insensitively unique in the workbook.
The sheet name is shown in the tab for the worksheet. In addition, the worksheet name can be used by formulas from other worksheets to refer to cells in this worksheet.
The sheet name.ArgumentNullException The value assigned is null or empty.
ArgumentException The value assigned contains the invalid characters: ':', '', '/', '?', '*', '[', or ']'.
ArgumentException The value assigned exceeds 31 characters in length.
ArgumentException The value assigned is being used as the name of another sheet (sheet names are case-insensitively compared).
Gets the object which controls how the worksheet prints.
The print options include any settings which affect the printed appearance of the worksheet. These settings will not affect the data in the worksheet. Although these are not display settings, some worksheet display styles will display all or some of the print options, so these settings may affect the display of the worksheet when viewed in Microsoft Excel.
The object which controls how the worksheet prints.Returns an object that provides information used when the Worksheet has been protected. @see@see@see WorksheetProtection
Gets the value which indicates whether this worksheet is selected.
If the worksheet has been removed from its parent Workbook.worksheets collection, this will always return False.
The value which indicates whether this worksheet is selected.Gets the zero-based index of this sheet in its parent Workbook.sheets collection.
Negative one indicates the sheet has been removed from its parent collection.
The zero-based index of this sheet in its parent Sheets collection.Exposes methods to identify a region in the worksheet and to apply sort criteria to that region.
Gets or sets the WorkbookColorInfo to use for the associated sheet's tab in the tab bar of Microsoft Excel.
If the tab bar is not visible, this color will not be seen.
The WorkbookColorInfo to use for the associated sheet's tab in the tab bar of Microsoft Excel.Clears all conditional formatting rules from the Worksheet so they do not get saved.
Gets the column at the specified index.
Note: Iterating the collection will not create all columns. It will only iterate the columns which have already been used. To create and iterate all columns in the worksheet use a For loop, iterating from 0 to one less than the maximum column count, and pass in each index to the collection's indexer.
The column at the specified index.ArgumentOutOfRangeException 'index' is less than zero.
InvalidOperationException 'index' is greater than or equal to Workbook.maxExcelColumnCount or Workbook.maxExcel2007ColumnCount, depending on the Workbook.currentFormat.
The zero-based index of the column to get.
Gets the collection of columns in the worksheet.
The collection of columns is a fixed length collection, with the maximum number of columns in the collection being
Workbook.maxExcelColumnCount or Workbook.maxExcel2007ColumnCount,
depending on the
Note: Iterating the collection will not create all columns. It will only iterate the columns which have already been used. To create and iterate all columns in the worksheet use a For loop, iterating from 0 to one less than the maximum column count, and pass in each index to the collection's indexer.
The collection of columns in the worksheet.Indexer
The item at the specified index
IndexOutOfRangeException If the index is negative or greater than or equal to count
The zer-based index of an item
Returns a
Gets the data table at the specified index in the collection. The data table at the specified index.
The zero-based index of the data table to get.
Gets the collection of data tables in the worksheet. The collection of data tables in the worksheet.
Gets or sets the references which have the data validation rule applied to it.
ArgumentNullException Occurs when the 'rule' is null.
KeyNotFoundException Occurs when the property is retrieved and the 'rule' is not applied to the worksheet.
ArgumentException Occurs when the property is set and the value is from a Worksheet other than this collection.
ArgumentException Occurs when the property is set and the 'rule' is invalid based on its rule type's requirements.
A data validation rule.
Gets the collection of data validation rules applied to cells in the Worksheet.
Deletes a region of cells.
InvalidOperationException If the operation is not allowed, e.g. if it the range intersects with a protected region.
ArgumentNullException If region is null.
The region to delete
If true will shift cells left from the right of the region to occupy the deleted region, otherwise will shift cells up from below the region.
Deletes a region of cells.
InvalidOperationException If the operation is not allowed, e.g. if it the range intersects with a protected region.
ArgumentException If address is not valid.
The address of the region to delete
If true will shift cells left from the right of the region to occupy the deleted region, otherwise will shift cells up from below the region.
Gets the cell at the specified address or name.
The Workbook.cellReferenceMode of the workbook will be used to parse the cell address.
If one or more region references are specified instead of a cell reference, the top-left cell of the first region will be returned.
If a name is specified, it must refer to a cell or region in the Worksheet and it must be scoped to the Workbook or the Worksheet or null will be returned.
ArgumentNullException 'address' is null.
ArgumentException 'address' is not a valid name or a valid cell or region address in the workbook's cell reference mode.
InvalidOperationException 'address' is a relative R1C1 address. The overload taking an origin cell must be used to resolve relative R1C1 references.
A cell represented by the specified address or name.
The address or name of the cell.
Gets the cell at the specified address or name.
If one or more region references are specified instead of a cell reference, the top-left cell of the first region will be returned.
If a name is specified, it must refer to a cell or region in the Worksheet and it must be scoped to the Workbook or the Worksheet or null will be returned.
ArgumentNullException 'address' is null.
InvalidEnumArgumentException 'cellReferenceMode' is not defined in the CellReferenceMode enumeration.
ArgumentException 'address' is not a valid name or a valid cell or region address in the specified cell reference mode.
InvalidOperationException 'address' is a relative R1C1 address. The overload taking an origin cell must be used to resolve relative R1C1 references.
A cell represented by the specified address or name.
The address or name of the cell.
The cell reference mode to use to parse the cell address.
Gets the cell at the specified address or name.
If one or more region references are specified instead of a cell reference, the top-left cell of the first region will be returned.
The origin cell specified will not be used if a name is specified, if the workbook has an A1 cell reference mode, or if an absolute R1C1 address is specified.
If a name is specified, it must refer to a cell or region in the Worksheet and it must be scoped to the Workbook or the Worksheet or null will be returned.
ArgumentNullException 'address' is null.
InvalidEnumArgumentException 'cellReferenceMode' is not defined in the CellReferenceMode enumeration.
ArgumentException 'address' is not a valid name or a valid cell or region address in the specified cell reference mode.
InvalidOperationException 'address' is a relative R1C1 address and 'originCell' is null. An origin cell must be specified to resolve relative R1C1 references.
A cell represented by the specified address or name.
The address or name of the cell.
The cell reference mode to use to parse the cell address.
The origin for resolving relative R1C1 references.
Gets the cell at the specified address or name.
The Workbook.cellReferenceMode of the workbook will be used to parse the cell address.
If one or more region references are specified instead of a cell reference, the top-left cell of the first region will be returned.
The origin cell specified will not be used if a name is specified, if the workbook has an A1 cell reference mode, or if an absolute R1C1 address is specified.
If a name is specified, it must refer to a cell or region in the Worksheet and it must be scoped to the Workbook or the Worksheet or null will be returned.
ArgumentNullException 'address' is null.
ArgumentException 'address' is not a valid name or a valid cell or region address in the workbook's cell reference mode.
InvalidOperationException 'address' is a relative R1C1 address and 'originCell' is null. An origin cell must be specified to resolve relative R1C1 references.
A cell represented by the specified address or name.
The address or name of the cell.
The origin for resolving relative R1C1 references.
Gets the cell conditional format for the cell at the specified row and column index.
ArgumentOutOfRangeException 'rowIndex' is less than zero or greater than or equal to the number of rows in the worksheet. 'columnIndex' is less than zero or greater than or equal to the number of columns in the worksheet.
The aggregated condition format for the cell at the specified column index or null if the cell is not contained in any conditional format region.
The 0-based index of the WorksheetRow within the rows collection.
The 0-based index of the cell within the WorksheetRow.
Gets the default column width in the specified units.
If 'units' is Character256th, the value returned will be the same as the value of the defaultColumnWidth property.
InvalidEnumArgumentException 'units' is not defined in the WorksheetColumnWidthUnit enumeration.
The default column width in the specified units.
The units in which the width should be returned.
Gets the region at the specified address or name.
The Workbook.cellReferenceMode of the workbook will be used to parse the region address.
If a cell reference is specified instead of a region reference, a 1x1 region containing the cell at the address will be returned.
If a list of references is specified, the region specified by the first reference will be returned.
If a name is specified, it must refer to a cell or region in the Worksheet and it must be scoped to the Workbook or the Worksheet or null will be returned.
ArgumentNullException 'address' is null.
ArgumentException 'address' is not a valid name or a valid cell or region address in the workbook's cell reference mode.
InvalidOperationException 'address' is a relative R1C1 address. The overload taking an origin cell must be used to resolve relative R1C1 references.
A region represented by the specified address or name.
The address or name of the region.
Gets the region at the specified address or name.
If a cell reference is specified instead of a region reference, a 1x1 region containing the cell at the address will be returned.
If a list of references is specified, the region specified by the first reference will be returned.
If a name is specified, it must refer to a cell or region in the Worksheet and it must be scoped to the Workbook or the Worksheet or null will be returned.
ArgumentNullException 'address' is null.
InvalidEnumArgumentException 'cellReferenceMode' is not defined in the CellReferenceMode enumeration.
ArgumentException 'address' is not a valid name or a valid cell or region address in the specified cell reference mode.
InvalidOperationException 'address' is a relative R1C1 address. The overload taking an origin cell must be used to resolve relative R1C1 references.
A region represented by the specified address or name.
The address or name of the region.
The cell reference mode to use to parse the region address.
Gets the region at the specified address or name.
If a cell reference is specified instead of a region reference, a 1x1 region containing the cell at the address will be returned.
If a list of references is specified, the region specified by the first reference will be returned.
The origin cell specified will not be used if a name is specified, if the workbook has an A1 cell reference mode, or if an absolute R1C1 address is specified.
If a name is specified, it must refer to a cell or region in the Worksheet and it must be scoped to the Workbook or the Worksheet or null will be returned.
ArgumentNullException 'address' is null.
InvalidEnumArgumentException 'cellReferenceMode' is not defined in the CellReferenceMode enumeration.
ArgumentException 'address' is not a valid name or a valid cell or region address in the specified cell reference mode.
InvalidOperationException 'address' is a relative R1C1 address and 'originCell' is null. An origin cell must be specified to resolve relative R1C1 references.
A region represented by the specified address or name.
The address or name of the region.
The cell reference mode to use to parse the region address.
The origin for resolving relative R1C1 references.
Gets the region at the specified address or name.
The Workbook.cellReferenceMode of the workbook will be used to parse the region address.
If a cell reference is specified instead of a region reference, a 1x1 region containing the cell at the address will be returned.
If a list of references is specified, the region specified by the first reference will be returned.
The origin cell specified will not be used if a name is specified, if the workbook has an A1 cell reference mode, or if an absolute R1C1 address is specified.
If a name is specified, it must refer to a cell or region in the Worksheet and it must be scoped to the Workbook or the Worksheet or null will be returned.
ArgumentNullException 'address' is null.
ArgumentException 'address' is not a valid name or a valid cell or region address in the workbook's cell reference mode.
InvalidOperationException 'address' is a relative R1C1 address and 'originCell' is null. An origin cell must be specified to resolve relative R1C1 references.
A region represented by the specified address or name.
The address or name of the region.
The origin for resolving relative R1C1 references.
Gets the regions at the specified address or name.
The Workbook.cellReferenceMode of the workbook will be used to parse the region address.
The address can be a list of references, each one referring to a separate region on the Worksheet.
If a cell or single region reference is specified instead, an array of one region at the address will be returned.
If a name is specified, it must refer to cells or regions in the Worksheet and it must be scoped to the Workbook or the Worksheet or null will be returned.
ArgumentNullException 'address' is null.
ArgumentException 'address' is not a valid name or a valid cell or region address in the workbook's cell reference mode.
InvalidOperationException 'address' is a relative R1C1 address. The overload taking an origin cell must be used to resolve relative R1C1 references.
An array of regions represented by the specified address or name.
The address or name of the region.
Gets the regions at the specified address or name.
The address can be a list of references, each one referring to a separate region on the Worksheet.
If a cell or single region reference is specified instead, an array of one region at the address will be returned.
If a name is specified, it must refer to cells or regions in the Worksheet and it must be scoped to the Workbook or the Worksheet or null will be returned.
ArgumentNullException 'address' is null.
InvalidEnumArgumentException 'cellReferenceMode' is not defined in the CellReferenceMode enumeration.
ArgumentException 'address' is not a valid name or a valid cell or region address in the specified cell reference mode.
InvalidOperationException 'address' is a relative R1C1 address. The overload taking an origin cell must be used to resolve relative R1C1 references.
An array of regions represented by the specified address or name.
The address or name of the region.
The cell reference mode to use to parse the region address.
Gets the regions at the specified address or name.
The address can be a list of references, each one referring to a separate region on the Worksheet.
If a cell or single region reference is specified instead, an array of one region at the address will be returned.
The origin cell specified will not be used if a name is specified, if the workbook has an A1 cell reference mode, or if an absolute R1C1 address is specified.
If a name is specified, it must refer to cells or regions in the Worksheet and it must be scoped to the Workbook or the Worksheet or null will be returned.
ArgumentNullException 'address' is null.
InvalidEnumArgumentException 'cellReferenceMode' is not defined in the CellReferenceMode enumeration.
ArgumentException 'address' is not a valid name or a valid cell or region address in the specified cell reference mode.
InvalidOperationException 'address' is a relative R1C1 address and 'originCell' is null. An origin cell must be specified to resolve relative R1C1 references.
An array of regions represented by the specified address or name.
The address or name of the region.
The cell reference mode to use to parse the region address.
The origin for resolving relative R1C1 references.
Gets the regions at the specified address or name.
The Workbook.cellReferenceMode of the workbook will be used to parse the region address.
The address can be a list of references, each one referring to a separate region on the Worksheet.
If a cell or single region reference is specified instead, an array of one region at the address will be returned.
The origin cell specified will not be used if a name is specified, if the workbook has an A1 cell reference mode, or if an absolute R1C1 address is specified.
If a name is specified, it must refer to cells or regions in the Worksheet and it must be scoped to the Workbook or the Worksheet or null will be returned.
ArgumentNullException 'address' is null.
ArgumentException 'address' is not a valid name or a valid cell or region address in the workbook's cell reference mode.
InvalidOperationException 'address' is a relative R1C1 address and 'originCell' is null. An origin cell must be specified to resolve relative R1C1 references.
An array of regions represented by the specified address or name.
The address or name of the region.
The origin for resolving relative R1C1 references.
Hides the columns in the specified range.
ArgumentException Occurs when the 'startIndex' is less than 0.
ArgumentException Occurs when the 'count' is less than 0.
ArgumentException Occurs when the 'startIndex' plus 'count' is greater than the number of columns in the worksheet.
The index of the first column to hide, or null to start hiding at the first column.
The number of columns to hide. If null, a single column will be hidden when 'startIndex' is specified and otherwise, all columns will be hidden.
Hides the rows in the specified range.
ArgumentException Occurs when the 'startIndex' is less than 0.
ArgumentException Occurs when the 'count' is less than 0.
ArgumentException Occurs when the 'startIndex' plus 'count' is greater than the number of rows in the worksheet.
The index of the first row to hide, or null to start hiding at the first row.
The number of rows to hide. If null, a single row will be hidden when 'startIndex' is specified and otherwise, all rows will be hidden.
Gets the hyperlink at the specified index in the collection. The hyperlink at the specified index.
ArgumentOutOfRangeException 'index' is less than zero or 'index' is greater than or equal to count.
The zero-based index of the hyperlink to get.
Gets the collection of hyperlinks applied to cells and regions in the Worksheet.
Inserts a region of cells.
InvalidOperationException If the operation is not allowed, e.g. if it would cause data to be shifted off the worksheet.
ArgumentNullException If region is null.
The region to insert
If true will shift existing cells right to make room for the newly inserted cells, otherwise will shift existing cells down below the region.
Inserts a region of cells.
InvalidOperationException If the operation is not allowed, e.g. if it would cause data to be shifted off the worksheet.
ArgumentException If address is not valid.
The region to insert
If true will shift existing cells right to make room for the newly inserted cells, otherwise will shift existing cells down below the region.
Gets the merged cell region at the specified index. The merged cell region at the specified index.
ArgumentOutOfRangeException 'index' is less than zero or 'index' is greater than or equal to count.
The zero-based index of the merged cell region to get.
Gets the collection of merged cell ranges in this worksheet.
Use WorksheetMergedCellsRegionCollection.add method to add new merged cell ranges to the worksheet.
The collection of merged cell ranges in this worksheet.Moves the worksheet to a new position in the owning workbook's collections of worksheets.
InvalidOperationException The worksheet has previously been removed from its workbook.
ArgumentOutOfRangeException 'index' is less than 0 or greater than or equal to the number of worksheets in the owning workbook.
The new 0-based index to where the worksheet should be moved.
Moves the sheet to a new position in the owning workbook's collections of sheets.
InvalidOperationException The sheet has previously been removed from its workbook.
ArgumentOutOfRangeException 'index' is less than 0 or greater than or equal to the number of sheets in the owning workbook.
The new 0-based index to where the sheet should be moved.
Protects the worksheet without a password.
When a Worksheet is protected without a password, the end user may unprotect the Worksheet in Excel without having to supply a password. To programatically unprotect a Worksheet, one may use the Unprotect() method.
The optional parameters are used to update the property values of the WorksheetProtection instance from this Worksheet's protection property. If the parameter is null, the current value of the associated property will be retained; otherwise the property will be updated with the specified value. For example, if the WorksheetProtection.allowDeletingColumns is currently true and the 'allowDeletingColumns' is null, then the property will continue to be true but if the 'allowDeletingColumns' is false the WorksheetProtection.allowDeletingColumns will be changed to false.
When one protects a Worksheet in Excel, the UI allows one to choose which cells may be selected. To affect this state one would change the WorksheetProtection.selectionMode property before or after protecting the Worksheet.
Note: If IsProtected is already true, the method will be ignored.
Optional boolean indicating the new value for the WorksheetProtection.allowDeletingColumns.
Optional boolean indicating the new value for the WorksheetProtection.allowDeletingRows.
Optional boolean indicating the new value for the WorksheetProtection.allowEditObjects.
Optional boolean indicating the new value for the WorksheetProtection.allowEditScenarios.
Optional boolean indicating the new value for the WorksheetProtection.allowFiltering.
Optional boolean indicating the new value for the WorksheetProtection.allowFormattingCells.
Optional boolean indicating the new value for the WorksheetProtection.allowFormattingColumns.
Optional boolean indicating the new value for the WorksheetProtection.allowFormattingRows.
Optional boolean indicating the new value for the WorksheetProtection.allowInsertingColumns.
Optional boolean indicating the new value for the WorksheetProtection.allowInsertingHyperlinks.
Optional boolean indicating the new value for the WorksheetProtection.allowInsertingRows.
Optional boolean indicating the new value for the WorksheetProtection.allowSorting.
Optional boolean indicating the new value for the WorksheetProtection.allowUsingPivotTables. @see@see@see protection
Gets the row at the specified index.
Note: Iterating the collection will not create all rows. It will only iterate the rows which have already been used. To create and iterate all rows in the worksheet use a For loop, iterating from 0 to one less than the maximum row count, and pass in each index to the collection's indexer.
The row at the specified index.ArgumentOutOfRangeException 'index' is less than zero.
InvalidOperationException 'index' is greater than or equal to Workbook.maxExcelRowCount or Workbook.maxExcel2007RowCount, depending on the Workbook.currentFormat.
The zero-based index of the row to get.
Gets the collection of rows in the worksheet.
The collection of rows is a fixed length collection, with the maximum number of rows in the collection being
Workbook.maxExcelRowCount or Workbook.maxExcel2007RowCount,
depending on the
Note: Iterating the collection will not create all rows. It will only iterate the rows which have already been used. To create and iterate all rows in the worksheet use a For loop, iterating from 0 to one less than the maximum row count, and pass in each index to the collection's indexer.
The collection of rows in the worksheet.Sets the default column width in the specified units.
ArgumentException 'value' is infinity or NaN.
InvalidEnumArgumentException 'units' is not defined in the WorksheetColumnWidthUnit enumeration.
The default column width to set on the worksheet, expressed in the specified 'units'.
The units in which the 'value' is expressed.
Gets the shape at the specified index in the collection. The shape at the specified index.
ArgumentOutOfRangeException 'index' is less than zero or 'index' is greater than or equal to count.
The zero-based index of the shape to get.
Gets the collection of shapes on the worksheet. The collection of shapes on the worksheet.
Indexer
The item at the specified index
IndexOutOfRangeException If the index is negative or greater than or equal to count
The zer-based index of an item
Returns a collection of SparklineGroups (read-only)
Gets the WorksheetTable at the specified index. The WorksheetTable at the specified index.
ArgumentOutOfRangeException 'index' is less than zero or 'index' is greater than or equal to count.
The zero-based index of the WorksheetTable to get.
Gets the WorksheetTable with the specified name.
Worksheet names are compared case-insensitively.
The WorksheetTable with the specified name.InvalidOperationException A WorksheetTable with the specified name does not exist in the collection.
The name of the WorksheetTable to get.
Gets the collection of WorksheetTable instances, or regions formatted as tables, in the worksheet.
Unhides the columns in the specified range.
ArgumentException Occurs when the 'startIndex' is less than 0.
ArgumentException Occurs when the 'count' is less than 0.
ArgumentException Occurs when the 'startIndex' plus 'count' is greater than the number of columns in the worksheet.
The index of the first column to unhide, or null to start unhiding at the first column.
The number of columns to unhide. If null, a single column will be unhidden when 'startIndex' is specified and otherwise, all columns will be unhidden.
Unhides the rows in the specified range.
ArgumentException Occurs when the 'startIndex' is less than 0.
ArgumentException Occurs when the 'count' is less than 0.
ArgumentException Occurs when the 'startIndex' plus 'count' is greater than the number of rows in the worksheet.
The index of the first row to unhide, or null to start unhiding at the first row.
The number of rows to unhide. If null, a single row will be unhidden when 'startIndex' is specified and otherwise, all rows will be unhidden.
Static compareStatic compareStatic equalsStatic equalsStatic getStatic getStatic getStatic referenceStatic static
Represents one worksheet in a Microsoft Excel workbook.
An Excel worksheet is essentially a table with a limited number of rows and columns. To create new worksheet, use WorksheetCollection.add method of the Workbook.worksheets collection on a Workbook instance.