Static $tStatic nextGets the formula associated with the data area of the column.
When the column formula is set and the table is resized to give it more rows, the new cells in the column will have the column formula applied to them.
A [[Formula]] instance representing the formula for the data area of the column or null if no formula is applied.[[setColumnFormula]]
Gets the [[WorksheetRegion]] which represents the region of cells in the data area of the column.
Gets the filter applied to the column.
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 [[WorksheetTable.reapplyFilters]] method is called.
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.
A [[filter]]-derived instance if a filter is applied or null if the column is not filtered.Gets the [[WorksheetCell]] which represents the header cell for the column. A WorksheetCell which represents the header cell for the column or null if the header row is not visible in the table.
[[WorksheetTable.isHeaderRowVisible]]
Gets the 0-based index of the column in the owning [[WorksheetTable.columns]] collection. The 0-based index of the column in its collection or -1 if the column has been removed from the table.
[[WorksheetTable.columns]]
Gets or sets the name of the column.
If the header row is visible in the [[WorksheetTable]], the name of the column will be displayed in the cell of the column in the header row.
When the WorksheetTable is created, the column names will be taken from the cells in the header row. If the table does not contain a header row, the column names will be generated.
The column names are unique within the owning WorksheetTable. If, when the table is created, there are two or more columns with the same name, the second and subsequent duplicate column names will have a number appended to make them unique. If any cells in the header row have a non-string value, their value will be changed to a string (the current display text of the cell). If any cells in the header row have no value, they will be given a generated column name.
If the Name property is set to a null or empty string, a column name will be generated. If the value is set to a column name which already exists in the table, the column with the higher index will have a number appended to its name so all column names can stay unique.
The unique name of the column within the owning WorksheetTable.[[InvalidOperationException]] From the setter if column was removed from the table.
[[WorksheetTable.isHeaderRowVisible]]
Gets or sets the sort condition used to sort the column in the table.
When a sort condition is set on the column, the SortConditions collection on the [[WorksheetTable.sortSettings]] will be cleared and the new sort condition will be added. To sort by multiple columns, the sort conditions must be added to the SortConditions collection instead of set on the column. However, if a sort condition is cleared with this property, just the sort condition for the column will be removed from the SortConditions collection. All other SortConditions will remain in the collection.
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 [[WorksheetTable.reapplySortConditions]] method is called.
The [[sortCondition]]-derived instance used to sort the column or null of the column is not sorted.[[InvalidOperationException]] From the setter if column was removed from the table.
1.sortConditions]] @see [[SortConditionCollection1]]Gets the [[WorksheetTable]] to which the column belongs. The WorksheetTable to which the column belongs or null if the column has been removed from the table.
Gets the [[WorksheetCell]] which represents the total cell for the column. A WorksheetCell which represents the total cell for the column or null if the totals row is not visible in the table.
[[WorksheetTable.isTotalsRowVisible]]
Gets or sets the formula to use in the total cell of the column.
The total formula can be set regardless of whether or not the totals row is visible. If the totals row is hidden, the formula will not be applied anywhere. When the totals row is visible, it will be applied to the total cell of the column.
Setting the TotalFormula to a non-null value will clear the [[totalLabel]], and vice versa.
[[ArgumentException]] The value is already applied to something else, such as a cell or table column.
[[InvalidOperationException]] From the setter if column was removed from the table.
Gets or sets the text label to use in the total cell of the column.
The total label can be set regardless of whether or not the totals row is visible. If the totals row is hidden, the label will not be displayed anywhere. When the totals row is visible, it will be set as the value of the total cell of the column.
Setting the [[totalFormula]] to a non-null value will clear the TotalLabel, and vice versa.
[[InvalidOperationException]] From the setter if column was removed from the table.
Gets the [[WorksheetRegion]] which represents the region of cells in the whole column, including the header and total cells, if visible.
Applies an [[AverageFilter]] to the column.
[[InvalidEnumArgumentException]] 'type' is not defined in the [[AverageFilterType]] enumeration.
[[InvalidOperationException]] The [[WorksheetTable.isFilterUIVisible]] value of the owning table is False. Filters cannot be applied when the header row or filter button is hidden.
[[InvalidOperationException]] If column was removed from the table.
The value indicating whether to filter in values below or above the average of the data range.
Applies a [[CustomFilter]] to the column.
Note: If the filter condition value is longer than 255 characters in length and the workbook is saved in one of the 2003 formats, the correct rows will be hidden in the saved file, but the filter will be missing from the column.
[[ArgumentNullException]] 'condition' is null.
[[InvalidOperationException]] The [[WorksheetTable.isFilterUIVisible]] value of the owning table is False. Filters cannot be applied when the header row or filter button is hidden.
[[InvalidOperationException]] If column was removed from the table.
The condition which must pass for the data to be filtered in.
Applies a [[CustomFilter]] to the column.
If 'condition2' is null, the 'conditionalOperator' value is irrelevant.
Note: If one of the filter condition values is longer than 255 characters in length and the workbook is saved in one of the 2003 formats, the correct rows will be hidden in the saved file, but the filter will be missing from the column.
[[ArgumentNullException]] 'condition1' is null.
[[InvalidEnumArgumentException]] 'conditionalOperator' is not defined in the [[ConditionalOperator]] enumeration.
[[InvalidOperationException]] The [[WorksheetTable.isFilterUIVisible]] value of the owning table is False. Filters cannot be applied when the header row or filter button is hidden.
The first condition used to filter the data.
The second condition used to filter the data.
The operator which defines how to logically combine 'condition1' and 'condition2'.
Applies an [[DatePeriodFilter]] to the column.
If the 'type' is Month, a 'value' of 1 indicates January, 2 indicates February, and so on. If type is Quarter, a value of 1 indicates Quarter 1, and so on.
[[InvalidEnumArgumentException]] 'type' is not defined in the [[DatePeriodFilterType]] enumeration.
[[ArgumentException]] 'type' is Quarter and 'value' is less than 1 or greater than 4 or type is Month and value is less than 1 or greater than 12.
[[InvalidOperationException]] The [[WorksheetTable.isFilterUIVisible]] value of the owning table is False. Filters cannot be applied when the header row or filter button is hidden.
[[InvalidOperationException]] If column was removed from the table.
The type of date period to filter in.
The 1-based value of the month or quarter to filter in.
Applies a [[FillFilter]] to the column.
[[ArgumentNullException]] 'fill' is null.
[[InvalidOperationException]] The [[WorksheetTable.isFilterUIVisible]] value of the owning table is False. Filters cannot be applied when the header row or filter button is hidden.
[[InvalidOperationException]] If column was removed from the table.
A [[CellFill]] by which the cells should be filtered.
Applies a [[FixedValuesFilter]] to the column.
[[ArgumentNullException]] 'dateGroups' is null.
[[InvalidEnumArgumentException]] 'calendarType' is not defined in the [[CalendarType]] enumeration.
[[ArgumentNullException]] A FixedDateGroup in the 'dateGroups' collection is null.
[[ArgumentException]] Multiple items in 'dateGroups' are equal to each other.
[[InvalidOperationException]] 'includeBlanks' is False and 'dateGroups' has no items. At least one value must be allowed.
[[InvalidOperationException]] The [[WorksheetTable.isFilterUIVisible]] value of the owning table is False. Filters cannot be applied when the header row or filter button is hidden.
The value which indicates whether blank cells should be filtered in.
The calendar type used to interpret values in the 'dateGroups' collection.
The collection of fixed date groups which should be filtered in.
Applies a [[FontColorFilter]] to the column.
[[ArgumentNullException]] 'fontColorInfo' is null.
[[InvalidOperationException]] The [[WorksheetTable.isFilterUIVisible]] value of the owning table is False. Filters cannot be applied when the header row or filter button is hidden.
A [[WorkbookColorInfo]] which describes the font color by which the cells should be filtered.
Applies a [[FontColorFilter]] to the column.
[[ArgumentNullException]] 'fontColor' is empty.
[[InvalidOperationException]] The [[WorksheetTable.isFilterUIVisible]] value of the owning table is False. Filters cannot be applied when the header row or filter button is hidden.
[[InvalidOperationException]] If column was removed from the table.
The font color by which the cells should be filtered.
Applies a [[IconFilter]] to the column.
[[ArgumentException]] If the icon set is not valid.
[[ArgumentOutOfRangeException]] If the index is less than zero or greater than or equal to the number of icons in the icon set..
[[InvalidOperationException]] The [[WorksheetTable.isFilterUIVisible]] value of the owning table is False. Filters cannot be applied when the header row or filter button is hidden.
[[InvalidOperationException]] If column was removed from the table.
[[InvalidEnumArgumentException]] 'iconSet' is not defined in the [[FormatConditionIconSet]] enumeration.
The icon set containing the icon.
The zero-based index of the icon in the set or null for 'NoCellIcon'.
Applies a [[RelativeDateRangeFilter]] to the column.
The RelativeDateRangeFilter allows you to filter in dates which are in the previous, current, or next time period relative to the date when the filter was applied. The time periods available are day, week, month, quarter, year. So when using the previous filter type with a day duration, a 'yesterday' filter is created. Or when using a current filter type with a year duration, a 'this year' filter is created. However, these filters compare the data against the date when the filter was created. So a 'this year' filter created in 1999 will filter in all cells containing dates in 1999, even if the workbook is opened in 2012.
[[InvalidEnumArgumentException]] 'offset' is not defined in the [[RelativeDateRangeOffset]] enumeration.
[[InvalidEnumArgumentException]] 'duration' is not defined in the [[RelativeDateRangeDuration]] enumeration.
[[InvalidOperationException]] The [[WorksheetTable.isFilterUIVisible]] value of the owning table is False. Filters cannot be applied when the header row or filter button is hidden.
[[InvalidOperationException]] If column was removed from the table.
The offset of relative filter. This combined with the 'duration' determines the full range of accepted dates.
The duration of the full range of accepted dates.
Applies a [[TopOrBottomFilter]] to the column which will filter in the top 10 values in the list of sorted values.
[[InvalidOperationException]] The [[WorksheetTable.isFilterUIVisible]] value of the owning table is False. Filters cannot be applied when the header row or filter button is hidden.
[[InvalidOperationException]] If column was removed from the table.
Applies a [[TopOrBottomFilter]] to the column.
[[InvalidEnumArgumentException]] 'type' is not defined in the [[TopOrBottomFilterType]] enumeration.
[[ArgumentOutOfRangeException]] 'value' is less than 1 or greater than 500.
[[InvalidOperationException]] The [[WorksheetTable.isFilterUIVisible]] value of the owning table is False. Filters cannot be applied when the header row or filter button is hidden.
The type of the filter.
The number or percentage of value of values which should be filtered in.
Applies a [[YearToDateFilter]] to the column.
[[InvalidOperationException]] The [[WorksheetTable.isFilterUIVisible]] value of the owning table is False. Filters cannot be applied when the header row or filter button is hidden.
[[InvalidOperationException]] If column was removed from the table.
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 column.
The available areas of the column which can have a format set are the 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 columns are set when the table is resized to give it more rows, the new cells in the column will get the new format applied.
Removes the filter from the column if one is applied.
[[InvalidOperationException]] If column was removed from the table.
Sets the formula to use in the data cells in the column.
If any relative cell or region references are in the specified formula, it will be assumed that the actual formula is being applied to the first data cell in the column. When the formula is applied to other cells in the column, the relative references will be offset by the appropriate amount.
When the column formula is set and the table is resized to give it more rows, the new cells in the column will have the column formula applied to them.
If there was a different column formula applied previously and it was applied to any of the cells in the column, setting it to a different formula will overwrite the formulas on those cells, regardless of the value of 'overwriteExistingValues'.
[[ArgumentException]]
[[InvalidOperationException]] If column was removed from the table. 'formula' is already applied to something else, such as a cell or table column.
[[columnFormula]]
The formula for the data cells of the column or null to remove the current column formula.
True to overwrite the existing cells values and apply the formula to all data cells in the column. False to only apply the formula to the cells with no value set.
Static compareStatic compareStatic equalsStatic equalsStatic getStatic getStatic getStatic reference
Represents a column in a [[WorksheetTable]].
Each column contains various settings for controlling the contents, formatting, sorting, and filtering within it.