Share via

2.2.4.23 ExcelServerMessage

  • Article

Namespace: http://schemas.datacontract.org/2004/07/Microsoft.Office.Excel.Server

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="0" name="Appearance" type="q1:ExcelServerMessageAppearance"/>
     <xs:element minOccurs="0" name="Caption" nillable="true" type="xs:string"/>
     <xs:element minOccurs="0" name="DebugInfo" nillable="true" type="xs:string"/>
     <xs:element minOccurs="0" name="Description" nillable="true" type="xs:string"/>
     <xs:element minOccurs="0" name="DisplaysCorrelationId" type="xs:boolean"/>
     <xs:element minOccurs="0" name="ExtendedDescription" nillable="true" type="xs:string"/>
     <xs:element minOccurs="0" name="HasClientUrl" type="xs:boolean"/>
     <xs:element minOccurs="0" name="HasOpenItemPermission" type="xs:boolean"/>
     <xs:element minOccurs="0" name="HealthInformation" nillable="true" type="q1:ServerHealthInformation"/>
     <xs:element minOccurs="0" name="HelpDisplayText" nillable="true" type="xs:string"/>
     <xs:element minOccurs="0" name="HelpTopicId" nillable="true" type="xs:string"/>
     <xs:element minOccurs="0" name="Id" type="q1:ExcelServerMessageId"/>
     <xs:element minOccurs="0" name="Severity" type="q1:ExcelServerMessageSeverity"/>
     <xs:element minOccurs="0" name="Type" type="q1:ExcelServerMessageType"/>
     <xs:element minOccurs="0" name="WrongEcsServerId" nillable="true" type="xs:string"/>
   </xs:sequence>
 </xs:complexType>

Appearance: The control buttons of the alert as specified in section 2.2.5.11. MUST be present.

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

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

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

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.

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

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.

HasOpenItemPermission: Specifies whether the user has Open Item permission to the workbook file. MUST be set to true if the user has Open Item permission, MUST be set to false otherwise. MUST be present.

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

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

HelpTopicId: The Help topic identifier.

Id: The identifier of the alert as specified in section 2.2.5.14. MUST be present.

Severity: The severity of the alert as specified in section 2.2.5.16. MUST be present.

Type: The type of the alert as specified in section 2.2.5.18. MUST be present.

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