Skip to content

commands-element.md

Latest commit

 

History

History
87 lines (72 loc) · 3.22 KB

commands-element.md

File metadata and controls

87 lines (72 loc) · 3.22 KB
Raw
title Commands Element
description The Commands element represents the collection of commands on the VSPackage toolbar and can have these sections: menus, groups, buttons, combos, and bitmaps.
ms.date 11/04/2016
ms.topic reference
f1_keywords
Commands
helpviewer_keywords
Commands element (VSCT XML schema)
VSCT XML schema elements, Commands
author tinaschrepfer
ms.author tinali
ms.subservice extensibility-integration

Commands element

Represents the collection of commands on the VSPackage toolbar. The collection can have up to five subsections, as follows: menus, groups, buttons, combos, and bitmaps.

Each subsection child element, for example, <Menu>, is identified by a unique command ID that is a GUID and numeric identifier pair. The GUID identifies the "command set" and is used to group logically related commands. The VSPackage should define its own command set to avoid collisions with command IDs that are defined by other VSPackages.

Syntax

<Commands package="GuidMyPackage" >
  <Menus>... </Menus>
  <Groups>... </Groups>
  <Buttons>... </Buttons>
  <Combos>... </Combos>
  <Bitmaps>... </Bitmaps>
</Commands>

Attributes and elements

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

Attributes

Attribute Description
package A GUID that identifies the VSPackage that provides the commands.

For example, package="guidVsPackage1Pkg".

Child elements

Element Description
Menus element Defines all the menus that a VSPackage implements.
Groups element Contains entries that define the command groups in a VSPackage.
Buttons element Groups Button elements.
Bitmaps element Groups Bitmap elements.
Combos element Groups Combo elements.

Parent elements

Element Description
CommandTable element Defines all the elements that represent the commands that a VSPackage provides to the IDE. Possible elements are menu items, menus, toolbars, and combo boxes.

Example

The following example shows how to use a Commands Element.

<Commands package="guidMyPackage">
    <Menus>
      <Menu Condition="'%(DEBUG)' != 'true'"
        guid="cmdSetGuidMyProductCommands" id="menuIDMainMenu"
        priority="0x0000" type="Menu">
        <Annotation>
          <Documentation>this is an annotation</Documentation>
          <AppInfo>
            <CustomData>
              <CustomSubElement>Some data</CustomSubElement>
            </CustomData>
          </AppInfo>
        </Annotation>
        <CommandFlag>AlwaysCreate</CommandFlag>
        <Strings>
          <ButtonText>MainMenu</ButtonText>
        </Strings>
      </Menu>
  </Menus>
<Commands>

See also