Objet FRPage (Interface IFRPage)

Objet FRPage (interface IFRPage) dans l’API ABBYY FineReader Engine — représente une page unique, issue soit d’un FRDocument, soit d’un Batch Processor (Linux/Windows) ; expose des méthodes de prétraitement, d’analyse, de reconnaissance, de synthèse de page et d’export, ainsi que des opérations de cache dictionary.

Cet objet correspond à une page.

Sous Linux et Windows, il peut s’agir soit d’une page d’un document, soit d’une page produite par le Batch Processor.

Il fournit un ensemble de méthodes pour le prétraitement, l’analyse, la reconnaissance, la synthèse et l’export de pages. Les méthodes de cet objet n’effectuent pas la synthèse du document (à l’exception de la méthode Synthesize). Avant d’exporter les résultats, vous devez appeler explicitement une méthode qui effectue la synthèse du document. Consultez Tuning Parameters of Preprocessing, Analysis, Recognition, and Synthesis pour plus de détails.

L’objet FRPage est ce que l’on appelle un « objet connectable ». Pour Visual Basic dans FRE pour Windows, il peut être déclaré WithEvents. Pour C++ (tous les systèmes d’exploitation pris en charge), cela signifie qu’il prend en charge l’interface IConnectionPointContainer. Pour recevoir des événements de notification pendant le traitement, les utilisateurs C++ doivent créer un objet dérivé de l’interface IFRPageEvents et…

• Sous Linux et macOS, l’enregistrer auprès de l’objet FRPage via un appel à la fonction globale AdviseFREngineObject.
• Sous Windows : établir la connexion entre cet objet et la source d’événements implémentée dans l’objet FRPage par les mécanismes COM standard.

Sous Windows : les méthodes de l’objet FRPage transmettent des informations sur la progression du traitement des pages via des interfaces sortantes spéciales. Ces interfaces sont IFRPageEvents (pour C++) et la dispinterface DIFRPageEvents (pour Visual Basic). À noter que les utilisateurs Visual Basic n’ont pas à se soucier des détails d’implémentation des interfaces d’événements, cette plateforme de développement offrant des moyens simples pour les gérer.

​

Propriétés

	, read-only	Returns the Engine object.
	, read-only	Returns the document which contains the page.
	, read-only	Provides access to the image of the page.
		Provides access to the layout of the page. When you assign a Layout object to this property (for example, when transferring data from one page to another), the logical structure of the corresponding document becomes invalid. It is necessary to restore the document structure by calling one of the synthesis methods. However, you do not need to perform synthesis for the whole document, it is only necessary to synthesize changed pages, e.g., using the Synthesize method.
	, read-only	Returns the text of the page in a special “plain text” format.
	, read-only	Specifies the full path to the source image of the page.
	, read-only	Specifies the main language of the recognized page. The property contains the internal name of the first language in the collection of detected languages (DetectedLanguages property). This property has a meaningful value only if recognition was performed with the automatic language detection on (see the property for details). By default, it is an empty string.
	, read-only	Provides access to the collection of recognition languages detected on the recognized page. Languages in the collection are sorted by the frequency of occurrence: from the most frequently occurred to the least. Cette propriété n’a une valeur significative que si la reconnaissance a été effectuée avec la détection automatique de la langue activée (voir la propriété pour plus de détails). La liste des langues n’est mise à jour qu’après la reconnaissance ; autrement dit, si vous modifiez manuellement la mise en page de la page, la collection reste inchangée.
	, lecture seule	Indique si la structure logique de la page est obsolète. Si cette propriété est TRUE, vous devez effectuer une synthèse de documents pour la page avant l’export. Dans le cas contraire, une erreur se produira lors de l’export. Cette propriété est utile lorsque vous travaillez avec des composants visuels. La structure logique d’une page devient invalide si un utilisateur modifie la mise en page via l’interface graphique des composants visuels. Si l’export d’une telle page est effectué à l’aide des commandes disponibles dans les composants visuels, ceux-ci synthétisent la page automatiquement. En revanche, si vous utilisez les méthodes de l’API FineReader Engine pour l’export, il vous incombe d’effectuer la synthèse de documents pour la page avant l’export.
	, lecture seule	Renvoie l’indice de la page dans le fichier source.
	, lecture seule	Indique si le fichier source de cette page était un PDF signé numériquement.
	, lecture seule	Donne accès à la collection de cartes de visite détectées sur la page.
		Les composants visuels ne sont actuellement pris en charge que sous Windows. Indique si les méthodes Undo et Redo sont autorisées. Si la valeur de cette propriété est TRUE, toutes les commandes appelées soit à l’aide des méthodes pouvant modifier la page (telles que les méthodes de FRPage ou de l’objet ), soit depuis les composants visuels Windows, peuvent être ajoutées à une pile d’annulation. Dans ce cas, les commandes appelées depuis les composants visuels sont ajoutées automatiquement à la pile. Pour ajouter à la pile les commandes appelées depuis l’API, utilisez la méthode Update. La propriété ne peut pas être définie sur FALSE pour une page ouverte dans les composants visuels.
	, lecture seule	Les composants visuels ne sont actuellement pris en charge que sous Windows. Indique si la méthode Redo peut être exécutée pour la dernière commande annulée, appelée soit à l’aide de l’une des méthodes pouvant modifier la page (telles que les méthodes de FRPage ou de l’objet ), soit depuis l’un des composants visuels.
	, lecture seule	Les composants visuels ne sont actuellement pris en charge que sous Windows. Indique si la méthode Undo peut être exécutée pour la dernière commande appelée soit à l’aide de l’une des méthodes pouvant modifier la page (telles que les méthodes de FRPage ou de l’objet ), soit depuis l’un des composants visuels.

​

Méthodes

Nom	Description
AddWordsToCacheDictionary	Cette méthode ajoute un ensemble de mots au cache dictionary.
AddWordToCacheDictionary	Cette méthode ajoute un mot au cache dictionary.
Analyze	Analyse la page.
AnalyzeRegion	Analyse la mise en page de l’image dans la région spécifiée.
AnalyzeTable	Remplace le bloc spécifié par un bloc de tableau et analyse la structure du tableau.
CleanCacheDictionary	Cette méthode supprime tous les mots du cache dictionary.
DetectOrientation	Détecte l’orientation de la page.
DetectResolution	Sélectionne la meilleure résolution dans l’intervalle spécifié.
Export	Enregistre une page dans un fichier au format externe.
ExtractBarcodes	Recherche et reconnaît tous les blocs Barcode.
ExtractMrz	Extrait les données d’une zone lisible par machine (MRZ).
FindPageSplitPosition	Détermine l’emplacement où l’image peut être scindée.
Flush	Décharge et, si nécessaire, enregistre sur le disque les objets ImageDocument et Layout correspondant à l’objet FRPage si aucune référence ne pointe vers eux. L’enregistrement sur le disque est optionnel ; vous pouvez ignorer cette étape si les données n’ont pas été modifiées.
IsEmpty	Vérifie si la page est vide.
LearnCheckmarks	Entraîne FineReader Engine à reconnaître des coches d’un type personnalisé.
PreprocessAnalyzeRecognize	Effectue le prétraitement, l’analyse de mise en page, la reconnaissance et la synthèse de page.
Preprocess	Effectue le prétraitement de la page : corrige l’orientation, l’inversion et les distorsions géométriques. Le prétraitement de la page est effectué avant l’analyse de la page.
Recognize	Reconnaît la page et procède à la synthèse de la page.
RecognizeBlocks	Reconnaît le texte et procède à la synthèse de la page sur un ensemble de blocs spécifié explicitement.
Rétablir	Remarque : Les composants visuels sont actuellement pris en charge uniquement sous Windows. Rétablit la dernière commande annulée appelée via l’API FineReader Engine.
Synthétiser	Effectue la synthèse du document pour la page individuelle. Sous Linux et Windows, cette méthode peut être utile lors du traitement de documents d’une seule page avec le Batch Processor.
SynthesizeBusinessCard	Tente de trouver les champs de carte de visite dans la région reconnue spécifiée.
SynthesizeBusinessCardEx	Tente d’identifier les champs de carte de visite dans la région reconnue spécifiée à l’aide des paramètres de synthèse.
Undo	Remarque : Les composants visuels sont actuellement pris en charge uniquement sous Windows. Annule la dernière commande exécutée depuis l’API FineReader Engine.
Update	Remarque : Les composants visuels ne sont actuellement pris en charge que sous Windows. Transfère les modifications apportées à la mise en page via l’API FineReader Engine vers les composants visuels et enregistre ces modifications dans la pile d’annulation. Remarque : Lorsque vous appelez cette méthode, la structure logique du Document correspondant devient invalide. Il est nécessaire de restaurer la structure du Document en appelant l’une des méthodes de synthèse. Il n’est toutefois pas nécessaire d’effectuer la synthèse sur l’ensemble du Document ; il suffit de synthétiser les pages modifiées, par exemple à l’aide de la méthode Synthesize.

​

Objets liés

Diagramme d’objets

​

Paramètre de sortie

Cet objet constitue le paramètre de sortie des méthodes suivantes :

• méthode Item de l’objet FRPages
• Sous Linux et Windows : méthode GetNextProcessedPage de l’objet BatchProcessor

​

Paramètre d’entrée

Cet objet est transmis en tant que paramètre d’entrée aux méthodes suivantes :

• méthode IndexOf de l’objet FRPages
• méthode AddPage de l’objet FRDocument
• méthode AddPage de l’objet ExportFileWriter
• méthode CreateObjectFromPage de l’objet ClassificationEngine
• méthodes OnProgress, OnWarning, OnRegionProcessed, OnPageProcessed de l’interface IFRPageEvents
• méthode PageRemoved de l’interface IFRPagesEvents
• méthode ComparePages de l’objet Comparator
• Sous Linux et Windows : méthode ProcessPageAsync de l’objet BatchProcessor
• Sous Windows, avec les composants visuels :
  • méthodes OnActivePageChanged, OnActivePageChanging de l’interface DocumentViewerEvents
  • méthodes OnActivePageChanged, OnActivePageChanging de l’interface IImageViewerEvents
  • méthode OnActivePageChanged de l’interface IZoomViewerEvents
  • méthodes OnActivePageChanged, OnActivePageChanging de l’interface ITextEditorEvents
  • méthode OnActivePageChanged de l’interface ITextValidatorEvents

​

Composants visuels associés

​

Exemples

Code C#

FREngine.IEngine engine;
string fileName;
FREngine.IBatchProcessor batchProcessor;
// Nous supposons que Batch Processor est créé et démarré
// Récupérer les pages reconnues et les exporter au format PDF
FREngine.IFRPage page = batchProcessor.GetNextProcessedPage();
while( page != null ) {
 // Synthétiser la page avant l’exportation
 page.Synthesize(null);
 // Exporter la page dans un fichier
 page.Export(fileName, FREngine.FileExportFormatEnum.FEF_PDF, null);
 page = batchProcessor.GetNextProcessedPage();
}

L’objet est utilisé dans les exemples de code suivants :

• macOS : Business Card Recognition et RecognizedTextProcessing
• Linux : BCR, BatchProcessing, CustomLanguage, CommandLineInterface
• Windows : BatchProcessing, CustomLanguage, CommandLineInterface, RecognizedTextProcessing, VisualComponents et les outils de démonstration : BatchProcessingRecognition, Engine Predefined Processing Profiles.

​

Voir aussi

FRPages

Utilisation des objets connectables

Utilisation des propriétés