<CustomAction> (RibbonDiffXml)

 

Applies To: Dynamics CRM 2013

Defines an action to add or replace items in the ribbon.

<CustomAction 
 Id="String"
 Location="String"
 Sequence="Integer"
 Title="String">
 <CommandUIDefinition />
</CustomAction>

Attributes and Elements

The following table lists the attributes, child elements, and parent elements.

Attributes

Attribute

Description

Type

Usage

Id

Specifies a unique identifier for the definition of a ribbon element. The strongly recommended naming convention is to use a period to separate the parts of the name like so: [solution identifier].[entity].[ribbon].[function].[element name]. For example: MyISV.account.form.SendToOtherSystem.Button.

The recommended naming convention is to use a period to separate consistent components like so: <solution identifier>.<entity>.<ribbon>.<function>.<element name>. For example: MyISV.account.form.SendToOtherSystem.CustomAction.

String

Optional

Location

References the Id of an existing ribbon element that contains the modification defined in the CustomAction. To add a new ribbon element, refer to the containing element Id and include the suffix ”._children”.

String

Optional

Sequence

Specify the location of the ribbon modification by setting the Sequence value higher or lower than existing ribbon elements.

Integer

Optional

Title

This element is not used in Microsoft Dynamics CRM.

String

Optional

Child Elements

Element

Description

<CommandUIDefinition> (RibbonDiffXml)

Specifies the visible Ribbon elements to be included within a CustomAction element.

Parent Elements

Element

Description

<CustomActions> (RibbonDiffXml)

Contains a collection of actions that can add, replace, or remove items from the ribbon.

Element Information

XPath

//RibbonDiffXml/CustomActions/CustomAction

Schema Name

CustomActionType

Validation File

RibbonCore.xsd

Can be Empty

No

Show: