2.2.4.69 WorkbookMetadata

  • Article

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

This is a container that encapsulates information about features in the workbook.

 <xs:complexType name="WorkbookMetadata" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <xs:sequence>
     <xs:element minOccurs="0" maxOccurs="1" name="Sheets" type="tns:ArrayOfWorksheetData"/>
     <xs:element minOccurs="0" maxOccurs="1" name="SheetChanges" type="tns:ArrayOfWorksheetChangeInfo"/>
     <xs:element minOccurs="1" maxOccurs="1" name="HidePivotFieldList" type="xs:boolean"/>
     <xs:element minOccurs="0" maxOccurs="1" name="ServerEventMetadataList" type="tns:ArrayOfServerEventMetadata"/>
     <xs:element minOccurs="0" maxOccurs="1" name="WebExtensions" type="tns:ArrayOfWebExtensionMetadata"/>
     <xs:element minOccurs="1" maxOccurs="1" name="HasSurveys" type="xs:boolean"/>
     <xs:element minOccurs="0" maxOccurs="1" name="SurveyTitle" type="xs:string"/>
   </xs:sequence>
 </xs:complexType>

Sheets: Contains an ArrayOfWorksheetData (section 2.2.4.49) elements which is metadata for each sheet (1) in the workbook.

SheetChanges: Ignored by the protocol client.

HidePivotFieldList: Specifies whether the PivotTable field list is hidden. If the PivotTable field list is hidden, MUST be set to true. Otherwise, MUST be false.

ServerEventMetadataList: Contains an ArrayOfServerEventMetadata (section 2.2.4.78) elements which is a list of ServerEventMetadata items where their version, as specified the StateVersion element of ServerEventMetadata, is greater than ServerEventVersion element value in WorkbookMetadataState (section 2.2.4.72) sent the request.

WebExtensions: Contains an ArrayOfWebExtensionMetadata (section 2.2.4.79) elements which is a list of WebExtensionMetadata items one for each Office Web Extension in the workbook.

HasSurveys: MUST be set to true if the workbook contains any surveys.  Otherwise, MUST be false.

SurveyTitle: If HasSurveys is set to true, MUST be the title of a survey in the workbook.  If HasSurveys is set to false, MUST NOT be used.