RegisterUserCommand-Methode des Objekts Commands

RegisterUserCommand-Methode des Objekts Commands in ABBYY FineReader Engine Visual Components unter Windows — Mit dieser Methode wird ein benutzerdefinierter Befehl registriert.

Mit dieser Methode wird ein benutzerdefinierter Befehl registriert. Der Befehl kann außerdem zu einer Symbolleiste hinzugefügt oder mit der Methode ICommands::DoCommand ausgeführt werden.

​

Syntax

​

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 _
)

​

Parameter

CommandId

[in] Gibt die ID an, die dem Benutzerbefehl als Konstante der MenuItemEnum zugewiesen ist. Kann die Werte MI_CustomCommand1, … , MI_CustomCommand10 annehmen.

CommandText

[in] Gibt den Text des Benutzerbefehls an.

IconPath

[in] Gibt den Pfad zur Datei an, die ein BMP-Bild in der Größe 16х16 enthält und als Symbol für den Befehl verwendet wird.

HotKey

[in] Gibt die Tastenkombination für den Befehl an. Der Parameter hat dasselbe Format wie der Rückgabewert (LRESULT) der Windows-Funktion SendMessage für die gesendete Nachricht HKM_GETHOTKEY. Um den Wert der Tastenkombination in diesem Format zu erhalten, müssen Sie den virtuellen Tastencode der Tastenkombination in das Low-Order-Byte des Werts und den Tastenmodifikator, der die Tasten der Tastenkombination festlegt, in das High-Order-Byte packen. Wenn Sie für den Befehl keine Tastenkombination verwenden möchten, übergeben Sie 0 an diesen Parameter. Wenn ein anderer Befehl diese Tastenkombination verwendet, wird ein Fehler zurückgegeben. Sie können die Verfügbarkeit einer Tastenkombination mit der Methode ICommands::HasHotKey prüfen.

​

Rückgabewerte

Diese Methode hat keine spezifischen Rückgabewerte. Sie gibt die Standardrückgabewerte von ABBYY FineReader Engine-Funktionen zurück.

​

Siehe auch

Commands

UnregisterUserCommand

MenuItemEnum