CustomFilters class

Office 2013 and later

Defines the CustomFilters Class.This class is available in Office2010 or above. When the object is serialized out as xml, its qualified name is x14:customFilters.

Namespace:  DocumentFormat.OpenXml.Office2010.Excel
Assembly:  DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)

C#
VB
C++
Copy
No code example is currently available or this language may not be supported.

2.4.31 customFilters

Target namespace: http://schemas.microsoft.com/office/spreadsheetml/2009/9/main

A customFilters element is a CT_CustomFilters type element, as specified in section 2.6.59, that specifies the properties of custom filters. See section 2.2.4.4, section 2.2.4.9, and section 2.2.4.11 for how this element integrates with the Office Open XML file formats specified in [ISO/IEC-29500-1].

The following W3C XML Schema ([XMLSCHEMA1] section 2.1) fragment specifies the contents of this element.

<xsd:element name="customFilters" type="CT_CustomFilters"/>

See section 5.4 for the full W3C XML Schema ([XMLSCHEMA1] section 2.1).

2.6.59 CT_CustomFilters

Target namespace: http://schemas.microsoft.com/office/spreadsheetml/2009/9/main

Referenced by: customFilters

This complex type specifies custom filter criteria. Rows (2) that contain a cell within the filter range such that the value does not meet the custom filter criteria will be hidden.

Child Elements:

customFilter: A CT_CustomFilter element that specifies a custom filter criterion.

Attributes:

and: A Boolean ([XMLSCHEMA2] section 3.2.2) attribute that specifies the relationship between custom filter criterion. This attribute only applies when there are two criteria.

Value

Meaning

"false"

The two criteria are related by an OR relationship. That is, for a cell value to meet the custom filter criteria, at least one criterion specified by the customFilter child elements MUST be met.

"true"

The two criteria are related by an AND relationship. That is, for a cell value to meet the custom filter criteria, both criteria specified by the customFilter child elements MUST be met.

The following W3C XML Schema ([XMLSCHEMA1] section 2.1) fragment specifies the contents of this complex type.

<xsd:complexType name="CT_CustomFilters">

<xsd:sequence>

<xsd:element name="customFilter" type="CT_CustomFilter" minOccurs="1" maxOccurs="2"/>

</xsd:sequence>

<xsd:attribute name="and" type="xsd:boolean" use="optional" default="false"/>

</xsd:complexType>

See section 5.4 for the full W3C XML Schema ([XMLSCHEMA1] section 2.1).

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: