ABBYY FineReaderEngine

Guide d’utilisation

ABBYY

Ce tutoriel vous apprend à utiliser certaines fonctionnalités du kit de développement ABBYY FineReaderEngine. Commentez

- Titre : ABBYY FineReaderEngine

- Auteur : ABBYY

- Parution : 16 septembre 2020

- Licence : Les sources présentées sur cette page sont libres de droits et vous pouvez les utiliser à votre convenance. Par contre, la page de présentation constitue une œuvre intellectuelle protégée par les droits d'auteur. Copyright ® 2020 ABBYY. Aucune reproduction, même partielle, ne peut être faite de ce site et de l'ensemble de son contenu : textes, documents, images, etc. sans l'autorisation expresse de l'auteur. Sinon vous encourez selon la loi jusqu'à trois ans de prison et jusqu'à 300 000 € de dommages et intérêts.

Sommaire

- I. Méthode CenterOnDocumentPoint de l'objet ImageViewer

- I-A. Syntaxe

- I-B. Paramètres

- I-C. Valeurs de retour

- II. Méthode DocumentToScreen de l'objet ImageViewer

- II-A. Syntaxe

- II-B. Paramètres

- II-C. Valeurs de retour

- III. Méthode GetSelectedBlocksIndices de l'objet ImageViewer

- III-A. Syntaxe

- III-B. Paramètres

- III-C. Valeurs de retour

- IV. Méthode GetSelectedCells de l'objet ImageViewer

- IV-A. Syntaxe

- IV-B. Paramètres

- IV-C. Valeurs de retour

- V. Méthode d'impression de l'objet ImageViewer

- V-A. Valeurs de retour

- VI. Méthode ScreenToDocument de l'objet ImageViewer

- VI-A. Syntaxe

- VI-B. Paramètres

- VI-C. Valeurs de retour

- VII. Méthode SetSelectedBlocksIndices de l'objet ImageViewer

- VII-A. Syntaxe

- VII-B. Paramètres

- VII-C. Valeurs de retour

- VIII. Méthode SetSelectedCells de l'objet ImageViewer

- VIII-A. Syntaxe

- VIII-B. Paramètres

- VIII-C. Valeurs de retour

- IX. Méthode ShowDocumentArea de l'objet ImageViewer

- IX-A. Syntaxe

- IX-B. Paramètres

- IX-C. Valeurs de retour

- X. Méthode UpdateOptions de l'objet ImageViewer

- X-A. Syntaxe

- X-B. Valeurs de retour

- XI. Objet ZoomViewer (interface IZoomViewer)

- XI-A. Échantillons

- XII. Commandes de Zoom Viewer

- XIII. Méthode DocumentToScreen de l'objet ZoomViewer

- XIII-A. Syntaxe

- XIII-B. Paramètres

- XIII-C. Valeurs de retour

- XIV. Méthode GetSelectedBlocksIndices de l'objet ZoomViewer

- XIV-A. Syntaxe

- XIV-B. Paramètres

- XIV-C. Valeurs de retour

- XV. Méthode GetSelectedCells de l'objet ZoomViewer

- XV-A. Syntaxe

- XV-B. Paramètres

- XV-C. Valeurs de retour

- XVI. Méthode ScreenToDocument de l'objet ZoomViewer

- XVI-A. Syntaxe

- XVII. Paramètres

- XVII-A. Valeurs de retour

- XVIII. Méthode SetSelectedBlocksIndices de l'objet ZoomViewer

- XVIII-A. Syntax

- XVIII-B. Paramètres

- XVIII-C. Valeurs de retour

- XVIII-D. Méthode SetSelectedCells de l'objet ZoomViewer

- XVIII-E. Syntax

- XVIII-F. Paramètres

- XVIII-G. Valeurs de retour

- XIX. Méthode ShowDocumentArea de l'objet ZoomViewer

- XIX-A. Paramètres

- XIX-B. Valeurs de retour

- XX. Méthode UpdateOptions de l'objet ZoomViewer

- XX-A. Syntaxe

- XX-B. Valeurs de retour

- XXI. DocumentViewer Object (interface IDocumentViewer)

I - Méthode CenterOnDocumentPoint de l'objet ImageViewer

Cette méthode fait défiler la vue de l'image de sorte que le point spécifié soit positionné au centre de la vue.0

I-A - Syntaxe

C++

HRESULT CenterOnDocumentPoint( int X, int Y );

C#

void CenterOnDocumentPoint( int X, int Y );

Visual Basic .Net

Sub CenterOnDocumentPoint(X As Integer, Y As Integer)

I-B - Paramètres

- X

[in] Spécifie la coordonnée horizontale du point en pixels. Les coordonnées sont relatives à l'image du document.

- Y

[in] Spécifie la coordonnée verticale du point en pixels. Les coordonnées sont relatives à l'image du document.

I-C - Valeurs de retour

Cette méthode n'a pas de valeurs de retour spécifiques. Elle renvoie les valeurs de retour standard des fonctions du moteur ABBYY FineReader.

II - Méthode DocumentToScreen de l'objet ImageViewer

Cette méthode convertit les coordonnées du point spécifié sur l'image du document en coordonnées d'écran.

II-A - Syntaxe

C++

HRESULT DocumentToScreen(
int DocumentX,
int DocumentY,
int* ScreenX,
int* ScreenY
);

C#

void DocumentToScreen(
int DocumentX,
int DocumentY,
out int ScreenX,
out int ScreenY
) ;

Visual Basic .Net

Sub DocumentToScreen( _
DocumentX As Integer, _
DocumentY As Integer, _
ScreenX As Integer, _
ScreenY As Integer _
)

II-B - Paramètres

- DocumentX

[in] Spécifie la coordonnée horizontale du point sur l'image du document.

- DocumentY

[in] Spécifie la coordonnée verticale du point sur l'image du document.

- ScreenX

[out] Reçoit la coordonnée horizontale du point en coordonnées d'écran.

- ScreenY

[out] Reçoit la coordonnée verticale du point en coordonnées d'écran.

II-C - Valeurs de retour

Cette méthode n'a pas de valeurs de retour spécifiques. Elle renvoie les valeurs de retour standard des fonctions du moteur ABBYY FineReader.

III - Méthode GetSelectedBlocksIndices de l'objet ImageViewer

Cette méthode retourne la collecte des indices des blocs sélectionnés.

III-A - Syntaxe

C++

HRESULT GetSelectedBlocksIndices( IIntsCollection** indices );

C#

GetSelectedBlocksIndices();

III-B - Paramètres

- indices

[ out, retval ] Donne accès à l'objet IntsCollection qui contient les index des blocs sélectionnés.

III-C - Valeurs de retour

Cette méthode n'a pas de valeurs de retour spécifiques. Elle renvoie les valeurs de retour standard des fonctions du moteur ABBYY FineReader.

IV - Méthode GetSelectedCells de l'objet ImageViewer

Cette méthode renvoie le rectangle environnant des cellules sélectionnées dans le bloc tableau spécifié.

IV-A - Syntaxe

C++

HRESULT GetSelectedCells(
int blockIndex,
IFRRectangle** selectedCells
);

C#

IFRRectangle GetSelectedCells( int blockIndex );

Visual Basic .Net

Function GetSelectedCells(blockIndex As Integer) As IFRRectangle

IV-B - Paramètres

- blockIndex

[in] Spécifie l'index d'un bloc de table. L'index se trouve dans la collection ILayout::VisualBlocks.

- selectedCells

[out, retval] Donne accès à l'objet FRRectangle retourné qui contient les coordonnées du rectangle environnant des cellules sélectionnées. Les coordonnées sont définies dans une grille de base.

IV-C - Valeurs de retour

Cette méthode n'a pas de valeurs de retour spécifiques. Elle renvoie les valeurs de retour standard des fonctions du moteur ABBYY FineReader.

Remarques

Par grille de base, nous entendons ici la grille formée par les bordures et les séparateurs des tableaux. Chaque séparateur vertical incrémente la coordonnée horizontale d'une unité, et chaque séparateur horizontal incrémente la coordonnée verticale d'une unité. Les axes des coordonnées sont orientés de gauche à droite et de haut en bas.

V - Méthode d'impression de l'objet ImageViewer

Cette méthode vous permet d'imprimer l'image.

C++

HRESULT Print();

C#

void Print();

Visual Basic .Net

Sub Print()

V-A - Valeurs de retour

Cette méthode n'a pas de valeurs de retour spécifiques. Elle renvoie les valeurs de retour standard des fonctions du moteur ABBYY FineReader.

VI - Méthode ScreenToDocument de l'objet ImageViewer

Cette méthode convertit les coordonnées d'écran du point spécifié en coordonnées sur l'image du document.

VI-A - Syntaxe

C++

HRESULT ScreenToDocument(
int ScreenX,
int ScreenY,
int* DocumentX,
int* DocumentY
);

C#

void ScreenToDocument(
int ScreenX,
int ScreenY,
out int DocumentX,
out int DocumentY
);

Visual Basic .Net

Sub ScreenToDocument(
ScreenX As Integer, _
ScreenY As Integer, _
DocumentX As Integer, _
DocumentY As Integer _
)

VI-B - Paramètres

- ScreenX

[in] Spécifie la coordonnée horizontale du point en coordonnées d'écran.

- ScreenY

[in] Spécifie la coordonnée verticale du point en coordonnées d'écran.

- DocumentX

[out] Reçoit la coordonnée horizontale du point sur l'image du document.

- DocumentY

[out] Reçoit la coordonnée verticale du point sur l'image du document.

VI-C - Valeurs de retour

Cette méthode n'a pas de valeurs de retour spécifiques. Elle renvoie les valeurs de retour standard des fonctions du moteur ABBYY FineReader.

VII - Méthode SetSelectedBlocksIndices de l'objet ImageViewer

Cette méthode vous permet de définir la sélection des blocs.

VII-A - Syntaxe

C++

HRESULT SetSelectedBlocksIndices( IIntsCollection* indices );

C#

void SetSelectedBlocksIndices( IIntsCollection indices );

VII-B - Paramètres

- indices

[in] Fait référence à l'objet IntsCollection qui contient l'ensemble des indices des blocs à sélectionner.

VII-C - Valeurs de retour

Cette méthode n'a pas de valeurs de retour spécifiques. Elle renvoie les valeurs de retour standard des fonctions du moteur ABBYY FineReader.

VIII - Méthode SetSelectedCells de l'objet ImageViewer

Cette méthode vous permet de définir des cellules sélectionnées d'un bloc tableau.

VIII-A - Syntaxe

C++

HRESULT SetSelectedCells(
int blockIndex,
IFRRectangle* selectedCells
);

C#

void SetSelectedCells(
int blockIndex,
IFRRectangle selectedCells
);

Visual Basic .Net

Sub SetSelectedCells( _
blockIndex As Integer, _
selectedCells As IFRRectangle _
)

VIII-B - Paramètres

- blockIndex

[in] Spécifie l'index d'un bloc de table. L'index se trouve dans la collection ILayout::VisualBlocks.

- selectedCells

[in] Fait référence à l'objet FRRectangle qui spécifie les coordonnées du rectangle environnant des cellules à sélectionner. Les coordonnées sont définies dans une grille de base.

VIII-C - Valeurs de retour

Cette méthode n'a pas de valeurs de retour spécifiques. Elle renvoie les valeurs de retour standard d'ABBYY FineReader Fonctions du moteur.

Remarques

Par grille de base, nous entendons ici la grille formée par les bordures et les séparateurs des tableaux. Chaque verticale incrémente la coordonnée horizontale d'une unité, et chaque séparateur horizontal incrémente la coordonnée verticale par un. Les axes de coordonnées sont orientés de gauche à droite et de haut en bas.

IX - Méthode ShowDocumentArea de l'objet ImageViewer

Cette méthode vous permet de faire défiler l'image de manière à ce que la zone du document aux coordonnées spécifiées devient visible (dans la mesure du possible).

IX-A - Syntaxe

C++

HRESULT ShowDocumentArea( IFRRectangle* Value );

C#

void ShowDocumentArea( IFRRectangle Value );

Visual Basic .Net

Sub ShowDocumentArea(Value As IFRRectangle)

IX-B - Paramètres

- Valeur

[in] Fait référence à l'objet FRRectangle qui spécifie les coordonnées de la zone du document en pixels. Les coordonnées sont relatives à l'image du document.

IX-C - Valeurs de retour

Cette méthode n'a pas de valeurs de retour spécifiques. Elle renvoie les valeurs de retour standard des fonctions du moteur ABBYY FineReader.

X - Méthode UpdateOptions de l'objet ImageViewer

Cette méthode met à jour les paramètres spécifiés dans la boîte de dialogue Options de Image Viewer. Vous pouvez avoir besoin d'appeler cette méthode, si les options ont été modifiées dans un autre composant visuel, pour mettre à jour le de l'Image Viewer à l'état actuel.

Note : La boîte de dialogue Options peut être affichée si la commande MI_Options est appelée dans Image Viewer, Zoom Viewer, Text Editor, ou Document Viewer, si le bouton Options est cliqué dans la boîte de dialogue Enregistrer sous Document Viewer, ou si vous cliquez sur Paramètres > Options dans Text Validator.

X-A - Syntaxe

C++

HRESULT UpdateOptions();

C#

void UpdateOptions();

Visual Basic .Net

Sub UpdateOptions()

X-B - Valeurs de retour

Cette méthode n'a pas de valeurs de retour spécifiques. Elle renvoie les valeurs de retour standard d'ABBYY FineReader Fonctions du moteur.

XI - Objet ZoomViewer (interface IZoomViewer)

L'objet Zoom Viewer est un contrôle ActiveX qui vous permet de visualiser une image agrandie de la ligne ou zone d'image traitée en cours d'édition. Alors que l’Image Viewer affiche la vue générale de la page, le Zoom Viewer permet de visualiser l'image de manière plus détaillée, d'ajuster la position de la zone ou de comparer caractères incertains avec l'image agrandie. Une image est connectée à Zoom Viewer via la propriété FRPage.

Le composant Zoom Viewer ressemble à ceci :

Vous pouvez modifier l'apparence du composant via ses propriétés. Par exemple, vous pouvez modifier le menu contextuel du composant via la propriété Commandes.

Les informations relatives à la visualisation d'une image sont communiquées par des interfaces de sortie spéciales. Ces interfaces sont IZoomViewerEvents (pour C++) et une interface de sortie DIZoomViewerEvents (pour Visual Basic).

Il convient de noter que les utilisateurs de Visual Basic ne doivent pas se soucier des détails de la mise en œuvre des interfaces d'événements car cette plateforme de développement offre des moyens faciles de les manipuler. Cet objet peut être déclaré WithEvents en Visual Basic.

Pour l'utilisateur C++, cela signifie qu'il prend en charge l'interface IConnectionPointContainer. Pour recevoir des notifications, un utilisateur C++ doit créer un objet dérivé de l'interface IZoomViewerEvents, puis établir la connexion entre celui-ci et la source d'événements implémentée dans l'objet ZoomViewer par défaut COM signifie.

Le composant Zoom Viewer peut être connecté au composant Component Synchronizer, auquel cas tous les événements dans Zoom Viewer seront automatiquement transmis à d'autres composants connectés au synchroniseur et l'ensemble de l'application fonctionnera de manière synchrone.

Propriétes

Nom

Type

Descriptif

ActiveTool

BoxEditorToolEnum

Spécifie l'outil actif pour les blocs et l'édition d'images.

BottomPaneEnabled

VARIANT_BOOL

Spécifie si le volet inférieur de Zoom Viewer est activé. Si cette propriété est FAUSSE, le volet inférieur n'est pas affiché. Par défaut, la valeur est TRUE.

ContextMenuEnabled

VARIANT_BOOL

Indique si le menu contextuel de Zoom Viewer est activé. Si cette propriété est FAUSSE, le menu contextuel n'est jamais affiché. Par défaut, la valeur est TRUE.

Commands

Commands, read-only

Permet d'accéder aux commandes disponibles dans Zoom Viewer. Voir la liste des commandes disponibles dans Zoom Viewer.

FRPage

FRPage

Représente la page du document connectée à Zoom Viewer.

Locked

VARIANT_BOOL

Indique si le Zoom Viewer est verrouillé.
Cette propriété est utile dans les situations suivantes :
- l'opération d'analyse, de reconnaissance, de synthèse ou d'exportation est appelée depuis l'API du moteur FineReader (pas depuis Visual Components),
ou
- votre application reçoit des notifications de certains événements (par exemple de l'objet FRDocument) et traite les messages Windows de Visual Components dans ces gestionnaires d'événements.
Dans ce cas, nous vous recommandons de régler cette propriété sur TRUE avant l'analyse, la reconnaissance, la synthèse ou l'exportation, et de la régler sur FALSE après la fin de la l'opération. Dans ce cas, le document ne peut être altéré par Zoom Viewer.
Par défaut, la valeur est FALSE.

ProcessingParams

DocumentProcessingParams

Spécifie les paramètres de traitement par défaut du document.
Ces paramètres sont utilisés si les processus d'analyse et de reconnaissance sont appelés directement depuis Zoom Viewer.
Note : Si Zoom Viewer est connecté à Component Synchronizer, utilisez la propriété IComponentSynchronizer::ProcessingParams pour modifier les paramètres utilisés pour le traitement. Si vous modifiez les paramètres de traitement via la propriété de Zoom Viewer, des erreurs peuvent se produire.

SettingsPath

BSTR

Spécifie le chemin d'accès au dossier qui contient les fichiers avec les paramètres de Zoom Viewer. Les autres composants visuels ont la même propriété. Chaque composant visuel doit utiliser son propre dossier avec les paramètres.
La valeur de cette propriété est construite à partir du chemin d'accès au dossier, dans lequel ABBYY FineReader Engine stocke les données spécifiques à l'utilisateur, et du nom de son sous-dossier. Par défaut, le dossier contenant les données spécifiques à l'utilisateur est le dossier de données de FineReader Engine. Il peut être modifié lors de l'initialisation de FineReader Engine (via la fonction InitializeEngine, ou via la méthode IEngineLoader::InitializeEngine). Le nom par défaut du sous-dossier est un GUID arbitraire. Pour changer le nom du sous-dossier, vous devez spécifier le nouveau nom dans les propriétés du composant dans Visual Studio au moment de la conception. Si vous essayez de spécifier la valeur de la propriété au moment de l'exécution, cette valeur est ignorée.
Si vous ajoutez le composant à un formulaire dans Visual Studio au moment de la conception, la valeur de la propriété est définie soit automatiquement avec la valeur par défaut, soit manuellement avec une valeur personnalisée. Dans les deux cas, la valeur est définie au moment de la conception. Si, pour une raison quelconque, la valeur de la propriété n'est pas définie au moment de la conception (par exemple, si vous générez le composant de manière dynamique au moment de l'exécution), le composant crée un nouveau dossier avec les paramètres à chaque fois que le composant est initialisé.
Pour éviter la multiplication des dossiers, vous devez supprimer le dossier des paramètres créés après la désinitialisation du composant. Dans ce cas, vous ne pouvez utiliser que les paramètres par défaut du composant et ne pouvez pas enregistrer les paramètres entre les sessions.

SymbolRect

FRRectangle

Stocke les coordonnées du rectangle du personnage actuel en pixels. Les coordonnées sont relatives à l'image du document.

SymbolRectEnabled

VARIANT_BOOL

Spécifie si le caractère actuel doit être marqué d'un rectangle jaune.
Par défaut, la valeur est TRUE.

ViewScale

int

Spécifie l'échelle de l'image en points de pourcentage. Cette propriété peut également être définie par l'une des constantes ScaleTypes.
Par défaut, la valeur est ST_PixelToPixel, ce qui signifie que l'image est affichée en mode pixel à pixel.

VisibleDocumentArea

FRRectangle, read-only

Stocke les coordonnées de la zone visible du document en pixels. Les coordonnées sont relatives à l'image du document.

WindowHandle

__int64, read-only

Renvoie la poignée de fenêtre de l'espace client.

Methodes

Nom

Descriptif

CenterOnDocumentPoint

Fait défiler la vue en zoom de manière à ce que le point spécifié soit positionné au centre de la vue.

DocumentToScreen

Convertit les coordonnées du point spécifié sur l'image du document en coordonnées d'écran.

GetSelectedBlocksIndices

Retourne la collection d'indices des blocs sélectionnés.

GetSelectedCells

Retourne le rectangle environnant des cellules sélectionnées dans le bloc tableau spécifié.

ScreenToDocument

Convertit les coordonnées d'écran du point spécifié en coordonnées sur l'image du document.

SetSelectedBlocksIndices

Bloque la sélection.

SetSelectedCells

Définit les cellules sélectionnées du bloc tableau spécifié.

ShowDocumentArea

Défilement de la vue en zoom afin que la zone du document avec les coordonnées spécifiées devienne visible (dans la mesure du possible).

UpdateOptions

Met à jour les paramètres spécifiés dans la boîte de dialogue Options de Zoom Viewer. Vous pouvez avoir besoin d'appeler cette méthode, si les options ont été modifiées dans un autre composant visuel, pour mettre à jour les options de Zoom Viewer à l'état actuel.

XI-A - Échantillons

Ce composant est utilisé dans les exemples de code suivants : VisualComponents.

XII - Commandes de Zoom Viewer

Vous trouverez ci-dessous la liste des commandes disponibles dans Zoom Viewer. Les commandes peuvent être appelées par :

- en sélectionnant un élément dans un menu contextuel,

- en appuyant sur une touche de raccourci,

- en utilisant la méthode DoCommand de l'objet secondaire d'une composante

Cependant, toutes ces méthodes ne sont pas disponibles pour chaque commande. La disponibilité de telle ou telle méthode d'appel est décrit dans le tableau ci-dessous : "+" signifie que la commande est disponible par défaut, "*" - la commande peut être ajouté par le développeur.

MenuItemEn
um constant

Descriptif

Menu contextuel

DoCommand

Touche de raccourci

Autres

MI_AnalyzeLay
out

Analyse automatiquement la mise en page de la page de l'image active.

+

+

Ctrl+E

MI_AnalyzeLay
outInBlock

Analyse automatiquement la mise en page dans la zone active.

+

+

MI_AnalyzeTa
bleStructure

Dessine automatiquement des lignes et des colonnes dans le tableau sélectionné.

+

+

MI_BlockDelet
e

Supprime les blocs sélectionnés.

+

+

Del

MI_BlockType_
BackgroundPi
cture

Change le type de bloc sélectionné en image de fond.

+

+

MI_BlockType_
Barcode

Change le type de bloc sélectionné en code à barres.

+

+

Ctrl+5

MI_BlockType_
Picture

Change le type du bloc sélectionné en Image.

+

+

Ctrl+4

MI_BlockType_
RecognitionAr
ea

Change le type de bloc sélectionné en zone de reconnaissance.

+

+

Ctrl+1

MI_BlockType_
Table

Change le type de bloc sélectionné en Tableau.

+

+

Ctrl+3

MI_BlockType_
Text

Change le type du bloc sélectionné en Texte.

+

+

Ctrl+2

MI_Language
Editor

Ouvre la boîte de dialogue de l'éditeur de langue, qui vous permet de sélectionner et de modifier les langues de reconnaissance.

*

+

Ctrl+Shift+L

MI_LayoutClea
r

Supprime tous les blocs de la page.

+

+

Ctrl+Del

MI_MergeTab
leCells

Fusionne les cellules du tableau sélectionnées en une seule.

+

+

Dans le menu contextuel des icônes d'un bloc de table

MI_MergeTab
leRows

Fusionne les lignes sélectionnées en une seule qui conserve les colonnes du tableau.

+

+

MI_Options

Affiche la boîte de dialogue Options, qui vous permet de spécifier différentes options d'affichage et d'enregistrement.

*

+

MI_Read

Reconnaît la page active.

+

+

Ctrl+R

MI_ReadBlock

Reconnaît le bloc sélectionné.

+

+

Ctrl+Shift+B

MI_Redo

Annule la dernière action annulée.

*

+

Ctrl+Enter or
Ctrl+Y

MI_Scale_100

Sélectionne une valeur d'échelle de 100 % pour une image.

+

+

MI_Scale_200

Sélectionne une valeur d'échelle de 200 % pour une image.

+

+

MI_Scale_300

Sélectionne une valeur d'échelle de 300 % pour une image.

+

+

MI_Scale_400

Sélectionne une valeur d'échelle de 400 % pour une image.

+

+

MI_Scale_50

Sélectionne une valeur d'échelle de 50 % pour une image.

+

+

MI_Scale_600

Sélectionne une valeur d'échelle de 600% pour une image.

+

+

MI_Scale_800

Sélectionne une valeur d'échelle de 800% pour une image.

+

+

MI_Scale_FitTo
Width

Adapte la vue de l'image à la largeur.

+

+

MI_Scale_Pixel
ToPixel

Affiche l'image dans sa taille réelle en pixels.

+

+

Bouton "Pixel à pixel" dans le volet inférieur de Zoom Viewer

MI_Scale_Zoo
mIn

Zoome sur l'image.

+

+

Bouton « Zoom In » dans le volet inférieur de Zoom Viewer

MI_Scale_Zoo
mOut

Zoom sur l'image.

+

+

Bouton "Zoom Out" sur le panneau inférieur de Zoom Viewer

MI_Scale_Zoo
mToSelBlocks

Maximise les blocs sélectionnés.

*

+

Ctrl+Shift+Nu
m*

MI_SelectAll

Sélectionne tous les blocs dans Zoom Viewer.

*

+

Ctrl+A

MI_Separator

Ajoute un séparateur à la barre d'outils ou au menu contextuel.

+

MI_SplitTable
Cells

Divise les cellules précédemment fusionnées.

+

+

Dans le menu contextuel des icônes d'un bloc de table

MI_SubMenu

Ajoute un sous-menu au menu contextuel.

+

MI_TextDirecti
onAuto

Précise que la direction du texte CJK doit être automatiquement détectée.

+

+

MI_TextDirecti
onHorizontal

Spécifie que le texte CJK a une direction d'écriture horizontale.

+

+

MI_TextDirecti
onVertical

Spécifie que le texte CJK a une direction d'écriture verticale.

+

+

MI_TextNorm
al

Spécifie que le texte dans le bloc a une orientation normale.

+

+

MI_TextRoleAr
tefact

Précise que le texte dans le bloc a un autre rôle, non énuméré ci-dessous.

+

+

MI_TextRoleC
aption

Précise que le texte dans le bloc est une légende.

+

+

MI_TextRoleIn
cutText

Précise que le texte dans le bloc est un texte encadré.

+

+

MI_TextRoleLi
neNumbers

Précise que le texte dans le bloc est constitué de numéros de ligne.

+

+

MI_TextRoleM
ainText

Précise que le texte dans le bloc est un corps de texte.

+

+

MI_TextRoleR
unningTitle

Précise que le texte dans le bloc est un en-tête ou un pied de page.

+

+

MI_TextRoleU
nknown

Précise que le rôle du texte dans le bloc est indéfini.

+

+

MI_TextRotate
dLeft

Spécifie que le texte dans le bloc est tourné à gauche.

+

+

MI_TextRotate
dRight

Spécifie que le texte dans le bloc est tourné vers la droite.

+

+

MI_TextUpsid
eDown

Spécifie que le texte dans le bloc est tourné à l'envers.

+

+

MI_Undo

Annule la dernière action.

*

+

Alt+Backspac
e or Ctrl+Z

MI_ViewDictio
naries

Ouvre la boîte de dialogue Select Dictionary, qui vous permet de visualiser et de modifier les propriétés du dictionnaire.

*

+

Ctrl+Alt+D

MI_CustomCo
mmand1

Permet de définir une commande personnalisée.

*

+

MI_CustomCo
mmand2

Permet de définir une commande personnalisée.

*

+

MI_CustomCo
mmand3

Permet de définir une commande personnalisée.

*

+

MI_CustomCo
mmand4

Permet de définir une commande personnalisée.

*

+

MI_CustomCo
mmand5

Permet de définir une commande personnalisée.

*

+

MI_CustomCo
mmand6

Permet de définir une commande personnalisée.

*

+

MI_CustomCo
mmand7

Permet de définir une commande personnalisée.

*

+

MI_CustomCo
mmand8

Permet de définir une commande personnalisée.

*

+

MI_CustomCo
mmand9

Permet de définir une commande personnalisée.

*

+

MI_CustomCo
mmand10

Permet de définir une commande personnalisée.

*

+

XIII - Méthode DocumentToScreen de l'objet ZoomViewer

Cette méthode convertit les coordonnées du point spécifié sur l'image du document en coordonnées d'écran.

XIII-A - Syntaxe

cpp

HRESULT DocumentToScreen(
int DocumentX,
int DocumentY,
int* ScreenX,
int* ScreenY
);

C#

void DocumentToScreen(
int DocumentX,
int DocumentY,
out int ScreenX,
out int ScreenY
);

Sub DocumentToScreen( _
DocumentX As Integer, _
DocumentY As Integer, _
ByRef ScreenX As Integer, _
ByRef ScreenY As Integer _
)

XIII-B - Paramètres

- DocumentX
[in] Spécifie la coordonnée horizontale du point sur l'image du document.

- DocumentY
[in] Spécifie la coordonnée verticale du point sur l'image du document.

- ScreenX
[out] Reçoit la coordonnée horizontale du point en coordonnées d'écran.

- ScreenY
[out] Reçoit la coordonnée verticale du point en coordonnées d'écran.

XIII-C - Valeurs de retour

Cette méthode n'a pas de valeurs de retour spécifiques. Elle renvoie les valeurs de retour standard d’ABBYY FineReader Engine functions.

XIV - Méthode GetSelectedBlocksIndices de l'objet ZoomViewer

Cette méthode retourne la collecte des indices des blocs sélectionnés.

XIV-A - Syntaxe

cpp

HRESULT GetSelectedBlocksIndices( IIntsCollection** indices );

C#

GetSelectedBlocksIndices();

XIV-B - Paramètres

Indices

[out, retval] Donne accès à l'objet IntsCollection qui contient les index des blocs.

XIV-C - Valeurs de retour

Cette méthode n'a pas de valeurs de retour spécifiques. Elle renvoie les valeurs de retour standard d'ABBYY FineReader Engine functions.

XV - Méthode GetSelectedCells de l'objet ZoomViewer

Cette méthode renvoie le rectangle environnant des cellules sélectionnées dans le bloc tableau spécifié.

XV-A - Syntaxe

C++

HRESULT GetSelectedCells(
int blockIndex,
IFRRectangle** selectedCells
);

C#

IFRRectangle GetSelectedCells( int blockIndex );

Visual Basic .Net

Function GetSelectedCells(blockIndex As Integer) As IFRRectangle

XV-B - Paramètres

- blockIndex

[in] Spécifie l'index d'un bloc de table. L'index se trouve dans la collection ILayout::VisualBlocks.

- selectedCells

[out, retval] Donne accès à l'objet FRRectangle retourné qui contient les coordonnées du rectangle qui entoure les cellules sélectionnées. Les coordonnées sont définies dans une grille de base.

XV-C - Valeurs de retour

Cette méthode n'a pas de valeurs de retour spécifiques. Elle renvoie les valeurs de retour standard d’ABBYY FineReader Engine functions.

Remarques

Par grille de base, nous entendons ici la grille formée par les bordures et les séparateurs des tableaux. Chaque verticale incrémente la coordonnée horizontale d'une unité, et chaque séparateur horizontal incrémente les coordonnées verticales par un. Les axes de coordonnées sont orientés de gauche à droite et de haut en bas.

XVI - Méthode ScreenToDocument de l'objet ZoomViewer

Cette méthode convertit les coordonnées d'écran du point spécifié en coordonnées sur l'image du document.

XVI-A - Syntaxe

C++

HRESULT ScreenToDocument(
int ScreenX,
int ScreenY,
int* DocumentX,
int* DocumentY
);

C#

void ScreenToDocument(
int ScreenX,
int ScreenY,
out int DocumentX,
out int DocumentY
);

Visual Basique .Net

Sub ScreenToDocument(
ScreenX As Integer, _
ScreenY As Integer, _
ByRef DocumentX As Integer, _
ByRef DocumentY As Integer _
)

XVII - Paramètres

- ScreenX
[in] Spécifie la coordonnée horizontale du point en coordonnées d'écran.

- ScreenY
[in] Spécifie la coordonnée verticale du point en coordonnées d'écran.

- DocumentX
[out] Reçoit la coordonnée horizontale du point sur l'image du document.

- DocumentY
[out] Reçoit la coordonnée verticale du point sur l'image du document.

XVII-A - Valeurs de retour

Cette méthode n'a pas de valeurs de retour spécifiques. Elle renvoie les valeurs de retour standard d’ABBYY FineReader Engine functions.

XVIII - Méthode SetSelectedBlocksIndices de l'objet ZoomViewer

Cette méthode vous permet de définir la sélection des blocs.

XVIII-A - Syntax

C++

HRESULT SetSelectedBlocksIndices( IIntsCollection* indices );

C#

void SetSelectedBlocksIndices( IIntsCollection indices );

Visual basique .Net

Sub SetSelectedBlocksIndices(indices As IntsCollection)

XVIII-B - Paramètres

- indices

[in] Fait référence à l'objet IntsCollection qui contient l'ensemble des indices des blocs à sélectionner.

XVIII-C - Valeurs de retour

Cette méthode n'a pas de valeurs de retour spécifiques. Elle renvoie les valeurs de retour standard d'ABBYY FineReader Engine functions.

XVIII-D - Méthode SetSelectedCells de l'objet ZoomViewer

Cette méthode vous permet de définir des cellules sélectionnées d'un bloc tableau.

XVIII-E - Syntax

C++

HRESULT SetSelectedCells(
int blockIndex,
IFRRectangle* selectedCells
);

C#

void SetSelectedCells(
int blockIndex,
IFRRectangle selectedCells
);

Sub SetSelectedCells( _
blockIndex As Integer, _
selectedCells As IFRRectangle _
)

XVIII-F - Paramètres

- blockIndex

[in] Spécifie l'index d'un bloc de table. L'index se trouve dans la collection ILayout::VisualBlocks.

- selectedCells

[in] Se réfère à l'objet FRRectangle qui spécifie les coordonnées du rectangle environnant des cellules à sélectionner. Les coordonnées sont définies dans une grille de base.

XVIII-G - Valeurs de retour

Cette méthode n'a pas de valeurs de retour spécifiques. Elle renvoie les valeurs de retour standard d'ABBYY FineReader Engine functions.

Remarques

Par grille de base, nous entendons ici la grille formée par les bordures et les séparateurs des tableaux. Chaque verticale incrémente la coordonnée horizontale d'une unité, et chaque séparateur horizontal incrémente les coordonnées verticales par un. Les axes de coordonnées sont orientés de gauche à droite et de haut en bas.

XIX - Méthode ShowDocumentArea de l'objet ZoomViewer

Cette méthode vous permet de faire défiler la vue en zoom afin que la zone du document aux coordonnées spécifiées devienne visible (dans la mesure du possible).

Sub ShowDocumentArea(Value As IFRRectangle)

void ShowDocumentArea( IFRRectangle Value );

C++

HRESULT ShowDocumentArea( IFRRectangle* Value );

XIX-A - Paramètres

- Valeur

[in] Fait référence à l'objet FRRectangle qui spécifie les coordonnées de la zone du document en pixels. Les coordonnées sont relatives à l'image du document.

XIX-B - Valeurs de retour

Cette méthode n'a pas de valeurs de retour spécifiques. Elle renvoie les valeurs de retour standard d'ABBYY FineReader Engine functions.

XX - Méthode UpdateOptions de l'objet ZoomViewer

Cette méthode met à jour les paramètres spécifiés dans la boîte de dialogue Options de Zoom Viewer. Vous pouvez avoir besoin d’appeler cette méthode, si les options ont été modifiées dans un autre composant visuel, pour mettre à jour des options de Zoom Viewer à l'état actuel.

Remarque : la boîte de dialogue Options peut être affichée si la commande MI_Options est appelée dans Image Viewer, Zoom

Viewer, Text Editor, ou Document Viewer, si le bouton Options est cliqué dans la boîte de dialogue Save as de Document Viewer, ou si vous cliquez sur Paramètres > Options dans Text Validator.

XX-A - Syntaxe

C++

HRESULT UpdateOptions();

C#

void UpdateOptions();

Visual Basique . Net

Sub UpdateOption() ;

XX-B - Valeurs de retour

Cette méthode n'a pas de valeurs de retour spécifiques. Elle renvoie les valeurs de retour standard d'ABBYY FineReader Engine functions.

XXI - DocumentViewer Object (interface IDocumentViewer)

L'objet DocumentViewer est un contrôle ActiveX qui vous permet de visualiser la liste des pages dans le document et surveiller leur état. Vous pouvez également enregistrer le document reconnu ou l'ouvrir dans le dossier en utilisant les commandes disponibles dans le composant. Un document est connecté au composant via la propriété du FRDocument.

Le composant Document Viewer peut se présenter comme suit, en fonction de la valeur de la propriété Mode :

- Vue détaillée

Fournit des informations détaillées sur chaque page de document.

- Vue miniature

Affiche les pages du document sous forme de vignettes.

Vous pouvez modifier l'apparence du composant via ses propriétés. Par exemple, vous pouvez ajouter des boutons à sa barre d'outils et de les en retirer via la propriété Toolbar, ou de modifier le menu contextuel via la propriété PopupMenu. Voir Personnalisation du menu contextuel et de la barre d'outils d'un visuel composante pour les détails.

Les informations relatives au suivi du document sont communiquées par des interfaces sortantes spéciales. Ces interfaces sont IDocumentViewerEvents (pour C++) et une DIDocumentViewerEvents dispinterface (pour

Visual Basic).

Il est bon de noter que les utilisateurs de Visual Basic ne doivent pas se soucier des détails de la mise en œuvre des interfaces d'événements car cette plateforme de développement offre des moyens faciles de les manipuler. Cet objet peut être déclaré WithEvents sous Visual Basic.

Pour l'utilisateur C++, cela signifie qu'il prend en charge l'interface IConnectionPointContainer. Pour recevoir les notifications d’évènements, un utilisateur C++ doit créer un objet dérivé de l'IDocumentViewerEvents puis établir la connexion entre celle-ci et la source d'événements mise en œuvre dans DocumentViewer objet par des moyens COM standard.

Le composant "Document Viewer" peut être connecté au composant "Component Synchronizer". Dans ce cas, tous les événements dans le Document Viewer seront automatiquement transmis aux autres composants connectés au Synchroniseur et l'ensemble de l'application fonctionnera de manière synchrone.

Propriétés

Nom

Type

Description

FRDocument

FRDocument

Précise le document
connecté à Document Viewer.

LanguagePaneEnabled

VARIANT_BOOL

Précise si la langue
de Document Viewer est
activée. Si cette propriété est FALSE, la page de langue n'est pas affichée.
Par défaut, la valeur est TRUE.

Locked

VARIANT_BOOL

Précise si le Document
Viewer est verrouillé.
Cette propriété est utile dans
les situations suivantes :
- analyse, reconnaissance, synthèse,
ou exportation d'opération est appelée
de l'API FineReader Engine
(pas de Visual Components),
ou
- votre demande reçoit
les notifications de certains événements
(par ex. du FRDocument
objet) et les processus
messages Windows
depuis des éléments visuels de ces gestionnaires d'événements.
Dans ce cas, nous recommandons que
vous avez mis cette propriété sur TRUE
avant l'analyse, la reconnaissance,
synthèse ou l'exportation, et le mettre à
FALSE après la fin de
l'opération. Dans ce cas, le document ne peut être altéré par Document Viewer.
Par défaut, la valeur est FALSE.

Mode

DocumentViewerModeEnum

Précise le mode actuel de
Document Viewer : Détails ou Vue miniature.
Par défaut, le mode est
DVM_Thumbnails.

PopupMenu

PopupMenu, read-only

Permet d'accéder aux paramètres du menu contextuel.

ProcessingParams

DocumentProcessingParams

Spécifie les paramètres de traitement par défaut du document. Ces paramètres sont utilisés si les processus d'analyse et de reconnaissance sont appelés directement à partir de Document Viewer.
Note : Si Document Viewer est connecté à Component Synchronizer, utilisez la propriété IComponentSynchronizer::ProcessingParams pour modifier les paramètres utilisés pour le traitement. Si vous modifiez les paramètres de traitement via la propriété de Document Viewer, des erreurs peuvent se produire.

Titre

BSTR

Spécifie le titre du composant Document Viewer.
Par défaut, il s'agit de "Pages".

Barre d’outils

Toolbar, read-only

Permet d'accéder aux paramètres de la barre d'outils.

SelectedPagesIndices

IntsCollection

Donne accès à la collection d'index des pages sélectionnées.

` SettingsPath

BSTR

Spécifie le chemin d'accès au dossier qui contient les fichiers avec les paramètres de Document Viewer.
Les autres composants visuels ont la même propriété. Chaque composant visuel doit utiliser son propre dossier avec les paramètres.
La valeur de cette propriété est construite à partir du chemin d'accès au dossier, dans lequel ABBYY FineReader Engine stocke les données spécifiques à l'utilisateur, et du nom de son sous-dossier. Par défaut, le dossier contenant les données spécifiques à l'utilisateur est le dossier de données de FineReader Engine. Il peut être modifié lors de l'initialisation de FineReader Engine (via la fonction InitializeEngine, ou via la méthode IEngineLoader::InitializeEngine). Le nom par défaut du sous-dossier est un GUID arbitraire. Pour changer le nom du sous-dossier, vous devez spécifier le nouveau nom dans les propriétés du composant dans Visual Studio au moment de la conception. Si vous essayez de spécifier la valeur de la propriété au moment de l'exécution, cette valeur est ignorée.
Si vous ajoutez le composant à un formulaire dans Visual Studio au moment de la conception, la valeur de la propriété est définie soit automatiquement avec la valeur par défaut, soit manuellement avec une valeur personnalisée. Dans les deux cas, la valeur est définie au moment de la conception. Si, pour une raison quelconque, la valeur de la propriété n'est pas définie au moment de la conception (par exemple si vous générez le composant dynamiquement au moment de l'exécution), le composant crée un nouveau dossier avec les paramètres à chaque fois que le composant est initialisé. Pour éviter la multiplication des dossiers, vous devez supprimer le dossier des paramètres créés après la désinitialisation du composant. Dans ce cas, vous pouvez utiliser uniquement les paramètres par défaut du composant et
ne pouvez pas enregistrer les paramètres entre lessessions.

WindowHandle

__int64, read-only

Renvoie la poignée de fenêtre de l'espace client.

Méthodes

Nom

Description

UpdateOptions

Met à jour les paramètres spécifiés dans la boîte de dialogue Options de Document Viewer. Vous pouvez avoir besoin d'appeler cette méthode, si les options ont été modifiées dans un autre composant visuel, pour mettre à jour les options de Document Viewer à l'état actuel.

Échantillons

Ce composant est utilisé dans les exemples de code suivants : VisualComponents.

Commandes de la visionneuse de documents

Vous trouverez ci-dessous la liste des commandes disponibles dans la visionneuse de documents. Les commandes peuvent être appelées :

- en sélectionnant un élément dans un menu contextuel,

- en cliquant sur un bouton de la barre d'outils,

- en appuyant sur une touche de raccourci,

- en utilisant la méthode DoCommand de l'objet secondaire d'une composante

Cependant, toutes ces méthodes ne sont pas disponibles pour chaque commande. La disponibilité de telle ou telle méthode d'appel est décrite dans le tableau ci-dessous : "+" signifie que la commande est disponible par défaut, "*" - la commande peut être ajoutée par le développeur.

Éléments

MenuItemEn
um constant

Description

Context
menu

Barre d’outils

DoCommand

Hot key

MI_AnalyzeLay
out

Analyse automatiquement la mise en page des pages d'images sélectionnées.

+

+

Ctrl+E

MI_DeletePag
e

Supprime la page sélectionnée du document en cours.

+

*

+

Del

MI_Document
ViewDetails

Sélectionne la vue du document en détail

+

+

MI_Document
ViewThumbna
ils

Sélectionne la vue du document sous forme de vignettes.

+

+

MI_FlipHorizo
ntal

Retourne l'image horizontalement.

+

+

MI_FlipVertical

Retourne l'image verticalement.

+

+

MI_GotoPage

Va à la page spécifiée.

*

*

+

Ctrl + G

MI_Language
Editor

Ouvre la boîte de dialogue de l'éditeur de langue, qui vous permet de sélectionner et de modifier les langues de reconnaissance.

*

*

+

Ctrl+Shift+L

MI_NextPage

Voir page suivante.

*

+

+

Ctrl + Num + or

Alt+Down Arrow

MI_Options

Affiche la boîte de dialogue Options, qui vous permet de spécifier différentes options d'affichage et d'enregistrement.

*

*

+

MI_PrevPage

Affiche la page précédente.

*

+

+

Ctrl+Num- or
Alt+Up Arrow

MI_Properties

Affiche les propriétés de la page sélectionnée.

+

+

Alt+Enter

MI_Read

Reconnaît les pages sélectionnées.

+

+

Ctrl+R

MI_Renumber
Pages

Ouvre la boîte de dialogue Renuméroter les pages, qui vous permet de renuméroter les pages.

+

*

+

MI_RotateCloc
kwise

Tourne l'image de 90° dans le sens des aiguilles d'une montre.

+

+

MI_RotateCou
nterClockwise

Tourne l'image de 90° dans le sens inverse des aiguilles d'une montre.

+

+

MI_RotateUps
ideDown

Tourne l'image à l'envers (180°).

+

+

MI_SaveAsCsv

Enregistre le texte reconnu au format CSV.

+

+

MI_SaveAsDo
cX

Enregistre le texte reconnu au format DOCX.

+

+

MI_SaveAsEpu
b

Enregistre le texte reconnu au format EPUB.

+

+

MI_SaveAsFb2

Enregistre le texte reconnu au format FB2.

+

+

MI_SaveAsHt
m

Enregistre le texte reconnu au format HTML.

+

+

MI_SaveAsOdt

Enregistre le texte reconnu au format ODT.

+

+

MI_SaveAsPdf

Enregistre le texte reconnu au format PDF.

+

+

MI_SaveAsPdf
A

Enregistre le texte reconnu au format PDF/A.

+

+

MI_SaveAsPpt
X

Enregistre le texte reconnu au format PPTX.

+

+

MI_SaveAsRtf

Enregistre le texte reconnu au format RTF.

+

+

MI_SaveAsTxt

Enregistre le texte reconnu au format TXT.

+

+

MI_SaveAsXls

Enregistre le texte reconnu au format XLS.

+

+

MI_SaveAsXls
X

Enregistre le texte reconnu au format XLSX.

+

+

MI_SendToAcr
obat

Ouvre un texte reconnu dans Adobe Acrobat ou Adobe Reader.

+

+

MI_SendToCli
pboard

Coller un texte reconnu dans le Presse-papiers.

+

+

MI_SendToMS
Excel

Ouvre un texte reconnu dans Microsoft Excel.

+

+

MI_SendToMS
Word

Ouvre un texte reconnu dans Microsoft Word.

+

+

MI_SendToOp
enOffice

Ouvre un texte reconnu dans OpenOffice.org.

+

+

MI_SendToPo
werPoint

Ouvre un texte reconnu dans Microsoft PowerPoint.

+

+

MI_SendToWe
bBrowser

Ouvre un texte reconnu dans le navigateur Internet.

+

+

MI_SendToW
ordPerfect

Ouvre un texte reconnu dans Corel WordPerfect.

+

+

MI_SendToW
ordPro

Ouvre un texte reconnu dans Lotus Word Pro.

+

+

MI_Separator

Ajoute un séparateur à la barre d'outils ou au menu contextuel.

+

*

MI_SubMenu

Ajoute un sous-menu au menu contextuel.

+

MI_ViewDictio
naries

Ouvre la boîte de dialogue Sélectionner un dictionnaire, qui vous permet de visualiser et de modifier les propriétés du dictionnaire.

*

*

+

Ctrl+Alt+D

MI_CustomCo
mmand1

Permet de définir une commande personnalisée.

*

*

+

MI_CustomCo
Mmand2

Permet de définir une commande personnalisée.

*

*

+

MI_CustomCo
mmand3

Permet de définir une commande personnalisée.

*

*

+

MI_CustomCo
mmand4

Permet de définir une commande personnalisée.

*

*

+

MI_CustomCo
mmand5

Permet de définir une commande personnalisée.

*

*

+

MI_CustomCo
mmand6

Permet de définir une commande personnalisée.

*

*

+

MI_CustomCo
Mmand7

Permet de définir une commande personnalisée.

*

*

+

MI_CustomCo
Mmand8

Permet de définir une commande personnalisée.

*

*

+

MI_CustomCo
Mmand9

Permet de définir une commande personnalisée.

*

*

+

MI_CustomCo
Mmand10

Permet de définir une commande personnalisée.

*

*

+