ComboBox Element

Applies to: SharePoint Foundation 2010

Defines a combo box control.

<ComboBox
  AllowFreeForm="TRUE | FALSE"
  AltArrow="Text"
  Alt="Text"
  AutoComplete="TRUE | FALSE"
  AutoCompleteDelay="Integer"
  CacheMenuVersions="TRUE | FALSE"
  Command="Text"
  CommandMenuOpen="Text"
  CommandMenuClose="Text"
  CommandPreview="Text"
  CommandPreviewRevert="Text"
  ImeEnabled="TRUE | FALSE"
  InitialItem="Text"
  Id="Text"
  QueryCommand="Text"
  PopulateDynamically="TRUE | FALSE"
  PopulateQueryCommand="Text"
  PopulateOnlyOnce="TRUE | FALSE"
  Sequence="Integer"
  TemplateAlias="Text"
  ToolTipImage32by32="Url"
  ToolTipImage32by32Class="CSS Class Selector"
  ToolTipImage32by32Left="Negative Integer"
  ToolTipImage32by32Top="Negative Integer"
  ToolTipTitle="Text"
  ToolTipDescription="Text"
  ToolTipHelpKeyWord="Text"
  ToolTipShortcutKey="Text"
  Width="Integer"
/>

Attributes

Attribute	Description
AllowFreeForm	Optional. FALSE to restrict input so that only items on the menu are submitted; otherwise, TRUE. The default is FALSE.
AltArrow	Optional. Alternative text that is used for the drop-down arrow button.
Alt	Optional. Alternative text that is used for the combo box.
AutoComplete	Optional. FALSE to turn AutoComplete suggestions off. The default is TRUE (on).
AutoCompleteDelay	Optional. The delay in milliseconds before AutoComplete fills the text box with a best-guess match. The default is 100.
CacheMenuVersions	Optional. TRUE to store previously constructed versions of a dynamic menu. The default is FALSE.
Command	Optional. The name of the command to execute when the control is clicked. 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.
CommandMenuOpen	Optional. The name of the command to execute when the drop-down menu is opened.
CommandMenuClose	Optional. The name of the command to execute when the drop-down menu is closed.
CommandPreview	Optional. The name of the command to execute for previewing a selection.
CommandPreviewRevert	Optional. The name of the command to execute to return to the state that existed before previewing a selection.
ImeEnabled	Optional. TRUE to set the Input Method Editor (IME) to the active state.
InitialItem	Optional. The ID of the menu item to display in the text box when it is first rendered.
Id	Required. A string that identifies the control, such as "Ribbon.EditingTools.CPEditTab.Font.Fonts".
QueryCommand	Optional. The name of the command to execute when polling for state information.
PopulateDynamically	Optional. TRUE to create the menu dynamically. The default is FALSE.
PopulateQueryCommand	Optional. The name of the command to execute when creating a dynamic menu.
PopulateOnlyOnce	Optional. TRUE to populate a dynamic menu only the first time that it is accessed. The default is FALSE.
Sequence	Optional. An integer that specifies the order of placement among sibling XML nodes.
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 within 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 be used in the tooltip, such as "/_layouts/1033/images/formatmap32x32.png".
ToolTipImage32by32Class	Optional. The name of a CSS class selector to be applied 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 will display the text for the shortcut key in parentheses after the tooltip title: "(ALT + J)".
Width	Optional. The width in pixels of the text box that is part of this combo box.

Child Elements

Menu

Parent Elements

CommandUIDefinition

Controls (Group)

Occurrences

Minimum: 0 Maximum: unbounded