On User Command - ABBYY Documentation

When it is launched

The event occurs when a user command is called, provided that a corresponding item is added to the main menu or the toolbar. User command identifiers have the form CI_UserCommand + <non-negative integer>.

Parameters

Name	Type	Access	Description
CommandId	TCommandID	Read/write	The identifier of the user command.
Context	IMainWindow	Read/write	The main window of the application.

To add a user command to the main menu or the toolbar, use the AppendItem or InsertItem and AppendButton or InsertButton methods of the IMenu and IToolbar interfaces respectively. Use the command identifier CI_UserCommand or CI_UserCommand + <non-negative integer>. The following sample code adds a menu item for a user command with the command identifier CI_UserCommand + 1.

ABBYY.FlexiCapture.ClientUI.TCommandID userCommand = ABBYY.FlexiCapture.ClientUI.TCommandID.CI_UserCommand;
ABBYY.FlexiCapture.ClientUI.TCommandID userCommand1 = (ABBYY.FlexiCapture.ClientUI.TCommandID) ((int)userCommand + 1);
IMenu menu = MainWindow.MainMenu[0].Submenu;
menu.AppendItem( userCommand1, "User command" );

A toolbar button or menu item added for a user command is disabled unless a handler for the On User Command event is added. The following sample code processes the On User Command event.

ABBYY.FlexiCapture.ClientUI.TCommandID commandID = ( ABBYY.FlexiCapture.ClientUI.TCommandID )( CommandId );
ABBYY.FlexiCapture.ClientUI.TCommandID userCommand = ABBYY.FlexiCapture.ClientUI.TCommandID.CI_UserCommand;
ABBYY.FlexiCapture.ClientUI.TCommandID userCommand1 = (ABBYY.FlexiCapture.ClientUI.TCommandID) ((int)userCommand + 1);
if( commandID == userCommand1 ) {
<... call necessary methods here ...>

​When it is launched

​Parameters

When it is launched

Parameters