<TextBox> (RibbonDiffXml)
TOC
Collapse the table of content
Expand the table of content

<TextBox> (RibbonDiffXml)

 

Applies To: Dynamics CRM 2016, Dynamics CRM Online

Deprecated: Specified a control used to enter text.

System_CAPS_importantImportant

This control was deprecated in Microsoft Dynamics CRM 2011. This control will not render with Microsoft Dynamics CRM Online 2016 Update and Microsoft Dynamics CRM 2016 (on-premises).

<TextBox
 Command="String"
 Id="String"
 ImeEnabled =["0" | "1" | "true" | "false"]
 MaxLength="Integer"
 QueryCommand="String"
 Sequence="Integer"
 ShowAsLabel =["0" | "1" | "true" | "false"]
 TemplateAlias="String"
 ToolTipDescription="String"
 ToolTipHelpKeyWord="String"
 ToolTipImage32by32="String"
 ToolTipImage32by32Class="String"
 ToolTipImage32by32Left="Non Positive Integer"
 ToolTipImage32by32Top="Non Positive Integer"
 ToolTipShortcutKey="String"
 ToolTipTitle="String"
 Width="String"
 />

Attributes and Elements

The following describes 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

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

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

MaxLength

The maximum number of characters that a user can enter.

Integer

Optional

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

ShowAsLabel

Set to TRUE to disable the text box so that it does not respond to user input and looks the same as a <Label> (RibbonDiffXml) control. The default value is FALSE.

String

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.

System_CAPS_noteNote

This element cannot be associated with a template alias that represents an <OverflowSection> (RibbonDiffXml) or a <ControlRef> (RibbonDiffXml) element that uses the Large display mode.

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

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

This element has no child elements.

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/TextBox |
//Controls/TextBox

Schema Name

TextBoxType

Validation File

RibbonWSS.xsd

Can be Empty

Yes

Microsoft Dynamics CRM 2016 and CRM Online

© 2016 Microsoft. All rights reserved. Copyright

Community Additions

ADD
Show:
© 2016 Microsoft