Edit

Share via

TextBox element (Server Ribbon)

  • Article

Applies to: SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013

Defines a text box control.

<TextBox
  Command="Text"
  Id="Text"
  ImeEnabled="TRUE | FALSE"
  MaxLength="Integer"
  QueryCommand="Text"
  Sequence="Integer"
  ShowAsLabel=" TRUE | FALSE "
  TemplateAlias="Text"
  ToolTipImage32by32="Url"
  ToolTipImage32by32Class="CSS Class Selector"
  ToolTipImage32by32Left="Negative Integer"
  ToolTipImage32by32Top="Negative Integer"
  ToolTipTitle="Text"
  ToolTipDescription="Text"
  ToolTipHelpKeyWord="Text"
  ToolTipShortcutKey="Text"
  Width="Integer"
/>

Elements and attributes

The following sections describe attributes, child elements, and parent elements.

Attributes

Attribute Description
Command
Optional. The name of the command to execute when the control is selected. If the control is in a CommandUIDefinition element, the value of the Command attribute of the control should be the same as the value of the Command attribute of a corresponding CommandUIHandler element.
Id
Required. A string that identifies the control, such as "Ribbon.Image.Image.Properties.AltText".
ImeEnabled
Optional. Set to TRUE to set the Input Method Editor (IME) to the active state. The default value is FALSE.
MaxLength
Optional. The maximum number of characters that a user can enter.
QueryCommand
Optional. The name of the command to execute when polling for state information.
Sequence
Optional. An integer that specifies the order of placement among sibling XML nodes.
ShowAsLabel
Optional. Set to TRUE to disable the text box so that it does not respond to user input and looks the same as a Label control. The default value is FALSE.
TemplateAlias
Optional. A string that matches the value of the TemplateAlias attribute for a ControlRef element, an OverflowArea element, or an OverflowSection element in a GroupTemplate element. The TemplateAlias attribute is used to size and position controls in a group when a template is applied to the group.
ToolTipImage32by32
Optional. A server-relative URL to a file that contains a 32-by-32-pixel image to use in the tooltip, such as "/_layouts/1033/images/formatmap32x32.png".
ToolTipImage32by32Class
Optional. The name of a CSS class selector to apply to the tooltip image.
ToolTipImage32by32Left
Optional. A negative integer that represents an offset for the left edge of the image. Use this attribute when the ToolTipImage32by32 attribute points to an image file that contains the images for many icons. The value of the ToolTipImage32by32Left attribute is used to set the CSS left attribute for the inline style of an HTML img tag when the page is created.
ToolTipImage32by32Top
Optional. A negative integer that represents an offset for the top edge of the image. Use this attribute when the ToolTipImage32by32 attribute points to an image file that contains the images for many icons. The value of the ToolTipImage32by32Top attribute is used to set the CSS top attribute for the inline style of an HTML img tag when the page is created.
ToolTipTitle
Optional. The text that appears as the title of the tooltip.
ToolTipDescription
Optional. The text that appears in the body of the tooltip.
ToolTipHelpKeyWord
Optional. The keyword that is used by context-sensitive Help.
ToolTipShortcutKey
Optional. The text to display for the shortcut key in the tooltip. For example, if the shortcut key for the control is Alt+J, the value for this attribute is "Alt+J". The tooltip displays the text for the shortcut key in parentheses after the tooltip title: "(Alt+J)".
Width
Optional. The width of the text box in pixels.

Child elements

None

Parent elements

Occurrences

  • Minimum: 0
  • Maximum: unbounded