Filter class

Office 2013 and later

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

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

[OfficeAvailabilityAttribute(FileFormatVersions.Office2010)]
public class Filter : OpenXmlLeafElement

2.4.30 filter

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

A filter element is a CT_Filter type element, as specified in section 2.6.58, that specifies the properties of a filter. 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="filter" type="CT_Filter"/>

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

2.6.58 CT_Filter

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

Referenced by: filter

This complex type specifies a filter criterion. Rows (2) that contain a cell within the filter range that have value val will not be hidden by this filter criteria. Rows (2) that do not contain such a cell inside a filters element ([ISO/IEC-29500-1] section 18.3.2.8) will be hidden.

Attributes:

val: An ST_Xstring ([ISO/IEC-29500-1] section 22.9.2.19) attribute that specifies the value to be used as a filter criterion. The length of this value MUST be less than 65536 characters.

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

<xsd:complexType name="CT_Filter">

<xsd:attribute name="val" type="x:ST_Xstring"/>

</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: