Objet FRDocument (interface IFRDocument)

Cet objet correspond à un document à traiter pouvant contenir plusieurs pages. L’objet FRDocument est l’objet racine d’une collection de pages de document. Chaque page contient une image ouverte et sa mise en page.

L’objet FRDocument fournit toutes les méthodes nécessaires au traitement du document. Vous pouvez traiter un document à l’aide d’une seule méthode (la méthode Process) ou le traiter étape par étape en effectuant l’analyse, la reconnaissance, la synthèse et l’exportation. En règle générale, toutes ces étapes sont obligatoires dans les scénarios courants de traitement des documents. Voir les détails dans la description des méthodes correspondantes. Une fois que vous avez terminé d’utiliser l’objet FRDocument, libérez toutes les ressources qu’il utilise (à l’aide de la méthode Close).

L’objet donne accès aux différents attributs du document, tels que son auteur, ses mots-clés, son sujet et son titre, via la propriété DocumentContentInfo.

L’objet FRDocument est ce que l’on appelle un « connectable object ». En Visual Basic dans FRE pour Windows, il peut être déclaré avec WithEvents. En C++ (sur 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, un utilisateur C++ doit créer un objet dérivé de l’interface IFRDocumentEvents, puis :

• Sous Linux ou macOS, connecter l’objet à l’objet FRDocument en appelant la fonction globale AdviseFREngineObject.
• Sous Windows, établir la connexion entre l’objet et la source d’événements implémentée dans l’objet FRDocument à l’aide des mécanismes COM standard.

Sous Windows : l’objet FRDocument peut également être déclaré avec WithEvents en Visual Basic. Les méthodes de l’objet FRDocument fournissent des informations sur la progression du traitement des pages via des interfaces sortantes spéciales. Ces interfaces sont IFRDocumentEvents (pour C++) et la dispinterface DIFRDocumentEvents (pour Visual Basic). Il convient de noter que les utilisateurs de Visual Basic n’ont pas à se soucier des détails d’implémentation des interfaces d’événements, car cette plateforme de développement fournit des moyens simples de les gérer.

​

Propriétés

	, lecture seule	Retourne l’objet Engine.
	, lecture seule	Renvoie la taille de la mémoire allouée à l’objet IFRDocument. La valeur de cette propriété est exprimée en octets.
	, lecture seule	Retourne la collection des pages du document.
	, lecture seule	Renvoie le texte du document dans un format spécial de “texte brut”.
	, lecture seule	Retourne la langue principale du document reconnu. La propriété contient le nom interne de la première langue de la collection des langues détectées (propriété DetectedLanguages). 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) ; sinon, il s’agit d’une chaîne vide.
	, lecture seule	Donne accès à la collection des langues de reconnaissance détectées dans le document reconnu. Les langues de la collection sont triées par fréquence d’occurrence : de la plus fréquente à la moins fréquente. Cette propriété n’a une valeur pertinente que si la reconnaissance a été effectuée avec la détection automatique de la langue activée (voir la property 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 du document, la collection reste inchangée.
	, lecture seule	Indique si la structure logique du document n’est plus à jour. Si cette propriété est TRUE, vous devez effectuer la synthèse de documents avant l’export. Sinon, une erreur se produira lors de l’export. Pour les composants visuels, cette propriété est utile lorsque vous travaillez avec eux. La structure logique d’un document devient invalide si un utilisateur modifie l’ordre ou le nombre de pages dans le document via l’interface graphique des composants visuels. Si l’export d’un tel document est effectué à l’aide des commandes disponibles dans les composants visuels, ceux-ci effectuent automatiquement la synthèse du document. Mais si vous utilisez les méthodes de l’API FineReader Engine pour l’export, il vous incombe d’effectuer la synthèse de documents avant l’export. Il convient de noter que non seulement la structure du document, mais aussi la structure des pages peuvent devenir invalides. Par conséquent, avant l’export, vous devez également vérifier que toutes les pages du document ont une structure de page valide (voir la propriété IFRPage::PageStructureOutOfDate).
	, lecture seule	Donne accès à la collection de cartes de visite détectées dans le document.
		Contient des informations sur l’auteur, les mots-clés, le sujet et le titre du document, et conserve le dictionnaire d’informations du document.
		Renvoie la collection des pièces jointes du document. Elles sont extraites du document PDF d’entrée lors de son ouverture, ou vous pouvez ajouter vos propres fichiers au fichier PDF de sortie lors de l’export. Pour joindre tous les fichiers de cette collection au fichier PDF de sortie, définissez la propriété sur TRUE.
	, lecture seule	Renvoie la collection des noms de polices extraits des ressources du fichier PDF d’entrée. Si le document a été créé à partir d’un fichier d’un autre format, ou à partir d’un fichier PDF ne contenant aucune police, une collection vide est renvoyée.
	, lecture seule	Indique si au moins un des fichiers source est un PDF signé numériquement.
		Spécifie si les objets et des pages correspondantes doivent être déchargés et enregistrés sur le disque s’il n’existe plus de références à ces objets. Pour Linux, lorsque la valeur de cette propriété est définie sur PFP_KeepInMemory, les objets ImageDocument et Layout des pages inutilisées ne sont pas enregistrés sur le disque. Cette propriété est définie sur PFP_Auto par défaut. Pour macOS, cette valeur de propriété est ignorée. Les objets ImageDocument et Layout des pages inutilisées sont toujours déchargés sur le disque. Pour Windows : pour décharger et enregistrer sur le disque les objets ImageDocument et Layout pour des pages distinctes du document, utilisez la méthode IFRPage::Flush pour les pages correspondantes. Cette propriété est définie sur PFP_Auto par défaut.
		Spécifie le chemin d’accès du dossier où sont stockés les fichiers image temporaires au format interne d’ABBYY FineReader Engine. Par défaut, la valeur de cette propriété est “%TEMP%\ABBYY FineReader Engine 12”.

​

Méthodes

Nom	Description
AddImageDocument	Ajoute au document une image ouverte, représentée par l’objet ImageDocument.
AddImageFile	Ouvre un fichier image et ajoute au document les pages qu’il contient.
AddImageFileFromAttachment	Ouvre un fichier image à partir d’une pièce jointe et ajoute au document les pages correspondant au fichier ouvert.
AddImageFileFromMemory	Ouvre un fichier image à partir de la mémoire globale, où il a été préalablement chargé par l’utilisateur, et ajoute au document les pages correspondant au fichier ouvert.
AddImageFileFromStream	Ouvre un fichier image à partir du flux d’entrée implémenté par l’utilisateur et ajoute au document les pages correspondant au fichier ouvert.
AddImageFileWithPassword	Ouvre un fichier image protégé par un mot de passe et ajoute au document les pages correspondant au fichier ouvert.
AddImageFileWithPasswordCallback	Ouvre un fichier image à l’aide de l’interface IImagePasswordCallback et ajoute au document les pages du fichier ouvert.
AddPage	Ajoute une page au document.
Analyze	Effectue l’analyse de la mise en page de toutes les pages du document.
AnalyzePages	Effectue l’analyse de la mise en page des pages spécifiées d’un document.
CheckTextLayer	Vérifie la présence et la fiabilité de la couche de texte sur les pages spécifiées du document.
Close	Libère toutes les ressources utilisées par l’objet FRDocument et ramène l’objet à son état initial (comme après sa création avec la méthode IEngine::CreateFRDocument).
ConvertFromOldVersion	Charge le contenu de l’objet FRDocument, enregistré avec les versions précédentes d’ABBYY FineReader Engine, depuis le dossier spécifié.
Export	Enregistre le document dans un fichier dans un format externe.
ExportPages	Enregistre les pages spécifiées dans un fichier dans un format externe.
ExportToMemory	Enregistre le document dans la mémoire dans un format externe.
LoadFromFolder	Charge le contenu de l’objet FRDocument, enregistré par ABBYY FineReader Engine 12, depuis le dossier spécifié.
Preprocess	Effectue le prétraitement de toutes les pages du document : corrige l’orientation des pages, l’inversion et les distorsions géométriques, et procède à la division des pages si nécessaire.
PreprocessPages	Effectue le prétraitement des pages spécifiées du document : corrige l’orientation des pages, l’inversion, les distorsions géométriques et effectue une division des pages si nécessaire.
Process	Effectue le prétraitement, l’analyse de la structure, la reconnaissance, ainsi que la synthèse des pages et du document pour l’ensemble des pages du document.
ProcessPages	Effectue, pour les pages spécifiées du document, le prétraitement, l’analyse de la mise en page, la reconnaissance, ainsi que la synthèse des pages et du document.
Recognize	Effectue la reconnaissance et la synthèse des pages pour l’ensemble des pages du document.
RecognizePages	Effectue la reconnaissance et la synthèse des pages spécifiées dans le document.
SaveToFolder	Enregistre le contenu de l’objet FRDocument dans le dossier spécifié.
SplitPages	Scinde chacune des pages spécifiées du document en plusieurs pages. Cette méthode est utile si la page est une double page de livre ou si elle contient les images de plusieurs cartes de visite. Elle fournit des informations sur la façon dont les pages ont été scindées.
Synthesize	Effectue la synthèse de toutes les pages du document.
SynthesizePages	Effectue la synthèse des pages spécifiées du document.

​

Objets associés

Diagramme d’objets

​

Paramètre de sortie

Cet objet constitue le paramètre de sortie des méthodes CreateFRDocument et CreateFRDocumentFromImage de l’objet Engine.

​

Paramètre d’entrée

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

• méthode CreateObjectFromDocument de l’objet ClassificationEngine
• méthode CompareDocuments de l’objet Comparator
• méthode OnDocumentChanged de l’interface IDocumentViewerEvents (pour les composants visuels)
• méthode OnDocumentChanged de l’interface ITextValidatorEvents (pour les composants visuels)

​

Composants visuels associés

​

Exemples

Code C#

FREngine.IEngine engine;
// Créer le document
FREngine.IFRDocument document = Engine.CreateFRDocument();
try {
 // Ajouter le fichier image au document
 document.AddImageFile( "D:\\Demo.tif", null, null );
 // Reconnaître le document
 document.Process( null );
 // Enregistrer les résultats au format rtf avec les paramètres par défaut
 document.Export( "D:\\Demo.rtf", FREngine.FileExportFormatEnum.FEF_RTF, null );
}
catch( Exception error )
{
 ...
}
finally {
 // Fermer le document
 document.Close();
}

Code C++ (COM)

FREngine::IEnginePtr Engine;
// Créer le document
FREngine::IFRDocumentPtr frDocument = Engine->CreateFRDocument();
try {
 // Ajouter le fichier image au document
 frDocument->AddImageFile( L"D:\\Demo.tif", 0, 0 );
 // Reconnaître le document
 frDocument->Process( 0 );
 // Enregistrer les résultats au format rtf avec les paramètres par défaut
 frDocument->Export( L"D:\\Demo.rtf", FREngine::FEF_RTF, 0 );
} catch( _com_error& e ) {
 ...
 // Fermer le document
 frDocument->Close();
}
// Fermer le document
frDocument->Close();

L’objet est utilisé dans presque tous les exemples de code, à l’exception de l’exemple de code BatchProcessing pour Linux et Windows.

​

Voir aussi

FRPage

IFRDocumentEvents

Traitement parallèle avec ABBYY FineReader Engine

Utilisation des objets connectables

Utilisation des propriétés