Combo Element

  • Article

Note

This article applies to Visual Studio 2015. If you're looking for the latest Visual Studio documentation, see Visual Studio documentation. We recommend upgrading to the latest version of Visual Studio. Download it here

Defines commands that appear in a combo box. There are four kinds of combo boxes, as follows: DropDownCombo, DynamicCombo, IndexCombo, and MRUCombo.

Syntax

<combo guid="guidMyCommandSet" id="MyCommand" defaultWidth="20" idCommandList="MyCommandListID" priority="0x102" type="DropDownCombo">  
  <Parent>... </Parent  
  <CommandFlag>... </CommandFlag>  
  <Strings>... </Strings>  
</combo>

Attributes and Elements

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

Attributes

Attribute Description
guid Required. GUID of the GUID/ID command identifier.
id Required. ID of the GUID/ID command identifier.
defaultWidth Required. An integer that specifies a pixel width for the combo box.
idCommandList Required. An ID that is sent to the active commmand target to retrieve the list of items to be displayed in the combo box. The ID will be in the same GUID scope as the control.
priority Optional. A numeric value that specifies the priority.
type Optional. An enumerated value that specifies the type of button.

If not given, uses Button.

DropDownCombo
The VSPackage is responsible for filling in the contents for this combo box. The user cannot type anything in the text box of this drop-down.

DynamicCombo
The VSPackage is responsible for filling in the contents of this combo box. The user can edit this combo and also select items in it.

IndexCombo
The same as DynamicCombo except that it raises the index of the item rather than its text.

MRUCombo
Filled by the integrated development environment (IDE) on behalf of the VSPackage. The user can edit in this combo box. The IDE remembers up to the last 16 entries per combo box.

When the user selects something in the combo box, or enters something new, the IDE notifies the appropriate VSPackage.
Condition Optional. See Conditional Attributes.

Child Elements

Element Description
Parent Optional. The parent element of the button.
CommandFlag Required. See Command Flag Element. The valid CommandFlag values for a Button are as follows.

- CaseSensitive

- CommandWellOnly

- DefaultDisabled

- DefaultInvisible

- DynamicVisibility

- FilterKeys

- IconAndText

- NoAutoComplete

- NoButtonCustomize

- NoCustomize

- NoKeyCustomize

- StretchHorizontally
Strings Required. See Strings Element. The child ButtonText element must be defined.
Annotation Optional comment.

Parent Elements

Element Description
Commands Element Represents the collection of commands on the VSPackage toolbar.

Example

<Combo guid="guidWidgetPackage" id="cmdidInsertOptions"  
  defaultWidth="100" idCommandList="cmdidGetInsertOptionsList">  
  <CommandFlag>DynamicVisibility</CommandFlag>  
  <Strings>  
    <ButtonText>Select Insert Options</ButtonText>  
  </Strings>  
</Combo>  
  
<Combo guid="guidWidgetPackage" id="cmdidInsertOptions"  
  priority="0x0500" type="DropDownCombo" defaultWidth="100"  
  idCommandList="cmdidGetInsertOptionsList">  
  <Parent guid="cmdSetGuidWidgetCommands" id="groupIDFileEdit">  
  <CommandFlag>DynamicVisibility</CommandFlag>  
  <Strings>  
    <ButtonText>Select Insert Options</ButtonText>  
  </Strings>  
</Combo>

See Also

Visual Studio Command Table (.Vsct) Files