Share via

<ComboBox> (RibbonDiffXml)

  • Article

 

Applies To: Dynamics CRM 2015

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

Important

This control was deprecated in Microsoft Dynamics CRM 2011. This control will not render with Microsoft Dynamics CRM 2015 and Microsoft Dynamics CRM Online 2015 Update.

Syntax

<ComboBox
 AllowFreeForm=["0" | "1" | "true" | "false"]
 Alt="String"
 AltArrow="String"
 AutoComplete="true"
 AutoCompleteDelay="Integer"
 CacheMenuVersions=["0" | "1" | "true" | "false"]
 Command="String"
 CommandMenuClose="String"
 CommandMenuOpen="String"
 CommandPreview="String"
 CommandPreviewRevert="String"
 Id="String"
 ImeEnabled=["0" | "1" | "true" | "false"]
 InitialItem="String"
 PopulateDynamically=["0" | "1" | "true" | "false"]
 PopulateOnlyOnce =["0" | "1" | "true" | "false"]
 PopulateQueryCommand="String"
 QueryCommand="String"
 Sequence="Integer"
 TemplateAlias="String"
 ToolTipDescription="String"
 ToolTipHelpKeyWord="String"
 ToolTipImage32by32="String"
 ToolTipImage32by32Class="String"
 ToolTipImage32by32Left="NonPositiveInteger"
 ToolTipImage32by32Top="NonPositiveInteger "
 ToolTipSelectedItemTitle="String"
 ToolTipShortcutKey="String"
 ToolTipTitle="String"
 Width="String" >
 <Menu />
</ComboBox>

Attributes and Elements

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

Attributes

Attribute

Description

Type

Usage

AllowFreeForm

False to restrict input so that only items on the menu are submitted; otherwise, true. The default is false.

Boolean

Optional

Alt

String or reference to a localized label to display as alternative text.

String

Optional

AltArrow

A path or web resource reference to an alternative image for the arrow icon for combo box or drop-down controls.

String

Optional

AutoComplete

False to turn AutoComplete suggestions off. The default is true (on).

Boolean

Optional

AutoCompleteDelay

The delay in milliseconds before AutoComplete fills the text box with a best-guess match. The default is 100.

Integer

Optional

CacheMenuVersions

Indicates whether the definition for the control should be cached for better performance. Select this value if you do not select PopulateDynamically.

Default value = "false".

Boolean

Optional

Command

Specifies the ID of the ribbon command for this control.

String

Optional

CommandMenuClose

Specifies the ID of the menu command to run when the menu closes.

String

Optional

CommandMenuOpen

Specifies the ID of the ribbon command to run when the menu opens.

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

CommandPreviewRevert

Specifies the ID of the ribbon command to run when the control loses focus after preview.

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.

Important

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

String

Required

ImeEnabled

Specifies whether the active state of an Input Method Editor (IME) is enabled. An IME lets you enter and edit Chinese, Japanese, and Korean characters. IMEs can be in an active or inactive state. The active state accepts Chinese, Japanese, or Korean characters. The inactive state behaves like a regular keyboard and uses a limited set of characters.

Boolean

Optional

InitialItem

Specifies the initial menu to display in the control.

String

Optional

PopulateDynamically

Specifies that the menu elements that provide options for this control will be populated dynamically at run-time using the command defined by the PopulateQueryCommand attribute.

Default value = "false".

Boolean

Optional

PopulateOnlyOnce

When the control is populated dynamically, this setting indicates that the command defined by the PopulateQueryCommand attribute should only be called once.

Default Value = "false".

Boolean

Optional

PopulateQueryCommand

When the control is populated dynamically, this command retrieves the menu elements that provide options for this control.

String

Optional

QueryCommand

When the control is populated dynamically, this command retrieves the menu elements that provide options for this control.

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

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

Width

Specifies a desired width for the control in pixels.

String

Optional

Child Elements

Element

Description

<Menu> (RibbonDiffXml)

Specifies a container used to show pop-up menus.

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/ComboBox |
//RibbonDiffXml/CustomActions/CustomAction/CommandUIDefinition/Controls/ComboBox |
//RibbonDiffXml/CustomActions/CustomAction/CommandUIDefinition/Menu/MenuSection/Controls/ComboBox

Schema Name

ComboBoxType

Validation File

RibbonWSS.xsd

Can be Empty

Yes

See Also

Customize commands and the ribbon
Ribbon XML reference

© 2016 Microsoft. All rights reserved. Copyright