FilterColumn class

Office 2013 and later

AutoFilter Column. When the object is serialized out as xml, its qualified name is x:filterColumn.

Namespace:  DocumentFormat.OpenXml.Spreadsheet
Assembly:  DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)

[ChildElementInfoAttribute(typeof(CustomFilters))]
[ChildElementInfoAttribute(typeof(Filters))]
[ChildElementInfoAttribute(typeof(Top10))]
[ChildElementInfoAttribute(typeof(CustomFilters), FileFormatVersions.None|FileFormatVersions.Office2010|FileFormatVersions.Office2013)]
[ChildElementInfoAttribute(typeof(ColorFilter))]
[ChildElementInfoAttribute(typeof(DynamicFilter))]
[ChildElementInfoAttribute(typeof(IconFilter), FileFormatVersions.None|FileFormatVersions.Office2010|FileFormatVersions.Office2013)]
[ChildElementInfoAttribute(typeof(IconFilter))]
[ChildElementInfoAttribute(typeof(ExtensionList))]
public class FilterColumn : OpenXmlCompositeElement

[ISO/IEC 29500-1 1st Edition]

filterColumn (AutoFilter Column)

The filterColumn collection identifies a particular column in the AutoFilter range and specifies filter information that has been applied to this column. If a column in the AutoFilter range has no criteria specified, then there is no corresponding filterColumn collection expressed for that column.

Parent Elements

autoFilter (§18.3.1.2)

Child Elements

Subclause

colorFilter (Color Filter Criteria)

§18.3.2.1

customFilters (Custom Filters)

§18.3.2.3

dynamicFilter (Dynamic Filter)

§18.3.2.5

extLst (Future Feature Data Storage Area)

§18.2.10

filters (Filter Criteria)

§18.3.2.8

iconFilter (Icon Filter)

§18.3.2.9

top10 (Top 10)

§18.3.2.10

Attributes

Description

colId (Filter Column Data)

Zero-based index indicating the AutoFilter column to which this filter information applies.

The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.

hiddenButton (Hidden AutoFilter Button)

Flag indicating whether the AutoFilter button for this column is hidden.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

showButton (Show Filter Button)

Flag indicating whether the filter button is visible. [Example: When the cell containing the filter button is merged with another cell, the filter button can be hidden, and not drawn. end example]

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

[Note: The W3C XML Schema definition of this element’s content model (CT_FilterColumn) is located in §A.2. end note]

© ISO/IEC29500: 2008.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show: