3.1.4.5 ApplyTop10Filter

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.

 <wsdl:operation name="ApplyTop10Filter">
     <wsdl:input message="ApplyTop10FilterSoapIn" />
     <wsdl:output message="ApplyTop10FilterSoapOut" />
 </wsdl:operation>

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

  • The protocol client MUST NOT call this operation on auto filters that have their DataType attribute in the AutoFilters element (Section 2.2.4.24.18) present and with a value different from Number.

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<12> 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.

MultipleRequestsOnSession

See section 2.2.9.5.

MaxRequestDurationExceeded

See section 2.2.9.5.

InvalidSheetName

The protocol server could not find a worksheet with the name that is in the SheetName element.