2.2.4.24 ExcelServerMessage

  • Article

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

An alert information returned by the protocol server.

 <xs:complexType name="ExcelServerMessage" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <xs:sequence>
     <xs:element minOccurs="1" maxOccurs="1" name="HasOpenItemPermission" type="xs:boolean"/>
     <xs:element minOccurs="1" maxOccurs="1" name="HasClientUrl" type="xs:boolean"/>
     <xs:element minOccurs="1" maxOccurs="1" name="Id" type="tns:ExcelServerMessageId"/>
     <xs:element minOccurs="0" maxOccurs="1" name="DebugInfo" type="xs:string"/>
     <xs:element minOccurs="1" maxOccurs="1" name="Severity" type="tns:ExcelServerMessageSeverity"/>
     <xs:element minOccurs="1" maxOccurs="1" name="Type" type="tns:ExcelServerMessageType"/>
     <xs:element minOccurs="1" maxOccurs="1" name="Appearance" type="tns:ExcelServerMessageAppearance"/>
     <xs:element minOccurs="0" maxOccurs="1" name="Description" type="xs:string"/>
     <xs:element minOccurs="0" maxOccurs="1" name="ExtendedDescription" type="xs:string"/>
     <xs:element minOccurs="0" maxOccurs="1" name="Caption" type="xs:string"/>
     <xs:element minOccurs="0" maxOccurs="1" name="HelpTopicId" type="xs:string"/>
     <xs:element minOccurs="1" maxOccurs="1" name="DisplaysCorrelationId" type="xs:boolean"/>
     <xs:element minOccurs="0" maxOccurs="1" name="HelpDisplayText" type="xs:string"/>
     <xs:element minOccurs="0" maxOccurs="1" name="HealthInformation" type="tns:ServerHealthInformation"/>
     <xs:element minOccurs="0" maxOccurs="1" name="WrongEcsServerId" type="xs:string"/>
   </xs:sequence>
 </xs:complexType>

HasOpenItemPermission: Specifies whether the user has Open Item permission to the workbook file.

HasClientUrl: Specifies an absolute path exists for the workbook file. MUST be true if the value of the ClientWorkbookUri element of OpenWorkbookOutParameters (section 2.2.4.52) is present and is not empty, and MUST be set to false otherwise.

Id: The identifier of the alert as specified in section 2.2.5.13.

DebugInfo:  An opaque string returned from the protocol server – does not have any effect on the protocol client.

Severity: The severity of the alert as specified in section 2.2.5.15.

Type: The type of the alert as specified in section 2.2.5.17.

Appearance: The control buttons or Message Bar notification flag associated with the alert as specified in section 2.2.5.12.

Description: A text description of the alert. MUST be present. MUST NOT be empty. MUST be in the language UI culture of the session (2).

ExtendedDescription: An extended description of the alert. MUST be present. MUST be in the language UI culture of the session (2).

Caption: A caption for the alert. MUST be present. MUST be in the language UI culture of the session (2).

HelpTopicId: The Help topic identifier.

DisplaysCorrelationId: Specifies whether the protocol client includes debug information in the alert. If set to true the protocol client includes debug information in the alert. If set to false the protocol client excludes debug information from the alert.

HelpDisplayText: A description of the Help topic. MUST be present. MUST be in the language UI culture of the session (2).

HealthInformation: The health information of the protocol server as specified in section 2.2.4.34.

WrongEcsServerId: The instance identifier of a protocol server as specified in section 3.1.1.