Partager via


IconFilter Class

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

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlLeafElement
      DocumentFormat.OpenXml.Office2010.Excel.IconFilter

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

Syntax

'Declaration
<OfficeAvailabilityAttribute(FileFormatVersions.Office2010)> _
Public Class IconFilter _
    Inherits OpenXmlLeafElement
'Usage
Dim instance As IconFilter
[OfficeAvailabilityAttribute(FileFormatVersions.Office2010)]
public class IconFilter : OpenXmlLeafElement

Remarks

2.4.27 iconFilter

Target namespace: https://schemas.microsoft.com/office/spreadsheetml/2010/main

A CT_IconFilter element that specifies the properties of an icon filter. See Pivot Table, Table Definition, and Worksheet under Extensions by Part for how this element integrates with [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.3 for the full W3C XML Schema ([XMLSCHEMA1] section 2.1).

2.6.57 CT_IconFilter

Target namespace: https://schemas.microsoft.com/office/spreadsheetml/2010/main

Referenced by: iconFilter

This complex type specifies the icon set and particular icon within that set to filter by. Rows 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”, then this value MUST be greater than or equal to 0. If the icon set specified by iconSet has 3 icons, this value MUST be less than or equal to 2. If the icon set specified by iconSet has 4 icons, this value MUST be less than or equal to 3. If the icon set specified by iconSet has 5 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.3 for the full W3C XML Schema ([XMLSCHEMA1] section 2.1).

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

IconFilter Members

DocumentFormat.OpenXml.Office2010.Excel Namespace