Commands オブジェクトの RegisterUserCommand メソッド

このメソッドでは、ユーザー定義コマンドを登録します。登録したコマンドは、ツールバーに追加することも、ICommands::DoCommand メソッドで実行することもできます。

​

構文

​

C++

HRESULT RegisterUserCommand(
  MenuItemEnum CommandId,
  BSTR         CommandText,
  BSTR         IconPath,
  int          HotKey
);

​

C#

void RegisterUserCommand(
  MenuItemEnum CommandId,
  string       CommandText,
  string       IconPath,
  int          HotKey
);

​

Visual Basic .NET

Sub RegisterUserCommand( _
  CommandId As MenuItemEnum, _
  CommandText As String, _
  IconPath As String, _
  HotKey As Integer _
)

​

パラメーター

CommandId

[in] ユーザーコマンドに割り当てられた ID を、MenuItemEnum 定数として指定します。指定できる値は MI_CustomCommand1, … , MI_CustomCommand10 です。

CommandText

[in] ユーザーコマンドのテキストを指定します。

IconPath

[in] コマンドのアイコンとして使用する、16×16 サイズの BMP 画像を含むファイルへのパスを指定します。

HotKey

[in] コマンドのホットキーを指定します。このパラメーターは、Windows の SendMessage 関数に HKM_GETHOTKEY メッセージを送信したときの戻り値 (LRESULT) と同じ形式です。この形式でホットキー値を取得するには、ホットキーの仮想キー コードを値の下位バイトに、ホットキーの組み合わせを定義するキー修飾子を上位バイトに格納する必要があります。コマンドにホットキーを使用しない場合は、このパラメーターに 0 を渡します。別のコマンドがこのホットキーを使用している場合は、エラーが返されます。ICommands::HasHotKey メソッドを使用して、ホットキーが使用可能かどうかを確認できます。

​

戻り値

このメソッドには特定の戻り値はありません。代わりに、ABBYY FineReader Engine 関数の標準的な戻り値が返されます。

​

関連項目

コマンド

UnregisterUserCommand

MenuItemEnum