Compartilhar via

<Controls> (RibbonDiffXml)

  • Artigo

 

Applies To: Dynamics CRM 2013

Contains a collection of controls.

Important

The valid child elements of the Controls element depend on the parent element.

Syntax

<CommandUIDefinition>
 <Controls
  Id="String"
  ToolTipDescription="String"
  ToolTipHelpKeyWord="String"
  ToolTipImage32by32="String"
  ToolTipImage32by32Class="String"
  ToolTipImage32by32Left="NonPositiveInteger"
  ToolTipImage32by32Top="NonPositiveInteger"
  ToolTipTitle="String">
  [ 
    <Button /> |
    <CheckBox /> |
    <ComboBox /> |
    <ColorPicker /> |
    <ContextualGroup /> |
    <Controls /> |
    <DropDown /> |
    <FlyoutAnchor /> |
    <Gallery /> |
    <GalleryButton /> |
    <GroupTemplate /> |
    <Group /> |
    <Groups /> |
    <InsertTable /> |
    <Label /> |
    <MRUSplitButton /> |
    <MaxSize /> |
    <Menu /> |
    <MenuSection /> |
    <Scale /> |
    <Scaling /> |
    <Spinner /> |
    <SplitButton /> |
    <Tab /> |
    <TextBox/> |
    <ToggleButton />
   ]
 </Controls>
</CommandUIDefinition>

<MenuSection>
 <Controls
  Id="String"
  ToolTipDescription="String"
  ToolTipHelpKeyWord="String"
  ToolTipImage32by32="String"
  ToolTipImage32by32Class="String"
  ToolTipImage32by32Left="NonPositiveInteger"
  ToolTipImage32by32Top="NonPositiveInteger"
  ToolTipTitle="String">
  [ 
    <ToggleButton /> |
    <Button /> |
    <ColorPicker /> |
    <FlyoutAnchor /> |
    <InsertTable /> 
   ]
 </Controls>
</MenuSection>

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.

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.

Important

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

Important

String

Required

ToolTipDescription

Specifies a string to display for the tooltip for a control. This can reference a LocLabel element using the $LocLabels: directive, for example, "$LocLabels:MyISV.account.Save.Button.Tooltip".

String

Optional

ToolTipHelpKeyWord

This element is not used in Microsoft Dynamics CRM.

String

Optional

ToolTipImage32by32

Specifies a 32 by 32 pixel image to be displayed with the tooltip.

String

Optional

ToolTipImage32by32Class

Specifies a CSS class to apply to the 32 by 32 pixel image to be displayed with the tooltip.

String

Optional

ToolTipImage32by32Left

Specifies the number of pixels to move the tooltip 32 by 32 pixel image to the left. This is represented by a negative number.

Non Positive Integer

Optional

ToolTipImage32by32Top

Specifies the number of pixels to move the tooltip 32 by 32 pixel image to the top. This is represented by a negative number.

Non Positive Integer

Optional

ToolTipSelectedItemTitle

This element is not used in Microsoft Dynamics CRM.

String

Optional

ToolTipShortcutKey

This element is not used in Microsoft Dynamics CRM.

String

Optional

ToolTipTitle

Specifies a string to display for the title of a tooltip for a control. This is typically the same value as the control LabelText. This can reference a LocLabel element using the $LocLabels: directive, for example, "$LocLabels:MyISV.account.Save.Button.Label".

String

Optional

Child Elements

Element

Description

<Button> (RibbonDiffXml)

Specifies a simple button used to perform an action.

<CheckBox> (RibbonDiffXml)

Specifies a check box used to select an option.

This element is only valid when Controls is a child of <CommandUIDefinition> (RibbonDiffXml).

<ColorPicker> (RibbonDiffXml)

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

This element is only valid when Controls is a child of <MenuSection> (RibbonDiffXml)

<ComboBox> (RibbonDiffXml)

Deprecated: Specified a list used to select a value by clicking or typing.

This element is only valid when Controls is a child of <CommandUIDefinition> (RibbonDiffXml).

<DropDown> (RibbonDiffXml)

Deprecated: Specified a list used to select a value by clicking.

This element is only valid when Controls is a child of <CommandUIDefinition> (RibbonDiffXml).

<FlyoutAnchor> (RibbonDiffXml)

Specifies a button with a down arrow used to open a menu.

<GalleryButton> (RibbonDiffXml)

Deprecated: Specified a button control within a gallery element.

This element is only valid when Controls is a child of <CommandUIDefinition> (RibbonDiffXml).

<InsertTable> (RibbonDiffXml)

Deprecated: Specified a 10 by 10 grid used to specify the dimensions of a table.

This element is only valid when Controls is a child of <MenuSection> (RibbonDiffXml)

<Label> (RibbonDiffXml)

Specifies a line of text used to provide information.

This element is only valid when Controls is a child of <CommandUIDefinition> (RibbonDiffXml).

<MRUSplitButton> (RibbonDiffXml)

Deprecated: Specified a split button control that displays Most Recently Used items.

This element is only valid when Controls is a child of <CommandUIDefinition> (RibbonDiffXml).

<Spinner> (RibbonDiffXml)

Specifies a control used to insert a value by typing or using the arrow keys to cycle through the values.

This element is only valid when Controls is a child of <CommandUIDefinition> (RibbonDiffXml).

<SplitButton> (RibbonDiffXml)

Specifies a control used as both a button and a menu.

This element is only valid when Controls is a child of <CommandUIDefinition> (RibbonDiffXml).

<TextBox> (RibbonDiffXml)

Deprecated: Specified a control used to enter text.

This element is only valid when Controls is a child of <CommandUIDefinition> (RibbonDiffXml).

<ToggleButton> (RibbonDiffXml)

Specifies a button used to toggle between an on and off state.

Parent Elements

Element

Description

<Group> (RibbonDiffXml)

Specifies a group of controls within a tab that share a common layout template.

<CommandUIDefinition> (RibbonDiffXml)

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

<MenuSection> (RibbonDiffXml)

Specifies a section used to divide a menu. A menu section can have a title and contain controls.

Element Information

XPath

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

Schema Name

ControlsType

Validation File

RibbonWSS.xsd

Can be Empty

Yes

See Also

Customize commands and the ribbon
Ribbon XML reference