2.3.18 CT_item

  • Article

Referenced by: CT_autofilter

An AutoFilter item in an AutoFilter.

Child Elements:

Criteria: The rule defined in a custom filter. This element MUST be present if a custom filter is applied to the AutoFilter item and MUST NOT be present otherwise. If the custom filter contains two rules, then there MUST be two CT_Criteria elements present; if the custom filter contains a single rule, then there MUST be one CT_Criteria element present.

top10: This element holds information pertaining to the top N filter or bottom N filter applied to a CT_item. This element MUST be present if the Top10 attribute (2) is true and it MUST NOT be present otherwise.

Attributes:

Index: The column (2) number on which the AutoFilter item exists.

Name: The name of the AutoFilter item in the AutoFilter. Its value MUST be equal to the value of the CT_Data element nested under the CT_Cell element that represent the worksheet cell on which the AutoFilter item is present.

Top10: Specifies whether a top N filter is applied to the AutoFilter item. This attribute (2) MUST NOT be true if the Custom attribute (2) is true, or the Filter attribute (2) is true or the CriteriaType attribute (2) is present. This attribute (2) MUST be present and set to true when a top N filter is applied to the AutoFilter item.

Type: This attribute (2) denotes the type of sorting or filtering applied to the AutoFilter item.

CriteriaType: A specific date or number filter that is applied to the AutoFilter item. This attribute (2) MUST NOT be present if the Top10 attribute (2) is true, or the Filter attribute (2) is true or the Custom attribute (2) is true.

DataType: The type of data in the underlying worksheet cells of the AutoFilter item.

Filter: Specifies whether a manual filter is applied to the AutoFilter item. This attribute (2) MUST be present and set to true when a manual filter is applied to the AutoFilter item. This attribute (2) MUST NOT be true if the Top10 attribute (2) is true or the Custom attribute (2) is true or the CriteriaType attribute (2) is present.

Custom: Specifies whether a filter that is not supported on the protocol server is applied to the AutoFilter item. This attribute (2) MUST be present and set to true when the AutoFilter item has a filter that is not supported on the protocol server applied to it. This attribute (2) MUST NOT be true if the Top10 attribute (2) is true or the Filter attribute (2) is true or the CriteriaType attribute (2) is present.

Hidden: Specifies whether filter drop down for this item is hidden.

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

 <xs:complexType name="CT_item">
   <xs:sequence>
     <xs:element name="Criteria" minOccurs="0" maxOccurs="2" type="CT_Criteria"/>
     <xs:element name="top10" minOccurs="0" maxOccurs="1" type="CT_top10"/>
   </xs:sequence>
   <xs:attribute name="Index" type="ST_excelColNumber" default="0" use="optional"/>
   <xs:attribute name="Name" type="xs:string" use="optional"/>
   <xs:attribute name="Top10" type="xs:boolean" default="false" use="optional"/>
   <xs:attribute name="Type" type="ST_enmFilterItemType" default="None" use="optional"/>
   <xs:attribute name="CriteriaType" type="ST_enmAutoFilterItemCriteriaType" default="Nil" use="optional"/>
   <xs:attribute name="DataType" type="ST_enmAutoFilterItemType" default="Number" use="optional"/>
   <xs:attribute name="Filter" type="xs:boolean" default="false" use="optional"/>
   <xs:attribute name="Custom" type="xs:boolean" default="false" use="optional"/>
   <xs:attribute name="Hidden" type="xs:boolean" default="false" use="optional"/>
 </xs:complexType>

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