Share via

2.2.4.64 RestRangeXmlRequest

  • Article

Namespace: http://schemas.microsoft.com/office/Excel/Server/WebServices/ExcelServerInternalService/

When passed as the request parameter of the ProcessRestRequest input (section 3.1.4.56.2.1), indicates retrieving a representation of a range as specified in [MS-EXSPXML3].

 <xs:complexType name="RestRangeXmlRequest" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <xs:complexContent mixed="false">
     <xs:extension base="tns:RestRequest">
       <xs:sequence>
         <xs:element minOccurs="1" maxOccurs="1" name="StateId" type="xs:int"/>
         <xs:element minOccurs="0" maxOccurs="1" name="RangeName" type="xs:string"/>
         <xs:element minOccurs="1" maxOccurs="1" name="NamedObjectView" type="xs:boolean"/>
         <xs:element minOccurs="1" maxOccurs="1" name="IsPrintRequest" type="xs:boolean"/>
         <xs:element minOccurs="1" maxOccurs="1" name="DisallowAutoNov" type="xs:boolean"/>
         <xs:element minOccurs="0" maxOccurs="1" name="ObjectName" type="xs:string"/>
       </xs:sequence>
     </xs:extension>
   </xs:complexContent>
 </xs:complexType>

StateId: MUST be -1.

RangeName: MUST be specified.  If it is not the name of a published item this field MUST follow the RangeReference (section 2.2.5.25) specification, with the following exceptions:

  • The protocol server MUST support the R1C1 notation.

  • If the value is longer than 287 characters, then the protocol server MUST return an ExcelServerMessage as specified in section 2.2.4.24, with the value of the Id element of the ExcelServerMessage set to EcsInvalidNamedObject.

NamedObjectView: Specifies whether to interpret RangeName as a published item. If true, RangeName MUST be interpreted as a published item. Otherwise, RangeName MUST NOT be interpreted as a published item.

IsPrintRequest: Specifies whether the information about the retrieved range in the RestRangeXmlResult (section 2.2.4.65) will be used for printing purposes. MUST be true if the information will be used for printing purposes by the protocol client. Otherwise, MUST be false.

DisallowAutoNov: Specifies the behavior to use when determining the baseline range (as described in section 2.2.4.44) during the GetRange operation associated with the RestRangeXmlRequest (see section 3.1.4.56).

ObjectName: MUST NOT be used.