3.1.4.13 GetAutoFilterItemList

  • Article

This operation is used to retrieve the filter values and filter date values and their captions in the AutoFilterItemList (section 3.1.4.13.3.1) in the operation response for an AutoFilter in the workbook.

The following is the WSDL port type specification of the GetAutoFilterItemList WSDL operation.

 <wsdl:operation name="GetAutoFilterItemList" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">
   <wsdl:input wsaw:Action="http://schemas.microsoft.com/office/Excel/Server/WebServices/ExcelServerInternalService/ExcelServiceSoap/GetAutoFilterItemList" message="tns:ExcelServiceSoap_GetAutoFilterItemList_InputMessage" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"/>
   <wsdl:output wsaw:Action="http://schemas.microsoft.com/office/Excel/Server/WebServices/ExcelServerInternalService/ExcelServiceSoap/GetAutoFilterItemListResponse" message="tns:ExcelServiceSoap_GetAutoFilterItemList_OutputMessage" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"/>
   <wsdl:fault wsaw:Action="http://schemas.microsoft.com/office/Excel/Server/WebServices/ExcelServerInternalService/ExcelServiceSoap/GetAutoFilterItemListExcelServerMessageFault" name="ExcelServerMessageFault" message="tns:ExcelServiceSoap_GetAutoFilterItemList_ExcelServerMessageFault_FaultMessage" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"/>
 </wsdl:operation>

The protocol client sends an ExcelServiceSoap_GetAutoFilterItemList_InputMessage request message, and the protocol server responds with an ExcelServiceSoap_GetAutoFilterItemList_OutputMessage response message, as follows:

  • The protocol server fills the AutoFilterItems and AutoFilterDateNodes elements with information about filtering as follows:

    1. The protocol server adds the filter values that exist in the AutoFilter with their current filtering state as specified in section 3.1.4.13.3.3 and AutoFilterItems.

    2. The protocol server adds the filter date values that exist in the AutoFilter with their current filtering state as specified in AutoFilterDateNodeInfo (section 2.2.4.13) and AutoFilterDateNodes. The protocol server also adds the filter date value caption for the Year, Month, Day, Hour, Minute, and Second elements of the AutoFilterDateNodeInfo as follows:

      1. Each unique value of the Year element in AutoFilterDateNodeInfo in the AutoFilterDateNodes element is added by the protocol server to YearKeys element as specified in AutoFilterItemList complex type (section 3.1.4.13.3.1). The protocol server also adds the corresponding caption to YearValues as specified in YearValues element.

      2. Each unique value of the Month element in AutoFilterDateNodeInfo in the AutoFilterDateNodes element is added by the protocol server to MonthKeys element as specified in AutoFilterItemList complex type. The protocol server also adds the corresponding caption to MonthValues as specified in MonthValues element.

      3. Each unique value of the Day element in AutoFilterDateNodeInfo in the AutoFilterDateNodes element is added by the protocol server to DayKeys element as specified in AutoFilterItemList complex type. The protocol server also adds the corresponding caption to DayValues as specified in DayValues element.

      4. Each unique value of the Hour element in AutoFilterDateNodeInfo in the AutoFilterDateNodes element is added by the protocol server to HourKeys element as specified in AutoFilterItemList complex type. The protocol server also adds the corresponding caption to HourValues as specified in HourValues element.

      5. Each unique value of the Minute element in AutoFilterDateNodeInfo in the AutoFilterDateNodes element is added by the protocol server to MinuteKeys element as specified in AutoFilterItemList complex type. The protocol server also adds the corresponding caption to MinuteValues as specified in MinuteValues element.

      6. Each unique value of the Second element in AutoFilterDateNodeInfo in the AutoFilterDateNodes element is added by the protocol server to SecondKeys element as specified in AutoFilterItemList complex type. The protocol server also adds the corresponding caption to SecondValues as specified in SecondValues element.

In the event of an application error on the protocol server during this operation, a SOAP fault is returned, as specified in section 2.2.2. The Id element of the ExcelServerMessage SHOULD<22> be one of the values specified in section 2.2.2.1.