Partager via


Filters Class

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

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlCompositeElement
      DocumentFormat.OpenXml.Spreadsheet.Filters

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

Syntax

'Declaration
<ChildElementInfoAttribute(GetType(DateGroupItem))> _
<ChildElementInfoAttribute(GetType(Filter), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(Filter))> _
Public Class Filters _
    Inherits OpenXmlCompositeElement
'Usage
Dim instance As Filters
[ChildElementInfoAttribute(typeof(DateGroupItem))]
[ChildElementInfoAttribute(typeof(Filter), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(Filter))]
public class Filters : OpenXmlCompositeElement

Remarks

The following table lists the possible child types:

[ISO/IEC 29500-1 1st Edition]

  • DocumentFormat.OpenXml.Office2010.Excel.Filter <x14:filter>

  • Filter <x:filter>

  • DateGroupItem <x:dateGroupItem>

18.3.2.8 filters (Filter Criteria)

When multiple values are chosen to filter by, or when a group of date values are chosen to filter by, this element groups those criteria together.

[Example:

<filters>
<dateGroupItem year="2006" month="1" day="2" dateTimeGrouping="day"/>
<dateGroupItem year="2005" month="1" day="2" dateTimeGrouping="day"/>
</filters>

end example]

Parent Elements

filterColumn (§18.3.2.7)

Child Elements

Subclause

dateGroupItem (Date Grouping)

§18.3.2.4

filter (Filter)

§18.3.2.6

Attributes

Description

blank (Filter by Blank)

Flag indicating whether to filter by blank.

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

calendarType (Calendar Type)

Calendar type for date grouped items. Used to interpret the values in dateGroupItem. This is the calendar type used to evaluate all dates in the filter column, even when those dates are not using the same calendar system / date formatting.

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

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

© ISO/IEC29500: 2008.

Thread Safety

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

See Also

Reference

Filters Members

DocumentFormat.OpenXml.Spreadsheet Namespace