Passer au contenu principal
Cette méthode enregistre une commande définie par l’utilisateur. Cette commande peut ensuite être ajoutée à une barre d’outils ou exécutée à l’aide de la méthode ICommands::DoCommand.

​
Syntaxe

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

​
Paramètres

CommandId [in] Spécifie l’ID attribué à la commande utilisateur sous la forme d’une constante MenuItemEnum. Peut prendre les valeurs MI_CustomCommand1, … , MI_CustomCommand10. CommandText [in] Spécifie le texte de la commande utilisateur. IconPath [in] Spécifie le chemin d’accès au fichier contenant une image BMP de 16х16 qui sera utilisée comme icône de la commande. HotKey [in] Spécifie le raccourci clavier de la commande. Le paramètre a le même format que la valeur renvoyée (LRESULT) par la fonction Windows SendMessage pour le message HKM_GETHOTKEY. Pour obtenir la valeur du raccourci clavier dans ce format, vous devez placer le code de touche virtuelle du raccourci clavier dans l’octet de poids faible de la valeur, et le modificateur indiquant les touches qui définissent une combinaison de raccourci clavier dans l’octet de poids fort. Si vous n’avez pas besoin d’utiliser de raccourci clavier pour la commande, transmettez 0 à ce paramètre. Si ce raccourci clavier est déjà utilisé par une autre commande, une erreur est renvoyée. Vous pouvez vérifier la disponibilité d’un raccourci clavier à l’aide de la méthode ICommands::HasHotKey.

​
Valeurs de retour

Cette méthode n’a pas de valeur de retour spécifique. Elle renvoie les valeurs de retour standard des fonctions ABBYY FineReader Engine.

​
Voir aussi

Commands UnregisterUserCommand MenuItemEnum