Static $tStatic nextGets or sets the comment associated with the named reference or table. The comment associated with the named reference or table.
[[ArgumentException]] The value assigned is greater than 255 characters in length.
Gets the [[WorksheetRegion]] which represents the region of cells in the data area of the table.
The data area of the table can be changed by using one of the Resize overloads.
Gets or sets the value which indicates whether the alternate column format should be applied to the appropriate columns of the [[WorksheetTable]].
The column formats are defined by the [[WorksheetTableStyle]] applied to the WorksheetTable. These are stored in the [[WorksheetTableStyle.areaFormats]] collection and keyed by the [[WorksheetTableStyleArea]].ColumnStripe and WorksheetTableStyleArea.AlternateColumnStripe values. If there is no area format applied for the AlternateColumnStripe value, this property has no effect on the display of the table.
If this value is True and there is an area format for the alternate column stripe, the stripe widths are defined by the [[WorksheetTableStyle.columnStripeWidth]] and [[WorksheetTableStyle.alternateColumnStripeWidth]] values.
Gets or sets the value which indicates whether the alternate row format should be applied to the appropriate rows of the [[WorksheetTable]].
The row formats are defined by the [[WorksheetTableStyle]] applied to the WorksheetTable. These are stored in the [[WorksheetTableStyle.areaFormats]] collection and keyed by the [[WorksheetTableStyleArea]].RowStripe and WorksheetTableStyleArea.AlternateRowStripe values. If there is no area format applied for the AlternateRowStripe value, this property has no effect on the display of the table.
If this value is True and there is an area format for the alternate row stripe, the stripe widths are defined by the [[WorksheetTableStyle.rowStripeHeight]] and [[WorksheetTableStyle.alternateRowStripeHeight]] values.
Gets or sets the value which indicates whether the first column format should be applied to the appropriate column of the [[WorksheetTable]].
The first column format is defined by the [[WorksheetTableStyle]] applied to the WorksheetTable. It is stored in the [[WorksheetTableStyle.areaFormats]] collection and keyed by the [[WorksheetTableStyleArea]].FirstColumn value. If there is no area format applied for the FirstColumn value, this property has no effect on the display of the table.
If there is only one column in the table and both the first and last column formatting should be applied, the last column format will take precedence.
Gets or sets the value which indicates whether the last column format should be applied to the appropriate column of the [[WorksheetTable]].
The last column format is defined by the [[WorksheetTableStyle]] applied to the WorksheetTable. It is stored in the [[WorksheetTableStyle.areaFormats]] collection and keyed by the [[WorksheetTableStyleArea]].LastColumn value. If there is no area format applied for the LastColumn value, this property has no effect on the display of the table.
If there is only one column in the table and both the first and last column formatting should be applied, the last column format will take precedence.
Gets the [[WorksheetRegion]] which represents the region of cells in the header row of the table. A WorksheetRegion which represents the region of cells in the header row of the table or null if the header row is not visible.
Gets or sets the value indicating whether to allow filtering and show filter buttons in the table headers.
If [[isHeaderRowVisible]] is False, this property must be False and setting it to True will cause an error. If [[isHeaderRowVisible]] is set to True, this property will also be set to True automatically.
[[InvalidOperationException]] The value assigned is True and [[isHeaderRowVisible]] is False.
[[isHeaderRowVisible]]
Gets or sets the value which indicates whether the row containing column headers should be displayed.
When the header row is visible, the cell above each column of data will contain the [[WorksheetTableColumn.name]] value. Therefore, all header cells always contain a string value. Additionally, they will all be unique.
True if the row containing column headers is visible; False if it is hidden.[[WorksheetTableColumn.name]]
Gets or sets the value which indicates whether the row containing column totals should be displayed.
When the totals row is visible, the cell below each column of data will contain either a calculated value, a text value, or nothing. To display a calculated value in the cell, set the [[WorksheetTableColumn.totalFormula]]. To display a text label, set the [[WorksheetTableColumn.totalLabel]]. If both are set, the calculated value takes precedence.
True if the row containing column totals is visible; False if it is hidden.[[InvalidOperationException]] The value is set to True and the table occupies the last row of the worksheet.
Gets or sets the name of the reference.
See the overview on [[scope]] for details on how to access a named reference by name in formulas.
The name of the reference.[[ArgumentNullException]] The value assigned is null or empty.
[[ArgumentException]] The value assigned is longer than 255 characters.
[[ArgumentException]] The value assigned is not a valid named reference. The name must begin with a letter, underscore (), or a backslash (). All other characters in the name must be letters, numbers, periods, underscores (), or backslashes (). The name cannot be a an A1 cell reference (1 to 3 letters followed by 1 to 6 numbers). In addition, the name cannot be 'r', 'R', 'c', or 'C' or start with a row or column reference in R1C1 cell reference mode ('R' followed by 1 to 6 numbers or 'C' followed by 1 to 6 numbers).
[[InvalidOperationException]] The value assigned is the name of another named reference with the same Scope. Names are compared case-insensitively.
Gets the scope of the named reference.
This can either be the workbook which the named reference belongs to or one of the worksheets in the workbook.
The scope determines how formulas need to preface a name in order to use the named reference.
If the scope is the workbook, formulas in any cell in the workbook can reference the named reference
by specifying just the name or the workbook's file name, an exclamation point, and the name:
When cells in other workbook's want to reference the named reference, they must use the second format
by first specifying the file name when the workbook-scoped named reference exists.
If the scope is a worksheet, formulas in cells of the worksheet can reference the named reference
by specifying just the name. In addition, they can fully qualify the named reference with the worksheet name
and, optionally, the workbook file name:
Formulas in cells of other worksheets in the same workbook can use the named reference as well, but they must
specify the worksheet name and, optionally, the workbook file name:
Formulas in cells of other workbooks can also used the named reference, but they must specify the workbook file
name, worksheet name, and named reference name.
Gets the settings which determine how the data within the table should be sorted.
Note: Sort conditions are not constantly evaluated as data within the table changes. Sort conditions are applied to the table only when they are are added or removed on a column in the table or when the [[reapplySortConditions]] method is called.
Gets or sets the style to use on the [[WorksheetTable]].
The [[WorksheetTableStyle]] defines formats to use in various areas of the table. These formats are used as defaults for cells which don't have their formatting properties already set.
The area formats specified in the WorksheetTableStyle are differential formats. In other words, only the properties that are set to non-default values will be applied to the appropriate cells. An area format can define only a background color or only font information and that format will be applied to the cells while all other formatting properties on the cells will be maintained.
If this value is set to null, the Style will be set to the [[Workbook.defaultTableStyle]].
The [[WorksheetTableStyle]] instance which defines the various default table area formats.[[ArgumentException]] The value specified is not in the [[Workbook.customTableStyles]] or [[Workbook.standardTableStyles]] collections.
Gets the [[WorksheetRegion]] which represents the region of cells in the totals row of the table. A WorksheetRegion which represents the region of cells in the totals row of the table or null if the totals row is not visible.
Gets the [[WorksheetRegion]] which represents the region of cells in the whole table, including the header and totals rows, if visible.
The table region can be changed by using one of the Resize overloads.
Gets the format for the specified area. An [[IWorksheetCellFormat]] instance describing the appearance of the specified area.
[[InvalidEnumArgumentException]] 'area' is not defined.
The area for which to get the format.
Gets the collection of formats used for each area of the [[WorksheetTable]].
The available areas of the table which can have a format set are the whole table, header, data, and totals areas.
Applying a format to an area will apply the format to all cells in that area.
If any area formats on the tables are set when the table is resized to give it more columns, the area formats of the new columns will be initialized with the area formats from the table.
Clears all sort conditions from the columns in the table.
Note: Just as in Microsoft Excel, clearing the sort conditions will not revert the table back to its original unsorted state. The table will remain in its last sorted order.
Gets the [[WorksheetTableColumn]] at the specified index.
[[ArgumentOutOfRangeException]] 'index' is less than 0 or greater than or equal to the number of columns in the collection.
The 0-based index of the column to get.
Gets the [[WorksheetTableColumn]] with the specified name or null if it doesn't exist.
Column names are compared case-insensitively.
[[WorksheetTableColumn.name]]
The name of the column to get.
Gets the collection of columns in the table.
Each column is represented by a [[WorksheetTableColumn]] instance and contains various settings for controlling the contents, formatting, sorting, and filtering of the column.
[[WorksheetTableColumn]]
Deletes one or more columns from the table
[[InvalidOperationException]] If the operation is not allowed, e.g. if it would cause data to be shifted off the worksheet.
[[IndexOutOfRangeException]] If index is negative.
[[ArgumentOutOfRangeException]] If count is less than 1 or greater than or equal all the columns in the table.
The deletion start relative to the first column in the table.
The number of columns to delete.
Deletes one or more data rows from the table
[[InvalidOperationException]] If the operation is not allowed, e.g. if it would cause data to be shifted off the worksheet.
[[IndexOutOfRangeException]] If index is negative.
[[ArgumentOutOfRangeException]] If count is less than 1 or greater than or equal all the rows (excluding header and total rows) in the table.
The deletion start relative to the first row in the [[dataAreaRegion]].
The number of rows to delete.
Inserts one or more columns into the table
[[InvalidOperationException]] If the operation is not allowed, e.g. if it would cause data to be shifted off the worksheet.
[[IndexOutOfRangeException]] If index is negative.
[[ArgumentOutOfRangeException]] If count is less than 1.
The insertion point relative to the first column in the table.
The number of columns to insert
Inserts one or more data rows into the table
[[InvalidOperationException]] If the operation is not allowed, e.g. if it would cause data to be shifted off the worksheet.
[[IndexOutOfRangeException]] If index is negative.
[[ArgumentOutOfRangeException]] If count is less than 1.
The insertion point relative to the first row in the [[dataAreaRegion]].
The number of columns to insert
Re-filters all data cells in the table based on the filters from the columns in the table.
Filters are not constantly evaluated as data within the table changes. Filters are applied to the table only when they are added or removed on a column in the table or when the ReapplyFilters method is called.
If no columns in the table have filters set, this method will not do anything to the data.
Note: When the filters are reevaluated, the rows of any cells which don't meet the filter criteria of their column will be hidden. When a row is filtered out, the entire row is hidden from the worksheet, so any data outside the table but in the same row will also be hidden.
Resizes the table to a new range of data on the worksheet.
If the totals row is visible, it will be placed below the last data row automatically. If the totals row is currently inside the new table region, it will be moved out to below the new data rows, which will be shifted up by one row.
[[InvalidOperationException]] Occurs when the [[WorksheetTable]] has previously been removed from the worksheet.
[[ArgumentNullException]] Occurs when 'headerAndDataRegion' is null.
[[ArgumentException]] Occurs when 'headerAndDataRegion' from a different worksheet or has been previously shifted off the table's worksheet.
[[ArgumentException]] Occurs when the top of the 'headerAndDataRegion' does is not the same as the top of the table.
[[ArgumentException]] Occurs when the 'headerAndDataRegion' does not contain at least one data row for the table.
[[ArgumentException]] Occurs when the 'headerAndDataRegion' does not overlap the current table region.
[[InvalidOperationException]] Occurs when the there is a merged cell, array formula, data table, or another table in the new region.
The new region of headers (if currently visible) and data for the table, which must contain at least one data row, and overlap and have the same top as the current table region.
Resizes the table to a new range of data on the worksheet.
If the totals row is visible, it will be placed below the last data row automatically. If the totals row is currently inside the new table region, it will be moved out to below the new data rows, which will be shifted up by one row.
[[InvalidOperationException]] Occurs when the [[WorksheetTable]] has previously been removed from the worksheet.
[[ArgumentNullException]] Occurs when 'headerAndDataRegionAddress' is null.
[[ArgumentException]] Occurs when 'headerAndDataRegionAddress' is not a valid name or a valid cell or region address in the workbook's cell reference mode.
[[InvalidOperationException]] Occurs when 'headerAndDataRegionAddress' is a relative R1C1 address. The overload taking an origin cell must be used to resolve relative R1C1 references.
[[ArgumentException]] Occurs when the top of the 'headerAndDataRegionAddress' does is not the same as the top of the table.
[[ArgumentException]] Occurs when the 'headerAndDataRegionAddress' does not contain at least one data row for the table.
[[ArgumentException]] Occurs when the 'headerAndDataRegionAddress' does not overlap the current table region.
[[InvalidOperationException]] Occurs when the there is a merged cell, array formula, data table, or another table in the new region.
The address of the new region of headers (if currently visible) and data for the table, which must contain at least one data row, and overlap and have the same top as the current table region.
Resizes the table to a new range of data on the worksheet.
If the totals row is visible, it will be placed below the last data row automatically. If the totals row is currently inside the new table region, it will be moved out to below the new data rows, which will be shifted up by one row.
[[InvalidOperationException]] Occurs when the [[WorksheetTable]] has previously been removed from the worksheet.
[[ArgumentNullException]] Occurs when 'headerAndDataRegionAddress' is null.
[[ArgumentException]] Occurs when 'headerAndDataRegionAddress' is not a valid name or a valid cell or region address in the workbook's cell reference mode.
[[InvalidOperationException]] Occurs when 'headerAndDataRegionAddress' is a relative R1C1 address. The overload taking an origin cell must be used to resolve relative R1C1 references.
[[ArgumentException]] Occurs when the top of the 'headerAndDataRegionAddress' does is not the same as the top of the table.
[[ArgumentException]] Occurs when the 'headerAndDataRegionAddress' does not contain at least one data row for the table.
[[ArgumentException]] Occurs when the 'headerAndDataRegionAddress' does not overlap the current table region.
[[InvalidOperationException]] Occurs when the there is a merged cell, array formula, data table, or another table in the new region.
The address of the new region of headers (if currently visible) and data for the table, which must contain at least one data row, and overlap and have the same top as the current table region.
The cell reference mode to use to parse the region address.
Static compareStatic compareStatic equalsStatic equalsStatic getStatic getStatic getStatic referenceStatic static
Represents a region of cells formatted as a table.
Tables assist in managing and analyzing a range of related data. This management can be done separately from the rest of the data in the worksheet.
A table can have one or more columns sorted and filtered. There are various sorting and filtering criteria that can be applied to the columns. The types pertaining to filtering can be found in the Infragistics.Documents.Excel.Filtering namespace and a filter can be applied to a column by setting the [[WorksheetTableColumn.filter]] property. The types pertaining to sorting can be found in the Infragistics.Documents.Excel.Sorting namespace and a column can be sorted by setting the [[WorksheetTableColumn.sortCondition]] or by populating the [[SortSettings`1.sortConditions]] collection on the [[sortSettings]].
A table can contain calculated columns which dynamically determine their value based on a formula. A [[WorksheetTableColumn]] can be made a calculated column by setting the [[WorksheetTableColumn.columnFormula]].
A table can also contain a totals row which display total information about the table. This can be shown by setting [[isTotalsRowVisible]] to True. When the totals row is displayed, each column can display text or a calculated value in the totals row, by setting either the [[WorksheetTableColumn.totalLabel]] or [[WorksheetTableColumn.totalFormula]], respectively.
See