Share via

3.1.4.13.3.1 AutoFilterItemList

  • Article

Namespace: http://schemas.microsoft.com/office/Excel/Server/WebServices/ExcelServerInternalService/

Specifies the filtering state of an AutoFilter on the protocol server in the GetAutoFilterItemList response (section 3.1.4.13.2.2).

 <xs:complexType name="AutoFilterItemList">
   <xs:sequence>
     <xs:element minOccurs="1" maxOccurs="1" name="ShowTime" type="xs:boolean"/>
     <xs:element minOccurs="1" maxOccurs="1" name="ItemListMaxExceeded" type="xs:boolean"/>
     <xs:element minOccurs="1" maxOccurs="1" name="IsBlanksSelected" type="xs:boolean"/>
     <xs:element minOccurs="1" maxOccurs="1" name="HasBlanks" type="xs:boolean"/>
     <xs:element minOccurs="0" maxOccurs="1" name="AutoFilterDateNodes" type="tns:ArrayOfAutoFilterDateNodeInfo"/>
     <xs:element minOccurs="0" maxOccurs="1" name="AutoFilterItems" type="tns:ArrayOfAutoFilterItem"/>
     <xs:element minOccurs="0" maxOccurs="1" name="SecondValues" type="tns:ArrayOfAnyType"/>
     <xs:element minOccurs="0" maxOccurs="1" name="SecondKeys" type="tns:ArrayOfAnyType"/>
     <xs:element minOccurs="0" maxOccurs="1" name="MinuteValues" type="tns:ArrayOfAnyType"/>
     <xs:element minOccurs="0" maxOccurs="1" name="MinuteKeys" type="tns:ArrayOfAnyType"/>
     <xs:element minOccurs="0" maxOccurs="1" name="HourValues" type="tns:ArrayOfAnyType"/>
     <xs:element minOccurs="0" maxOccurs="1" name="HourKeys" type="tns:ArrayOfAnyType"/>
     <xs:element minOccurs="0" maxOccurs="1" name="DayValues" type="tns:ArrayOfAnyType"/>
     <xs:element minOccurs="0" maxOccurs="1" name="DayKeys" type="tns:ArrayOfAnyType"/>
     <xs:element minOccurs="0" maxOccurs="1" name="MonthValues" type="tns:ArrayOfAnyType"/>
     <xs:element minOccurs="0" maxOccurs="1" name="MonthKeys" type="tns:ArrayOfAnyType"/>
     <xs:element minOccurs="0" maxOccurs="1" name="YearValues" type="tns:ArrayOfAnyType"/>
     <xs:element minOccurs="0" maxOccurs="1" name="YearKeys" type="tns:ArrayOfAnyType"/>
   </xs:sequence>
 </xs:complexType>

ShowTime: Specifies whether the AutoFilter filtering includes hour, minute and seconds. If the value is "true", the following apply:

  • The protocol client MUST ignore the Second, Hour, and Minute elements of the AutoFilterDateNodeInfo elements (section 2.2.4.13) contained in AutoFilterDateNodes element.

  • The protocol client MUST ignore the HourValues, HourKeys, MinuteValues, MinuteKeys, SecondValues, and SecondKeys elements.

ItemListMaxExceeded: Specifies whether the number of filter values and filter date values in the AutoFilter is larger than 1000. The protocol server MUST set the value to "true" if it has more than 1000 elements for both the AutoFilterDateNodes and AutoFilterItems combined.

IsBlanksSelected: Specifies whether the AutoFilter is filtering blank values. The value set to "true" specifies that the AutoFilter filtering includes blank values, the value set to "false" specifies that AutoFilter filtering does not include filtering blank values. MUST be "false" if the value of the HasBlanks element is "false".

HasBlanks: Specifies whether the AutoFilter contains a blank value. The value "true" specifies that blank values exist. The value "false" specifies that there is no blank value.

AutoFilterDateNodes: A list of filter date values as specified in section 2.2.4.3. MUST be present. If the list contains zero elements, the protocol client MUST ignore it. MUST NOT contain more than 1000 AutoFilterDateNodeInfo elements. If the value of ShowTime element is "false", for all elements in the AutoFilterDateNodeInfo element the filter date values for the Hour, Minute, and Second elements of the AutoFilterDateNodeInfo complex type MUST be set to zero. When the protocol client needs to determine the caption for the Year, Month, Day, Hour, Minute or Second elements of AutoFilterDateNodeInfo, it MUST do the following:

  • For the Year element value in AutoFilterDateNodeInfo, determine the element index of a matching value in the YearKeys element and then access the value at the determined index in the YearValues element.

  • For the Month element value in AutoFilterDateNodeInfo, determine the element index of a matching value in the MonthKeys element, and then access the value at the determined index in the MonthValues element.

  • For the Day element value in AutoFilterDateNodeInfo, determine the element index of a matching value in the DayKeys element and then access the value at the determined index in the DayValues element.

  • For the Hour element value in AutoFilterDateNodeInfo, determine the element index of a matching value in the HourKeys element and then access the value at the determined index in the HourValues element.

  • For the Minute element value in AutoFilterDateNodeInfo, determine the element index of a matching value in the MinuteKeys element and then access the value at the determined index in the MinuteValues element.

  • For the Second element value in AutoFilterDateNodeInfo, determine the element index of a matching value in the SecondKeys element and then access the value at the determined index in the SecondValues element.

AutoFilterItems: A list of filter values as specified in AutoFilterDateNodeInfo. MUST be present. If the list contains zero elements, the client protocol MUST ignore it. MUST NOT contain more than the subtraction of the count of AutoFilterDateNodeInfo in the AutoFilterDateNode element from 1000.

SecondValues: A list of captions corresponding to second filter date values. MUST be present. The contained elements MUST be of type s:string. MUST be formatted in the data culture of the session. MUST contain zero elements if the value of ShowTime is "false".

SecondKeys: A sorted list of number values that represent seconds. MUST be present. The contained elements MUST be of type s:short. MUST contain the same number of elements that SecondValues list contains. The elements MUST be sorted by their values in ascending order. MUST NOT contain duplicate values. The index of each contained element in the list MUST match the index of its corresponding display string value element in SecondValues list.

MinuteValues: A list of captions corresponding to minute filter date values. MUST be present. The contained elements MUST be of type s:string. MUST be formatted in the data culture of the session. MUST contain zero elements if the value of ShowTime is "false".

MinuteKeys: A sorted list of number values that represent minutes. MUST be present. The contained elements MUST be of type s:short. MUST contain the same number of elements that MinuteValues list contains. The elements MUST be sorted by their values in ascending order. MUST NOT contain duplicate values. The index of each contained element in the list MUST match the index of its corresponding display string value element in MinuteValues list.

HourValues: A list of captions corresponding to hour filter date values. MUST be present. The contained elements MUST be of type s:string. MUST be formatted in the data culture of the session. MUST contain zero elements if the value of ShowTime is "false".

HourKeys: A sorted list of number values that represent hours. MUST be present. The contained elements MUST be of type s:short. MUST contain the same number of elements that HourValues list contains. The elements MUST be sorted by their values in ascending order. MUST NOT contain duplicate values. The index of each contained element in the list MUST match the index of its corresponding display string value element in HourValues list.

DayValues: A list of captions corresponding to day filter date values. MUST be present. The contained elements MUST be of type s:string. MUST be formatted in the data culture of the session.

DayKeys: A sorted list of number values that represent days. MUST be present. The contained elements MUST be of type s:short. MUST contain the same number of elements that DayValues list contains. The elements MUST be sorted by their values in ascending order. MUST NOT contain duplicate values. The index of each contained element in the list MUST match the index of its corresponding display string value element in DayValues list.

MonthValues: A list of captions corresponding to month filter date values. MUST be present. The contained elements MUST be of type s:string. MUST be formatted in the data culture of the session.

MonthKeys: A sorted list of number values that represent months. MUST be present. The contained elements MUST be of type s:short. MUST contain the same number of elements that MonthValues list contains. The elements MUST be sorted by their values in ascending order. MUST NOT contain duplicate values.

The index of each contained element in the list MUST match the index of its corresponding display string value element in MonthValues list.

YearValues: A list of caption corresponding to year filter date values. MUST be present. The contained elements MUST be of type s:string. MUST be formatted in the data culture of the session.

YearKeys: A sorted list of number values that represent years. MUST be present. The contained elements MUST be of type s:short. MUST contain the same number of elements that YearValues list contains. The elements MUST be sorted by their values in ascending order. MUST NOT contain duplicate values. The index of each contained element in the list MUST match the index of its corresponding display string value element in YearValues list.