3.1.4.12 FindRange

  • Article

This operation is used to find a string inside a workbook.

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

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

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

  1. The protocol server searches for the string specified by searchTerm.

  2. The search starts at the adjacent cell of the one specified by searchAfterCell, in the direction specified by searchUp.

  3. If the ObjectName element in the VisibleSheetRangeRequest element in the parameter element is not present, the scope of the search is the worksheet specified by the SheetName element in the searchAfterCell element. Otherwise, the scope of the search is the named object specified by the SheetName element in the searchAfterCell element.

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