3.1.4.6 ApplyTop10Filter

  • Article

This operation is used to apply a top N filter or a bottom N filter on a column (2) in a worksheet or in a table.

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

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

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

  • The protocol client MUST NOT call this operation on AutoFilters that have their DataType attribute in the CT_item element (as specified in[MS-EXSPXML3] section 2.3.18) present and with a value different from Number.

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

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<15> be one of the values specified in section 2.2.2.1.