<ColorPicker> (RibbonDiffXml)

 

Updated: November 29, 2016

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Deprecated: Specified a grid used to select a color or style.

System_CAPS_importantImportant

This control was deprecated in Microsoft Dynamics CRM 2011. This control will not render with Microsoft Dynamics 365 (online) or with on-premises versions CRM 2013 or later.

<ColorPicker
 Command="String"
 CommandPreview="String"
 CommandRevert="String"
 Id="String"
 QueryCommand="String"
 Sequence="Integer"
 TemplateAlias="String" >
 <Colors />
</ColorPicker>

Attributes and Elements

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

Attributes

Attribute

Description

Type

Usage

Command

Specifies the ID of the ribbon command for this control.

String

Optional

CommandPreview

Specifies the ID of the ribbon command to run when the cursor hovers over the control before it is selected.

String

Optional

CommandRevert

Specifies the ID of the ribbon command to run when the user selects undo.

String

Optional

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.

Use the {!EntityLogicalName} token in the Id attribute when you define a ribbon element that will be used for multiple entities. This inserts the entity logical name into the Id value to make sure that the Id value is globally unique.

For example, if you use MyISV.{!EntityLogicalName}.form.SendToOtherSystem.Button with the account entity, the Id will be MyISV.account.form.SendToOtherSystem.Button. For the contact entity, the Id will be MyISV.contact.form.SendToOtherSystem.Button.

System_CAPS_importantImportant

If you don’t set a globally unique Id value, the ribbon might not display.

String

Required

QueryCommand

Specifies the name of the command to run when polling for state information.

String

Optional

Sequence

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

Integer

Optional

TemplateAlias

Associates a ribbon element child of CommandUIDefinition with a location placeholder within a child of a Layout element. This value defines where the control will display within a group of controls when the layout changes.

String

Optional

Child Elements

Element

Description

<Colors> (RibbonDiffXml)

Specifies a collection of colors for a color picker control.

Parent Elements

Element

Description

<CommandUIDefinition> (RibbonDiffXml)

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

<Controls> (RibbonDiffXml)

Contains a collection of controls.

Element Information

XPath

//RibbonDiffXml/CustomActions/CustomAction/CommandUIDefinition/ColorPicker |
//RibbonDiffXml/CustomActions/CustomAction/CommandUIDefinition/Controls/ColorPicker |
//RibbonDiffXml/CustomActions/CustomAction/CommandUIDefinition/Menu/MenuSection/Controls/ColorPicker

Schema Name

ColorPickerType

Validation File

RibbonWSS.xsd

Can be Empty

Yes

Microsoft Dynamics 365

© 2017 Microsoft. All rights reserved. Copyright

Community Additions

ADD
Show: