RegisterUserCommand Method of the Commands Object

This method registers a user-defined command. The command further may be added to a toolbar or executed using the ICommands::DoCommand method.



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


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 _


[in] Specifies the ID assigned to the user command as a MenuItemEnum constant. Can have values MI_CustomCommand1, ... , MI_CustomCommand10.
[in] Specifies the text of the user command.
[in] Specifies the path to the file containing a BMP picture of 16х16 size that will be used as the icon for the command.
[in] Specifies the hot key for the command. The parameter has the same format as the returned value (LRESULT) of the Windows SendMessage function for the HKM_GETHOTKEY message sent. To obtain the hot key value in this format, you should pack the virtual key code of the hot key to the low-order byte of the value, and the key modifier that specifies the keys that define a hot key combination to the high-order byte. If you do not need to use a hot key for the command, pass 0 to this parameter. If another command uses this hot key, an error is returned. You can check availability of a hot key using the ICommands::HasHotKey method.

Return values

This method has no specific return values. It returns the standard return values of ABBYY FineReader Engine functions.

See also




24.03.2023 8:51:52

Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.