Oggetto FRDocument (interfaccia IFRDocument)

Proprietà
Metodi
Oggetti correlati
Parametro di output
Parametro di input
Visual Components correlati
Esempi
Vedi anche

Questo oggetto corrisponde a un documento di elaborazione che può contenere più pagine. L’oggetto FRDocument è l’elemento radice di una raccolta di pagine del documento. Ogni pagina contiene un’immagine aperta e il layout dell’immagine. L’oggetto FRDocument fornisce tutti i metodi necessari per l’elaborazione del documento. È possibile elaborare un documento utilizzando un solo metodo (il metodo Process) oppure procedere passo dopo passo, eseguendo analisi, riconoscimento, sintesi ed esportazione. In genere, tutti questi passaggi sono obbligatori negli scenari generali di elaborazione dei documenti. Per i dettagli, vedere le descrizioni dei metodi corrispondenti. Dopo aver terminato di lavorare con l’oggetto FRDocument, rilasciare tutte le risorse utilizzate da questo oggetto (usare il metodo Close). L’oggetto consente di accedere ai vari attributi del documento, quali autore, parole chiave, argomento e titolo, tramite la proprietà DocumentContentInfo. L’oggetto FRDocument è un cosiddetto “oggetto connettibile.” In Visual Basic per FRE in Windows, può essere dichiarato con WithEvents. Per C++ (in tutti i sistemi operativi supportati), questo significa che supporta l’interfaccia IConnectionPointContainer. Per ricevere eventi di notifica durante l’elaborazione, un utente C++ deve creare un oggetto derivato dall’interfaccia IFRDocumentEvents, quindi:

In Linux o macOS, connettere l’oggetto all’oggetto FRDocument con una chiamata alla funzione globale AdviseFREngineObject.
In Windows, impostare la connessione tra l’oggetto e l’origine eventi implementata nell’oggetto FRDocument mediante i normali meccanismi COM.

In Windows: l’oggetto FRDocument può anche essere dichiarato con WithEvents in Visual Basic. I metodi dell’oggetto FRDocument riportano informazioni sullo stato di avanzamento dell’elaborazione della pagina tramite speciali interfacce in uscita. Queste interfacce sono IFRDocumentEvents (per C++) e la dispinterface DIFRDocumentEvents (per Visual Basic). Va notato che gli utenti di Visual Basic non devono preoccuparsi dei dettagli di implementazione delle interfacce evento, poiché questa piattaforma di sviluppo fornisce strumenti semplici per gestirle.

Proprietà


	,read-only	Restituisce l’oggetto Engine.

	, read-only	Restituisce la dimensione della memoria allocata per l’oggetto IFRDocument. Il valore di questa proprietà è espresso in byte.
	,read-only	Restituisce la raccolta delle pagine del documento.
	,read-only	Restituisce il testo del documento in un formato speciale “plain text”.

	, read-only	Restituisce la lingua principale del documento riconosciuto. La proprietà contiene il nome interno della prima lingua nella raccolta delle lingue rilevate (proprietà DetectedLanguages). Questa proprietà assume un valore significativo solo se il riconoscimento è stato eseguito con il rilevamento automatico della lingua attivo (vedere la proprietàper i dettagli); in caso contrario, è una stringa vuota.
	,read-only	Fornisce accesso alla raccolta delle lingue di riconoscimento rilevate nel documento riconosciuto. Le lingue nella raccolta sono ordinate per frequenza di occorrenza: dalla più frequente alla meno frequente. Questa proprietà assume un valore significativo solo se il riconoscimento è stato eseguito con il rilevamento automatico della lingua attivo (vedere la proprietàper i dettagli). L’elenco delle lingue viene aggiornato solo dopo il riconoscimento; pertanto, se si modifica manualmente il layout del documento, la raccolta rimane invariata.

	, read-only	Indica se la struttura logica del documento non è aggiornata. Se questa proprietà è TRUE, è necessario eseguire la sintesi del documento prima dell’esportazione. In caso contrario, si verificherà un errore durante l’esportazione. Questa proprietà è utile quando si lavora con i Visual Components. La struttura logica di un documento diventa non valida se un utente modifica l’ordine o il numero di pagine nel documento tramite l’interfaccia grafica dei Visual Components. Se l’esportazione di tale documento viene eseguita tramite i comandi disponibili nei Visual Components, i Visual Components sintetizzano il documento automaticamente. Se invece si utilizzano i metodi API di FineReader Engine per l’esportazione, è responsabilità dell’utente eseguire la sintesi del documento prima dell’esportazione. È opportuno notare che non solo la struttura del documento, ma anche la struttura della pagina può diventare non valida. Pertanto, prima dell’esportazione è necessario verificare anche che tutte le pagine del documento abbiano una struttura di pagina valida (vedere la proprietàIFRPage::PageStructureOutOfDate).

	,read-only	Fornisce accesso alla raccolta di biglietti da visita rilevati nel documento.

		Contiene informazioni sull’autore, le parole chiave, l’argomento e il titolo del documento e archivia il dizionario delle informazioni del documento.
		Restituisce la raccolta degli allegati del documento. Gli allegati vengono estratti dal documento PDF di input durante l’apertura; in alternativa, è possibile aggiungere file personalizzati da allegare al file PDF di output durante l’esportazione. Per allegare tutti i file di questa raccolta al file PDF di output, impostare la proprietàsu TRUE.
	,read-only	Restituisce la raccolta dei nomi dei font estratti dalle risorse del file PDF di input. Se il documento è stato creato aprendo un file in un altro formato, o da un file PDF privo di font, viene restituita una raccolta vuota.
	, read-only	Indica se almeno uno dei file sorgente era un PDF con firma digitale.

		Specifica se gli oggettieper le pagine corrispondenti devono essere scaricati e salvati su disco qualora non vi siano riferimenti a tali oggetti. Per Linux, quando il valore di questa proprietà è impostato su PFP_KeepInMemory, i documenti immagine e i layout per le pagine non utilizzate non vengono salvati su disco. Il valore predefinito di questa proprietà è PFP_Auto. Per macOS, il valore di questa proprietà viene ignorato. I documenti immagine e i layout per le pagine non utilizzate vengono sempre scaricati su disco. Per Windows: per scaricare e salvare su disco gli oggetti ImageDocument e Layout per singole pagine del documento, utilizzare il metodoIFRPage::Flushper le pagine corrispondenti. Il valore predefinito di questa proprietà è PFP_Auto.
		Specifica il percorso della cartella in cui vengono archiviati i file immagine temporanei nel formato interno di ABBYY FineReader Engine. Per impostazione predefinita, il valore di questa proprietà è “%TEMP%\ABBYY FineReader Engine 12”.

Metodi

Nome	Descrizione
AddImageDocument	Aggiunge un’immagine aperta, rappresentata dall’oggetto ImageDocument, al documento.
AddImageFile	Apre un file immagine e aggiunge al documento le pagine corrispondenti al file aperto.
AddImageFileFromAttachment	Apre un file immagine da un allegato e aggiunge al documento le pagine del file aperto.
AddImageFileFromMemory	Apre un file immagine dalla memoria globale, in cui era stato precedentemente caricato dall’utente, e aggiunge al documento le pagine corrispondenti al file aperto.
AddImageFileFromStream	Apre un file immagine dallo stream di input implementato dall’utente e aggiunge al documento le pagine corrispondenti al file aperto.
AddImageFileWithPassword	Apre un file immagine protetto da password e aggiunge al documento le pagine del file aperto.
AddImageFileWithPasswordCallback	Apre un file immagine tramite l’interfaccia IImagePasswordCallback e aggiunge al documento le pagine del file aperto.
AddPage	Aggiunge una pagina al documento.
Analyze	Esegue l’analisi del layout di tutte le pagine del documento.
AnalyzePages	Esegue l’analisi del layout delle pagine specificate in un documento.
CheckTextLayer	Verifica la presenza e l’affidabilità del livello di testo nelle pagine specificate del documento.
Close	Rilascia tutte le risorse usate dall’oggetto FRDocument e riporta l’oggetto al suo stato iniziale (come dopo la sua creazione con il metodo IEngine::CreateFRDocument).
ConvertFromOldVersion	Carica dalla cartella specificata il contenuto dell’oggetto FRDocument salvato dalle versioni precedenti di ABBYY FineReader Engine.
Export	Salva il documento in un file in un formato esterno.
ExportPages	Salva le pagine specificate in un file in un formato esterno.
ExportToMemory	Salva il documento in memoria in un formato esterno.
LoadFromFolder	Carica dalla cartella specificata il contenuto dell’oggetto FRDocument salvato da ABBYY FineReader Engine 12.
Preprocess	Esegue la preelaborazione di tutte le pagine del documento: corregge l’orientamento, l’inversione e le distorsioni geometriche e, se necessario, suddivide le pagine.
PreprocessPages	Esegue la preelaborazione delle pagine specificate nel documento: corregge l’orientamento delle pagine, l’inversione e le distorsioni geometriche, ed esegue la suddivisione delle pagine se necessario.
Process	Esegue la preelaborazione, l’analisi del layout, il riconoscimento e la sintesi di pagine e documenti per tutte le pagine del documento.
ProcessPages	Esegue il pre-processing, l’analisi del layout, il riconoscimento e la sintesi delle pagine e del documento per le pagine specificate nel documento.
Recognize	Esegue il riconoscimento e la sintesi delle pagine per tutte le pagine del documento.
RecognizePages	Esegue il riconoscimento e la sintesi delle pagine specificate nel documento.
SaveToFolder	Salva il contenuto dell’oggetto FRDocument nella cartella specificata.
SplitPages	Divide ciascuna delle pagine specificate del documento in più pagine. Questo metodo è utile se la pagina è una doppia pagina di un libro o contiene immagini di diversi biglietti da visita. Il metodo fornisce informazioni su come le pagine sono state suddivise.
Synthesize	Esegue la sintesi del documento per tutte le pagine del documento.
SynthesizePages	Esegue la sintesi del documento per le pagine specificate nel documento.

Diagramma degli oggetti

Parametro di output

Questo oggetto rappresenta il parametro di output dei metodi CreateFRDocument e CreateFRDocumentFromImage dell’oggetto Engine.

Parametro di input

Questo oggetto viene passato come parametro di input ai metodi seguenti:

metodo CreateObjectFromDocument dell’oggetto ClassificationEngine
metodo CompareDocuments dell’oggetto Comparator
metodo OnDocumentChanged dell’interfaccia IDocumentViewerEvents (per Visual Components)
metodo OnDocumentChanged dell’interfaccia ITextValidatorEvents (per Visual Components)

Esempi

Codice C#

FREngine.IEngine engine;
// Crea il documento
FREngine.IFRDocument document = Engine.CreateFRDocument();
try {
 // Aggiungi il file immagine al documento
 document.AddImageFile( "D:\\Demo.tif", null, null );
 // Riconosci il documento
 document.Process( null );
 // Salva i risultati in formato rtf con i parametri predefiniti
 document.Export( "D:\\Demo.rtf", FREngine.FileExportFormatEnum.FEF_RTF, null );
}
catch( Exception error )
{
 ...
}
finally {
 // Chiudi il documento
 document.Close();
}

Codice C++ (COM)

FREngine::IEnginePtr Engine;
// Crea il documento
FREngine::IFRDocumentPtr frDocument = Engine->CreateFRDocument();
try {
 // Aggiungi il file immagine al documento
 frDocument->AddImageFile( L"D:\\Demo.tif", 0, 0 );
 // Riconosci il documento
 frDocument->Process( 0 );
 // Salva i risultati in formato rtf con i parametri predefiniti
 frDocument->Export( L"D:\\Demo.rtf", FREngine::FEF_RTF, 0 );
} catch( _com_error& e ) {
 ...
 // Chiudi il documento
 frDocument->Close();
}
// Chiudi il documento
frDocument->Close();

L’oggetto viene utilizzato in quasi tutti gli esempi di codice, ad eccezione dell’esempio di codice BatchProcessing per Linux e Windows.

Vedi anche

FRPage IFRDocumentEvents Elaborazione in parallelo con ABBYY FineReader Engine Utilizzo degli oggetti connettibili Utilizzo delle proprietà

Oggetti relativi al documento

Metodo AddImageDocument dell'oggetto FRDocument

⌘I

Panoramica

Funzioni

Oggetto Engine (interfaccia IEngine)

Loader di Engine

Oggetti correlati alle immagini

Oggetti correlati al Layout

Oggetti relativi alla lingua

Oggetti relativi al testo

Oggetti relativi al documento

Batch Processor

Oggetti del meccanismo

Oggetti Parameter

Oggetti correlati alla classificazione

Oggetti correlati alle licenze

Oggetti per il confronto dei documenti

Oggetti e metodi di supporto

Enumerazioni

Oggetto FRDocument (interfaccia IFRDocument)

Proprietà

Metodi

Parametro di output

Parametro di input

Esempi

Vedi anche

Panoramica

Funzioni

Oggetto Engine (interfaccia IEngine)

Loader di Engine

Oggetti correlati alle immagini

Oggetti correlati al Layout

Oggetti relativi alla lingua

Oggetti relativi al testo

Oggetti relativi al documento

Batch Processor

Oggetti del meccanismo

Oggetti Parameter

Oggetti correlati alla classificazione

Oggetti correlati alle licenze

Oggetti per il confronto dei documenti

Oggetti e metodi di supporto

Enumerazioni

​Proprietà

​Metodi

​Oggetti correlati

​Parametro di output

​Parametro di input

​Visual Components correlati

​Esempi

​Vedi anche

Proprietà

Metodi

Oggetti correlati

Parametro di output

Parametro di input

Visual Components correlati

Esempi

Vedi anche