Méthode OnCommand de l’interface ICommandEvents

Cette méthode est implémentée côté client. Elle est appelée par ABBYY FineReader Engine avant l’exécution d’une commande dans Image Viewer, Zoom Viewer, Text Editor ou Document Viewer.

Consultez la liste des commandes disponibles et la manière dont elles peuvent être utilisées dans chaque composant :

• Commandes d’Image Viewer
• Commandes de Zoom Viewer
• Commandes de Document Viewer
• Commandes de Text Editor

Cette méthode fournit au client des informations sur la commande qui va être exécutée. Elle permet également d’annuler l’opération.

​

Syntaxe

​

C++

HRESULT OnCommand(
  MenuItemEnum  MenuItem,
  VARIANT_BOOL* Cancel
);

​

C#

void OnCommand(
  MenuItemEnum MenuItem,
  out bool     Cancel
);

​

Visual Basic .NET

Sub OnCommand( _
  MenuItem As MenuItemEnum, _
  ByRef Cancel As Boolean _
)

​

Paramètres

MenuItem

[in] Cette variable de type MenuItemEnum indique la commande appelée.

Cancel

[out] Vous pouvez définir cette variable sur TRUE pour indiquer que le processus doit être interrompu. Dans ce cas, la commande ne sera pas exécutée.

​

Valeurs de retour

[C++ uniquement] Si cette méthode renvoie une valeur autre que S_OK, cela indique qu’une erreur s’est produite du côté client et, dans ce cas, la valeur du paramètre Cancel n’est pas prise en compte.

​

Remarques

L’implémentation du client de cette méthode doit garantir que toutes les exceptions levées au sein de la méthode sont interceptées et gérées, et qu’aucune n’est propagée à l’extérieur de la méthode. La propagation d’une exception en dehors de la méthode peut entraîner des résultats imprévisibles (par exemple, l’arrêt du programme).

​

Voir aussi

ICommandEvents

Personnalisation du menu contextuel et de la barre d’outils d’un composant visuel