Share via

2.2.4.5 ActionStruct

  • Article

Namespace: Microsoft.SharePoint.BusinessData

The ActionStruct complex type contains information about an Action.

 <xs:complexType name="ActionStruct" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <xs:complexContent mixed="false">
     <xs:extension base="q8:MetadataObjectStruct">
       <xs:sequence>
         <xs:element minOccurs="0" name="entityId" type="xs:unsignedInt"/>
         <xs:element minOccurs="0" name="imageUrl" nillable="true" type="xs:string"/>
         <xs:element minOccurs="0" name="isOpenedInNewWindow" type="xs:boolean"/>
         <xs:element minOccurs="0" name="position" type="xs:unsignedByte"/>
         <xs:element minOccurs="0" name="url" nillable="true" type="xs:string"/>
       </xs:sequence>
     </xs:extension>
   </xs:complexContent>
 </xs:complexType>

entityId: The MetadataObjectId of the Entity that contains the Action. This element MUST be present. The value of this element MUST be in [1, 0x7ffffffff] range.

imageUrl: The implementation-specific location of the resource that is used to represent the Action in the user interface. The application that utilizes the protocol client can use the resource in the specified location to represent the Action in the user interface possibly along with the localized name of the Action. This element MUST be present.

isOpenedInNewWindow: A value which specifies whether the results of executing an Action are presented in a new user interface context. The application that utilizes the protocol client can use this value as guidance on creating new user interface context when the Action is executed. This element MUST be present.

position: The order of an Action among the other Actions for an Entity. The application that utilizes the protocol client can use this ordering as guidance in an implementation-specific algorithm that represents the Actions in the user interface. This element MUST be present.

url: The implementation-specific parameterized command associated with the Action. The parameters of the command MUST correspond to ActionParameters of this Action. This element MUST be present.