Represents a column in a .
Inheritance
object
Implements
- ISortable
Properties
Section titled "Properties"AreaFormats
Section titled "AreaFormats"Gets the collection of formats used for each area of the column.
public WorksheetTableAreaFormatsCollection<WorksheetTableColumnArea> AreaFormats { get; }ColumnFormula
Section titled "ColumnFormula"Gets the formula associated with the data area of the column.
public Formula ColumnFormula { get; }DataAreaRegion
Section titled "DataAreaRegion"Gets the which represents the region of cells in the data area of the column.
public WorksheetRegion DataAreaRegion { get; }Filter
Section titled "Filter"Gets the filter applied to the column.
public Filter Filter { get; }HeaderCell
Section titled "HeaderCell"Gets the which represents the header cell for the column.
public WorksheetCell HeaderCell { get; }Index
Section titled "Index"Gets the 0-based index of the column in the owning collection.
public int Index { get; }Gets or sets the name of the column.
public string Name { get; set; }SortCondition
Section titled "SortCondition"Gets or sets the sort condition used to sort the column in the table.
public SortCondition SortCondition { get; set; }Table
Section titled "Table"Gets the to which the column belongs.
public WorksheetTable Table { get; }TotalCell
Section titled "TotalCell"Gets the which represents the total cell for the column.
public WorksheetCell TotalCell { get; }TotalFormula
Section titled "TotalFormula"Gets or sets the formula to use in the total cell of the column.
public Formula TotalFormula { get; set; }TotalLabel
Section titled "TotalLabel"Gets or sets the text label to use in the total cell of the column.
public string TotalLabel { get; set; }WholeColumnRegion
Section titled "WholeColumnRegion"Gets the which represents the region of cells in the whole column, including the header and total cells, if visible.
public WorksheetRegion WholeColumnRegion { get; }Methods
Section titled "Methods"ApplyAverageFilter(AverageFilterType)
Section titled "ApplyAverageFilter(AverageFilterType)"Applies an to the column.
public AverageFilter ApplyAverageFilter(AverageFilterType type)Parameters
- type:
AverageFilterType
Returns any
ApplyCustomFilter(CustomFilterCondition)
Section titled "ApplyCustomFilter(CustomFilterCondition)"Applies a to the column.
public CustomFilter ApplyCustomFilter(CustomFilterCondition condition)Parameters
- condition:
CustomFilterCondition
Returns any
ApplyCustomFilter(CustomFilterCondition, CustomFilterCondition, ConditionalOperator)
Section titled "ApplyCustomFilter(CustomFilterCondition, CustomFilterCondition, ConditionalOperator)"Applies a to the column.
public CustomFilter ApplyCustomFilter(CustomFilterCondition condition1, CustomFilterCondition condition2, ConditionalOperator conditionalOperator)Parameters
- condition1:
CustomFilterCondition - condition2:
CustomFilterCondition - conditionalOperator:
ConditionalOperator
Returns any
ApplyDatePeriodFilter(DatePeriodFilterType, int)
Section titled "ApplyDatePeriodFilter(DatePeriodFilterType, int)"Applies an to the column.
public DatePeriodFilter ApplyDatePeriodFilter(DatePeriodFilterType type, int value)Parameters
- type:
DatePeriodFilterType - value:
int
Returns any
ApplyFillFilter(CellFill)
Section titled "ApplyFillFilter(CellFill)"Applies a to the column.
public FillFilter ApplyFillFilter(CellFill fill)Parameters
- fill:
CellFill
Returns any
ApplyFixedValuesFilter(bool, CalendarType, params FixedDateGroup[])
Section titled "ApplyFixedValuesFilter(bool, CalendarType, params FixedDateGroup[])"Applies a to the column.
public FixedValuesFilter ApplyFixedValuesFilter(bool includeBlanks, CalendarType calendarType, params FixedDateGroup[] dateGroups)Parameters
- includeBlanks:
bool - calendarType:
CalendarType - dateGroups:
FixedDateGroup[]
Returns any
ApplyFixedValuesFilter(bool, CalendarType, IEnumerable<FixedDateGroup>)
Section titled "ApplyFixedValuesFilter(bool, CalendarType, IEnumerable<FixedDateGroup>)"Applies a to the column.
public FixedValuesFilter ApplyFixedValuesFilter(bool includeBlanks, CalendarType calendarType, IEnumerable<FixedDateGroup> dateGroups)Parameters
- includeBlanks:
bool - calendarType:
CalendarType - dateGroups:
IEnumerable
Returns any
ApplyFixedValuesFilter(bool, IEnumerable<FixedDateGroup>)
Section titled "ApplyFixedValuesFilter(bool, IEnumerable<FixedDateGroup>)"Applies a to the column.
public FixedValuesFilter ApplyFixedValuesFilter(bool includeBlanks, IEnumerable<FixedDateGroup> dateGroups)Parameters
- includeBlanks:
bool - dateGroups:
IEnumerable
Returns any
ApplyFixedValuesFilter(bool, IEnumerable<string>)
Section titled "ApplyFixedValuesFilter(bool, IEnumerable<string>)"Applies a to the column.
public FixedValuesFilter ApplyFixedValuesFilter(bool includeBlanks, IEnumerable<string> displayValues)Parameters
- includeBlanks:
bool - displayValues:
IEnumerable
Returns any
ApplyFixedValuesFilter(bool, params string[])
Section titled "ApplyFixedValuesFilter(bool, params string[])"Applies a to the column.
public FixedValuesFilter ApplyFixedValuesFilter(bool includeBlanks, params string[] displayValues)Parameters
- includeBlanks:
bool - displayValues:
string[]
Returns any
ApplyFontColorFilter(Color)
Section titled "ApplyFontColorFilter(Color)"Applies a to the column.
public FontColorFilter ApplyFontColorFilter(Color fontColor)Parameters
- fontColor:
Color
Returns any
ApplyFontColorFilter(WorkbookColorInfo)
Section titled "ApplyFontColorFilter(WorkbookColorInfo)"Applies a to the column.
public FontColorFilter ApplyFontColorFilter(WorkbookColorInfo fontColorInfo)Parameters
- fontColorInfo:
WorkbookColorInfo
Returns any
ApplyIconFilter(FormatConditionIconSet, int?)
Section titled "ApplyIconFilter(FormatConditionIconSet, int?)"Applies a to the column.
public IconFilter ApplyIconFilter(FormatConditionIconSet iconSet, int? iconIndex)Parameters
- iconSet:
FormatConditionIconSet - iconIndex:
int?
Returns any
ApplyRelativeDateRangeFilter(RelativeDateRangeOffset, RelativeDateRangeDuration)
Section titled "ApplyRelativeDateRangeFilter(RelativeDateRangeOffset, RelativeDateRangeDuration)"Applies a to the column.
public RelativeDateRangeFilter ApplyRelativeDateRangeFilter(RelativeDateRangeOffset offset, RelativeDateRangeDuration duration)Parameters
- offset:
RelativeDateRangeOffset - duration:
RelativeDateRangeDuration
Returns any
ApplyTopOrBottomFilter()
Section titled "ApplyTopOrBottomFilter()"Applies a to the column which will filter in the top 10 values in the list of sorted values.
public TopOrBottomFilter ApplyTopOrBottomFilter()Returns any
ApplyTopOrBottomFilter(TopOrBottomFilterType, int)
Section titled "ApplyTopOrBottomFilter(TopOrBottomFilterType, int)"Applies a to the column.
public TopOrBottomFilter ApplyTopOrBottomFilter(TopOrBottomFilterType type, int value)Parameters
- type:
TopOrBottomFilterType - value:
int
Returns any
ApplyYearToDateFilter()
Section titled "ApplyYearToDateFilter()"Applies a to the column.
public YearToDateFilter ApplyYearToDateFilter()Returns any
ClearFilter()
Section titled "ClearFilter()"Removes the filter from the column if one is applied.
public void ClearFilter()Returns any
SetColumnFormula(Formula, bool)
Section titled "SetColumnFormula(Formula, bool)"Sets the formula to use in the data cells in the column.
public void SetColumnFormula(Formula formula, bool overwriteExistingValues)Parameters
- formula:
Formula - overwriteExistingValues:
bool