AutoFilter Class

Office 2010

Auto Filter.When the object is serialized out as xml, its qualified name is x:autoFilter.

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

[ChildElementInfoAttribute(typeof(FilterColumn))]
[ChildElementInfoAttribute(typeof(ExtensionList))]
[ChildElementInfoAttribute(typeof(SortState))]
public class AutoFilter : OpenXmlCompositeElement

The following table lists the possible child types:

  • FilterColumn <x:filterColumn>

  • SortState <x:sortState>

  • ExtensionList <x:extLst>


[ISO/IEC 29500-1 1st Edition]

18.3.1.2 autoFilter (AutoFilter Settings)

AutoFilter temporarily hides rows based on a filter criteria, which is applied column by column to a table of data in the worksheet. This collection expresses AutoFilter settings.

[Example:This example expresses a filter indicating to 'show only values greater than 0.5'. The filter is being applied to the range B3:E8, and the criteria is being applied to values in the column whose colId='1' (zero based column numbering, from left to right). Therefore any rows must be hidden if the value in that particular column is less than or equal to 0.5.


<autoFilter ref="B3:E8">
<filterColumn colId="1">
<customFilters>
<customFilter operator="greaterThan" val="0.5"/>
</customFilters>
</filterColumn>
</autoFilter>

end example]

Parent Elements

customSheetView (§18.3.1.25); filter (§18.10.1.33); table (§18.5.1.2); worksheet (§18.3.1.99)

Child Elements

Subclause

extLst (Future Feature Data Storage Area)

§18.2.10

filterColumn (AutoFilter Column)

§18.3.2.7

sortState (Sort State)

§18.3.1.92

Attributes

Description

ref (Cell or Range Reference)

Reference to the cell range to which the AutoFilter is applied.

The possible values for this attribute are defined by the ST_Ref simple type (§18.18.62).

[Note: The W3C XML Schema definition of this element’s content model (CT_AutoFilter) 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.

Community Additions

ADD
Show:
© 2014 Microsoft