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">
   <xs:sequence>
     <xs:element minOccurs="0" name="Appearance" type="tns:ExcelServerMessageAppearance"/>
     <xs:element minOccurs="0" name="Caption" nillable="true" type="xs:string"/>
     <xs:element minOccurs="0" name="Description" nillable="true" type="xs:string"/>
     <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="tns: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="tns:ExcelServerMessageId"/>
     <xs:element minOccurs="0" name="Severity" type="tns:ExcelServerMessageSeverity"/>
     <xs:element minOccurs="0" name="Type" type="tns: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.7. MUST be present.

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

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

HasClientUrl: MUST be ignored by the protocol client.

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.10. MUST be present.

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

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

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