BUTTONS_BEGIN-BUTTONS_END

[アーティクル]
11/09/2009

[このドキュメントはプレビュー版であり、後のリリースで変更されることがあります。空白のトピックは、プレースホルダーとして挿入されています。]

The BUTTONS_BEGIN – BUTTONS_END section contains entries that describe the commands that a VSPackage has implemented.

コマンドボタン

A のコマンド、ツールバーのボタン、メニュー項目、または分割ドロップダウンリストボックスは Visual Studio によって、ボタンと見なされますか。

すべてのコマンドは、BUTTONS_BEGIN - BUTTONS_END セクションで定義されます。コマンドが 12 までのフィールドをコマンドの定義を制御します。すべてのフィールドを区切るコンマと、セミコロン (;) はそれぞれのエントリの末尾を示します。以下に例を示します。

Command ID, Group ID, Priority, Icon ID, Button Type, Flags, Button Text, Menu Text, ToolTip Text, Command Well Text, English Command Name, Localized Command Name;

これらのフィールドは、次の表に示すされ、指定された順序に表示必要があります。最後のフィールドをセミコロンで終了する必要があります。 "The Command フィールド] を表示します。詳細の各フィールドについては「に」以降。

[フィールド名]	説明
Command ID	このコマンドを識別する GUID:ID ペアを指定します。
Group ID	グループを識別する GUID:ID のペアをこのコマンドに属します。
Priority	同じグループに他のコマンドを基準にこのコマンドを配置に使用する値。
Icon ID	使用するアイコンを識別する GUID:ID ペアを指定します。
Button Type	定数でコマンドの種類を指定します。
Flags	コマンドに追加の属性を適用するフラグのコレクションです。
Button Text	Menu Text フィールドが指定されていない場合、ツールバーまたはメニューにメニューの [テキストとして、ボタンに表示されるテキスト。
Menu Text	ドロップダウンまたはコンテキストメニューに表示されるテキスト。このボックスへの入力は省略できます。このフィールドが指定されていない場合は、Button Text フィールドが使用されます。
ToolTip Text	コマンドは、ツールバーに配置、コマンドで、カーソルは保持されるときに表示されるテキスト。このボックスへの入力は省略できます。このフィールドが指定されていない場合は、Button Text フィールドが使用されます。
Command Well Text	コマンドを記述するメニューとツールバーのカスタマイズ表示で使用されるテキスト。このフィールドは省略可能です。指定しない場合、Button Text フィールドが使用されます。
English Command Name	英語版で、コマンドの名前。このボックスへの入力は省略できます。このフィールドが指定されていないである場合、Button Text フィールドは、正規の形式に変換されます (たとえば、"& [メニュー項目] なります"MyMenuItem")。このフィールドは、コマンドウィンドウから使用するコマンド名を指定します。
Localized Command Name	ローカル言語では、コマンドの名前。このボックスへの入力は省略できます。このフィールドが指定されていないである場合、Button Text フィールドは、正規の形式に変換されます (たとえば、"& [メニュー項目] なります"MyMenuItem")。このフィールドは、コマンドウィンドウから使用するコマンド名を指定します。

コマンドの使用例 (VB)

The following example shows part of the BUTTONS_BEGIN – BUTTONS_END section from the File Explorer sample. ボタンはグループに含まれています。 The group format is described in the NEWGROUPS_BEGIN-NEWGROUPS_END section. 次の使用例のエントリは読みやすくするためにインデントします。一般的な実装でコマンドの各エントリは 1 行に配置し、すべてのフィールドが並べの列にします。

最初のボタンエントリは、展開の File Explorer サンプルのすべての可能なパラメータを表示します。詳細については、「CMDS_SECTION-CMDS_END」を参照してください。

BUTTONS_BEGIN
// Buttons
    guidEUCmd:cmdidFileSysTool,                 // Command ID
          guidSHLMainMenu:IDG_VS_WNDO_WINDOWS2, // Group ID
          0xFF00,                               // Priority
          guidEUGrp:bmpidFileSysTool,           // Icon ID
          BUTTON,                               // Button Type
          0,                                    // Flags
          "&File System Browser",               // Command Text
          "&File System Browser",               // Menu Text
          "File System Browser",                // ToolTip Text
          "File System Browser",                // Command Well Text
          "FileSystemBrowser",                  // English Command Name
          "FileSystemBrowser";                  // Localized Command Name

// File Pane Commands
    guidEUCmd:cmdidFilesOpenFile,
        guidEUGrp:IDG_FILEPANE_COMMANDS,
        0x0010,  guidEUGrp:bmpidOpenFile,  BUTTON,
        DEFAULTDISABLED,
        "&Open";

// File Pane Arrange Cascading Menu Commands
    guidEUCmd:cmdidFilesSortName,
        guidEUGrp:IDG_FILEPANE_SORT,
        0x0010,  guidOfficeIcon:msotcidNoIcon,  BUTTON,
        0,
        "by &Name";
    guidEUCmd:cmdidFilesSortExtension,
        guidEUGrp:IDG_FILEPANE_SORT,
        0x0011,  guidOfficeIcon:msotcidNoIcon,  BUTTON,
        0,
        "by &Extension";

// Folder Pane Commands
    guidEUCmd:cmdidFolderView,
        guidEUGrp:IDG_FOLDERPANE_VIEW,
        0x0010,  guidEUGrp:bmpidFolderView,  BUTTON,
        0,
        "Folders";
    guidEUCmd:cmdidShortcutView,
        guidEUGrp:IDG_FOLDERPANE_VIEW,
        0x0011,  guidEUGrp:bmpidShortcutView,  BUTTON,
        0,
        "Shortcuts";
    guidEUCmd:cmdidAddShortcut,
        guidEUGrp:IDG_FOLDERCTX_SHORTCUT,
        0x0010,  guidEUGrp:bmpidAddShortcut,  BUTTON,
        DYNAMICVISIBILITY | DEFAULTINVISIBLE | DEFAULTDISABLED,
        "&Add Shortcut";

// Cascading menu commands
    guidEUCmd:cmdidDefineCommands,
        guidEUGrp:IDG_COMMANDS_DEFINE,
        0x0010,  guidOfficeIcon:msotcidNoIcon,  BUTTON,
        0,
        "&Define Commands...";
BUTTONS_END

Command フィールド

Each entry in the BUTTONS_BEGIN – BUTTONS_END section contains up to twelve fields, which are described here.

Command ID

Command ID フィールドは新しいを作成するコマンドは、識別します。 Command ID は常に、GUID:ID ペアであり、コマンドを一意に識別。 ID は他のコマンド、] メニューの [または、同じ GUID を持つグループに関連付けられている ID を異なるにする必要があります。

このコード例の Command ID フィールドの一部が。
```
guidEUCmd:cmdidFileSysTool
guidEUCmd:cmdidFilesOpenFile
guidEUCmd:cmdidFilesSortName
guidEUCmd:cmdidFilesSortExtension
guidEUCmd:cmdidFolderView
```
Group ID

Group ID フィールドには、 GUID:ID ペアとして所属するコマンドをするプライマリグループを指定します。このフィールドは空白には。

このコード例の Group ID パラメータの一部が。
```
guidSHLMainMenu:IDG_VS_WNDO_WINDOWS2
guidEUGrp:IDG_FILEPANE_COMMANDS
guidEUGrp:IDG_FILEPANE_SORT
guidEUGrp:IDG_FILEPANE_SORT
guidEUGrp:IDG_FOLDERPANE_VIEW
```
プライマリグループ、なしのコマンドを作成するいずれかである必要があります自己ホスト型には使用コマンド ID その親グループとしてのインスタンス。

guidEUCmd:cmdidFileSysTool, guidEUCmd:cmdidFileSysTool, ...

または、ボタンの GUID 、 0: の ID を使用

guidEUCmd:cmdidFileSysTool, guidEUCmd:0, ...

If a command does not have a primary group, it must be placed on a menu or toolbar with an entry in the CMDPLACEMENT_SECTION-CMDPLACEMENT_END section; otherwise, it does not appear in the environment.
Priority

Priority フィールドには] で他のアイテムの基準に指定したグループ内コマンドの配置を指定します。低い優先順位値を持つアイテムは、大きなの優先順位値のアイテムの前に表示されます。このフィールドは空白には。

例の Priority フィールドの一部が。
```
0x0010
0x0011
```
When a command's placement is defined in the CMDPLACEMENT_SECTION-CMDPLACEMENT_END section, the priority value specified here is ignored in favor of that specified by the entry in the CMDPLACEMENT_SECTION – CMDPLACEMENT_END section.

2 つのコマンドが同じ優先順位、コマンドは定義されているが表示最初されます] で、前に。
Icon ID

Icon ID フィールドには、 GUID:ID ペアを使用して、コマンドで関連付けられているアイコンの識別子を指定します。このフィールドは空白には。

提供され、GUID の GuidOfficeIcon が使用される場合はアクセスビットマップの標準セットです。この場合、環境には、対応するアイコンの識別子の Visual Studio SDK リソースファイル検索されます。 These identifiers are defined in the Msobtnid.h header file in the \Program Files\VSIP\EnvSDK\common\inc\office10 folder.

コマンドは、アイコン、必要はない場合は、guidOfficeIcon:msotcidNoIcon を指定します。

Visual Studio SDK で、プロジェクトのリソースファイルによっては、作成カスタムアイコンのすることができます。 These must be added to a project using the BITMAPS_BEGIN-BITMAPS_END section of the .ctc file.

For further information on how to create custom bitmap icon resources and include them in a project, see BITMAPS_BEGIN-BITMAPS_END. Visual Studio 2005 SDK でビットマップのリソースにあります管理パッケージです。詳細については、「マネージ VSPackage のリソース」を参照してください。

このコード例の Icon ID フィールドの一部が。
```
guidEUGrp:bmpidFileSysTool
guidEUGrp:bmpidOpenFile
guidOfficeIcon:msotcidNoIcon
guidEUGrp:bmpidFolderView
guidEUGrp:bmpidShortcutView
```

Button Type

Button Type フィールドには、大文字と小文字を区別しないありされる実装されているコマンドの種類を指定します。 Button Type フィールドが空白の場合の種類既定 Button。次のすべてのコマンドの例では、型 Button のですが、Command Table 4 種類をサポートしています、次の表に詳細なコマンド。

[ボタンの種類]	説明
Button	標準表示されるコマンドツールバー (通常、アイコンのボタンと)、メニューのおよびショートカットメニュー。
MenuButton	メニューアイテム、コマンドを実行しませんを別のメニューが生成します。
SplitDropDown	コントロール、UndoまたはRedo のような Microsoft Word で標準ツールバーのボタンをします。
Swatch	フォントの色] ダイアログボックスなど、色の選択肢を表示するコントロール。一部の基になるインターフェイスの実装が必要です。

Flags

Flags フィールドには、大文字と小文字を区別しないあり、コマンドボタンに配置できますする属性を指定します。 Flags フィールドが空白の場合 [コマンドは、デフォルトで有効になっていると表示されています。使用して複数のフラグを指定する、| (OR) 演算子。たとえば、NoKeyCustomize | NoButtonCustomize です。次の表は、フラグの一覧に Visual Studio をサポートします。

フラグ	説明
NoKeyCustomize	キーボードのユーザー設定を許可しません。
NoButtonCustomize	ユーザーをこのボタンをカスタマイズできません。
NoCustomize	NoKeyCustomize と NoButtonCustomize フラグの両方の組み合わせです。
Pict	ツールバー、メニューにテキストのみにアイコンのみを表示します。アイコンが指定したなし場合、ツールバーの [選択可能な空白を表示します。
TextOnly	テキストのみ、ツールバーまたはメニューアイコンなしにも表示のアイコンを指定します。
IconAndText	メニューおよびツールバーには、アイコンおよびテキストを示します。
TextContextUseButton	コンテキストメニューには、Button Text フィールドを使用します。既定の指定されている場合は、Menu Text フィールドにします。
TextMenuUseButton	メニューの Command Text フィールドを使用します。既定の指定されている場合は、Menu Text フィールドにします。
TextMenuCtrlUseMenu	メニューの [コントローラ上で Menu Text フィールドを使用します。既定値は、Command Text フィールドです。
TextCascadeUseButton	連鎖メニューで Command Text フィールドを使用します。既定の指定されている場合は、Menu Text フィールドにします。
TextChanges	コマンドのテキストを変更時、通常、QueryStatus メソッドを使用します。
DefaultDisabled	既定では、コマンドを実装する VSPackage が読み込まれていないか、QueryStatus メソッドが呼び出されなかった場合] が無効になります。
DefaultInvisible	デフォルトでは、コマンドを実装する VSPackage が読み込まれていないか、QueryStatus メソッドが呼び出されなかった場合に、コマンドは非表示です。これは、DynamicVisibility フラグと組み合わせる必要があります。
DynamicVisibility	The command's visibility can be changed through the QueryStatus method or through a context GUID placed in the VISIBILITY_SECTION-VISIBILITY_END section. これは、メニューのツールバーではなく表示されるコマンドに適用されます。トップレベルのツールバーの項目は無効になっているされますが、非表示でなく、OLECMDF_INVISIBLE フラグは、 QueryStatus メソッドから返されたとき。このフラグは、DefaultInvisible フラグと組み合わせる必要があります。
DynamicItemStart	動的な一覧の先頭を示します。これにより、環境順次メソッドを呼び出して QueryStatus リストのアイテムに、 OLECMDERR_E_UNSUPPORTED フラグが返されるまで、リストを作成します。これは、アイテムのなどと動作最近使った (MRU) のリストとウィンドウリストします。
CommandWellOnly	このフラグ場合適用、コマンドは、トップレベルメニュー表示されず、他のシェルのカスタマイズに利用できるようにするたとえば、そのキーにバインドします。 After the VSPackage is installed you may customize these commands by opening the Options dialog box from the Tools menu and editing the command placement under the Keyboard Environment category. このフラグは、コンテキストメニューのツールバー、メニューの [コントローラ、または連鎖メニューでの配置を影響しません。
AllowParams	入力できるコマンドのパラメータコマンドプロンプトウィンドウで、コマンドの正規名を入力するときを示します。
PostExec	コマンド以外のブロックにより。処理前のすべてのクエリが完了するまで、環境の実行を延期します。
DontCache	環境にこのコマンドを実行するため、QueryStatus メソッドの結果キャッシュしません。
FixMenuController	このコマンドは、メニューの [コントローラに配置] コマンドは常に既定値は、コマンドを常になって自体] メニューの [コントローラのボタンが選択されたときに。メニューの [コントローラに、TextIsAnchorCommand フラグを設定が場合、し、メニューの [コントローラもが FixMenuController フラグを使ってコマンドからそのテキスト。 See the MENUS_BEGIN-MENUS_END section for more details on the TextIsAnchorCommand flag. FixMenuController フラグが付いているメニューの [コントローラ上でコマンドを 1 つだけ必要があります。のでマークされている 1 つ以上のコマンドが、メニューの [最後のコマンドが既定のコマンドになります。
NoShowOnMenuController	このコマンドがメニューの [コントローラ上で配置されて、いる場合、ドロップダウンリストに、コマンドは表示されません。
RouteToDocs	コマンドは、作業中の文書にルーティングされます。

例の Flags フィールドは。

DYNAMICVISIBILITY
DEFAULTINVISIBLE
DEFAULTDISABLED
DEFAULTDISABLED
0

Button Text

このフィールドとコマンド定義で 5 つ以下のテキストフィールド使用表示するテキストをさまざまなメニューで指定できます。 Button Text フィールドを既定でが表示されます] メニューの [コントローラです。 Button Text フィールドには、他のテキストフィールドが空白の場合にも、既定をなります。 Button Text フィールドは空白には、他のテキストフィールドを指定している場合でも。

テキスト文字列内でアンパサンドでは、コマンドのショートカットを指定します。例の Button Text フィールドの一部が。
```
"&Open"
"by &Name"
"by &Extension"
"&Define Commands..."
```
Menu Text

Menu Text フィールドには、ツールバー、コンテキストメニュー、または、連鎖メニュー場合コマンドの表示テキスト指定します。 Menu Text フィールドが空白の場合、環境が Button Text フィールドを使用します。 Menu Text フィールドもローカライズ使用されます。上記の例で、Menu Text フィールドが指定されていない、 Button Text フィールドが、既定になりますようにします。
ToolTip Text

ToolTip Text フィールドは表示されるテキスト] メニューの [項目のヒントで指定します。 ToolTip Text フィールドが空白の場合は、 Button Text フィールドが使用されます。例で、ToolTip Text フィールドは使用されません、ヒントテキストは、 Button Text フィールドに既定ように。
Command Well Text

The Command Well TExt field specifies the text that appears in the keyboard category in the Options dialog box (available by selecting Options from the Tools menu) and the Commands list in the Customize dialog box (available by selecting Customize from the Tools menu). 例で、Command Well Text フィールドは使用されません、 Command Well Text 、 Button Text フィールドの既定値に。
English Command Name

English Command Name フィールドには、 メニュー項目を実行するコマンドウィンドウ で入力できる英語のテキストでコマンドの名前を指定します。環境は、文字、数字、アンダースコア (_)、または埋め込まれた期間にない文字除外実行します。このテキストは、[コマンドを定義する、メニューの [の Button Text フィールドに連結されます。たとえば、ファイル メニューから [新しいプロジェクト が、コマンドを File.NewProject になります。

English Command Name フィールドが指定されていない場合、環境は、 Button Text フィールド、stripping がすべてが文字、数字、アンダースコア (_)、および埋め込みの期間を使用します。 For example, the Button Text "&Define Commands..." becomes DefineCommands, where the ampersand, the space, and the ellipsis are removed.

TextChanges フラグが指定し、コマンドのテキストは変更、コマンドウィンドウの によって認識対応するコマンドと は変更されません。標準の形式、元の Button Text または English Command Name フィールドのままになります。このトピックの先頭に設定例コマンドではコマンド English Command Name の guidEUCmd:cmdidFile バージョンが FileSystemBrowser。
Localized Command Name

Localized Command Name フィールドの動作と同様、 English Command Name フィールドには、ローカライズ版のコマンドテキストを指定できます。両方の標準フィールドを指定できます。環境だけで、コマンドウィンドウに入力されたテキストを解析とためコマンドに関連付けます、両方英語と英語以外の文字列できますに関連付けられる同じコマンド。

参照

概念

VSPackage の IDE にユーザーインターフェイス要素を追加する方法

Share via

BUTTONS_BEGIN-BUTTONS_END

コマンドボタン

コマンドの使用例 (VB)

Command フィールド

参照

概念

その他のリソース

Share via

BUTTONS_BEGIN-BUTTONS_END

コマンド ボタン

コマンドの使用例 (VB)

Command フィールド

参照

概念

その他のリソース

コマンドボタン