IconFilter class

Office 2013 and later

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

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.29 iconFilter

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

An iconFilter element is a CT_IconFilter type element, as specified in section 2.6.57, that specifies the properties of an icon 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="iconFilter" type="CT_IconFilter"/>

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

2.6.57 CT_IconFilter

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

Referenced by: iconFilter

This complex type specifies the icon set and particular icon within that set to filter by. Rows (2) with a cell icon that do not match these criteria will be hidden when the filter is applied.

Attributes:

iconSet: An ST_IconSetType attribute that specifies the icon set used as the filter criteria.

iconId: An unsignedInt ([XMLSCHEMA2] section 3.3.22) attribute that specifies the index of the icon to be used as filter criteria. If iconSet is "NoIcons", this value MUST be -1 and this record does not specify a filter and MUST be ignored. If iconSet is not "NoIcons", this value MUST be greater than or equal to 0. If the icon set specified by iconSet has three icons, this value MUST be less than or equal to 2. If the icon set specified by iconSet has four icons, this value MUST be less than or equal to 3. If the icon set specified by iconSet has five icons, this value MUST be less than or equal to 4.

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

<xsd:complexType name="CT_IconFilter">

<xsd:attribute name="iconSet" type="ST_IconSetType" use="required"/>

<xsd:attribute name="iconId" type="xsd:unsignedInt" use="required"/>

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