3.1.4.1 ApplyItemFilter

This operation is used to change the filtering of a table or worksheet AutoFilter in the workbook.

 <wsdl:operation name="ApplyItemFilter">
     <wsdl:input message="ApplyItemFilterSoapIn" />
     <wsdl:output message="ApplyItemFilterSoapOut" />
 </wsdl:operation>

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

  • The protocol server sets the filter to the clear all state if the values element is not present, and the autoFilterDateNodes element is not present, and the blanks element value is false, and the hideBlanks element value is false, and the value of CriteriaType element of AutoFilterOptions (section 2.2.4.10) is Nil, and the Criteria element of AutoFilterOptions is not present.

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<8> be one of the values described in the following table.

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.

MaxRequestDurationExceeded

See section 2.2.9.5.

MultipleRequestsOnSession

See section 2.2.9.5.