Share via

3.1.4.1 ApplyItemFilter

  • Article

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

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

 <wsdl:operation name="ApplyItemFilter" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">
   <wsdl:input wsaw:Action="http://schemas.microsoft.com/office/Excel/Server/WebServices/ExcelServerInternalService/ExcelServiceSoap/ApplyItemFilter" message="tns:ExcelServiceSoap_ApplyItemFilter_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/ApplyItemFilterResponse" message="tns:ExcelServiceSoap_ApplyItemFilter_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/ApplyItemFilterExcelServerMessageFault" name="ExcelServerMessageFault" message="tns:ExcelServiceSoap_ApplyItemFilter_ExcelServerMessageFault_FaultMessage" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"/>
 </wsdl:operation>

The protocol client sends an ExcelServiceSoap_ApplyItemFilter_InputMessage request message, and the protocol server responds with an ExcelServiceSoap_ApplyItemFilter_OutputMessage 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.14) 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, a SOAP fault is returned, as specified in section 2.2.2. The Id element of the ExcelServerMessage SHOULD<10> be one of the values specified in section 2.2.2.1.

This operation is a state changing operation on the protocol server.