Share via

3.1.4.11 GetAutoFilterItemList

  • Article

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

 <wsdl:operation name="GetAutoFilterItemList">
     <wsdl:input message="GetAutoFilterItemListSoapIn" />
     <wsdl:output message="GetAutoFilterItemListSoapOut" />
 </wsdl:operation>

The protocol client sends a GetAutoFilterItemListSoapIn request message, and the protocol server responds with a GetAutoFilterItemListSoapOut response message, as follows:

  1. The protocol server MUST fill the AutoFilterItems and AutoFilterDateNodes elements with information about the filtering:

  2. The protocol server MUST add the filter values that exist in the AutoFilter with their current filtering state as specified in AutoFilterItem (section 3.1.4.11.3.3) and AutoFilterItems.

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

  • Each unique value of the Year element in AutoFilterDateNodeInfo in the AutoFilterDateNodes element MUST be added by the protocol server to YearKeys element as specified in YearKeys element. The protocol server MUST also add the corresponding caption to YearValues as specified in YearValues element.

  • Each unique value of the Month element in AutoFilterDateNodeInfo in the AutoFilterDateNodes element MUST be added by the protocol server to MonthKeys element as specified in MonthKeys element. The protocol server MUST also add the corresponding caption to MonthValues as specified in MonthValues element.

  • Each unique value of the Day element in AutoFilterDateNodeInfo in the AutoFilterDateNodes element MUST be added by the protocol server to DayKeys element as specified in DayKeys element. The protocol server MUST also add the corresponding caption to DayValues as specified in DayValues element.

  • Each unique value of the Hour element in AutoFilterDateNodeInfo in the AutoFilterDateNodes element MUST be added by the protocol server to HourKeys element as specified in HourKeys element. The protocol server MUST also add the corresponding caption to HourValues as specified in HourValues element.

  • Each unique value of the Minute element in AutoFilterDateNodeInfo in the AutoFilterDateNodes element MUST be added by the protocol server to MinuteKeys element as specified in MinuteKeys element. The protocol server MUST also add the corresponding caption to MinuteValues as specified in MinuteValues element.

  • Each unique value of the Second element in AutoFilterDateNodeInfo in the AutoFilterDateNodes element MUST be added by the protocol server to SecondKeys element as specified in SecondKeys element. The protocol server MUST also add the corresponding caption to SecondValues as specified in SecondValues element.

In the event of an application error on the protocol server during this operation, the protocol server MUST return an ExcelServerMessage as specified in section 2.2.9.2. The id element of the ExcelServerMessage MUST be one of the values specified in section 2.2.9.4, and SHOULD<19> be one of the following values.

Id

Description

InvalidOrTimedOutSession

See section 2.2.9.5.

RetryError

See section 2.2.9.5.

OperationCanceled

See section 2.2.9.5.

InternalError

See section 2.2.9.5.

MultipleRequestsOnSession

See section 2.2.9.5.

MaxRequestDurationExceeded

See section 2.2.9.5.