Objeto FRDocument (interfaz IFRDocument)

Este objeto corresponde a un documento que puede contener varias páginas para su procesamiento. El objeto FRDocument es la raíz de una colección de páginas del documento. Cada página contiene una imagen abierta y la estructura de la imagen.

El objeto FRDocument proporciona todos los métodos necesarios para el procesamiento de documentos. Puede procesar un documento con un solo método (el método Process) o procesarlo paso a paso realizando análisis, reconocimiento, síntesis y exportación. Por lo general, todos estos pasos son obligatorios en los casos generales de procesamiento de documentos. Consulte los detalles en las descripciones de los métodos correspondientes. Cuando haya terminado de trabajar con el objeto FRDocument, libere todos los recursos usados por este objeto (use el método Close).

El objeto proporciona acceso a distintos atributos del documento, como autor, palabras clave, asunto y título, mediante la propiedad DocumentContentInfo.

El objeto FRDocument es lo que se conoce como un “objeto conectable.” En Visual Basic para FRE para Windows, puede declararse con WithEvents. Para C++ (en todos los sistemas operativos compatibles), esto significa que admite la interfaz IConnectionPointContainer. Para recibir eventos de notificación durante el procesamiento, un usuario de C++ debe crear un objeto derivado de la interfaz IFRDocumentEvents y luego:

• En Linux o macOS, hacer advise del objeto al objeto FRDocument mediante una llamada a la función global AdviseFREngineObject.
• En Windows, configurar la conexión entre el objeto y el origen de eventos implementado en el objeto FRDocument por medios COM estándar.

En Windows: El objeto FRDocument también puede declararse con WithEvents en Visual Basic. Los métodos del objeto FRDocument informan sobre el progreso del procesamiento de páginas mediante interfaces salientes especiales. Estas interfaces son IFRDocumentEvents (para C++) y la dispinterface DIFRDocumentEvents (para Visual Basic). Cabe señalar que los usuarios de Visual Basic no deben preocuparse por los detalles de implementación de las interfaces de eventos, ya que esta plataforma de desarrollo ofrece medios sencillos para gestionarlas.

​

Propiedades

	, de solo lectura	Devuelve el objeto Engine.
	, de solo lectura	Devuelve el tamaño de la memoria asignada al objeto IFRDocument. El valor de esta propiedad se expresa en bytes.
	, de solo lectura	Devuelve la colección de páginas del documento.
	, de solo lectura	Devuelve el texto del documento en un formato especial de “texto sin formato”.
	, de solo lectura	Devuelve el idioma principal del documento reconocido. La propiedad contiene el nombre interno del primer idioma de la colección de idiomas detectados (propiedad DetectedLanguages). Esta propiedad solo tiene un valor significativo si el reconocimiento se realizó con la detección automática de idioma activada (consulte la propiedad para obtener más información); de lo contrario, es una cadena vacía.
	, de solo lectura	Proporciona acceso a la colección de idiomas de reconocimiento detectados en el documento reconocido. Los idiomas de la colección se ordenan por frecuencia de aparición: desde el que aparece con mayor frecuencia hasta el que aparece con menor frecuencia. Esta propiedad solo tiene sentido si el reconocimiento se realizó con la detección automática de idioma activada (consulte la propiedad para obtener más información). La lista de idiomas se actualiza solo después del reconocimiento; es decir, si edita manualmente la estructura del documento, la colección permanece igual.
	, de solo lectura	Especifica si la estructura lógica del documento está desactualizada. Si esta propiedad es TRUE, debe realizar la síntesis del documento antes de exportarlo. De lo contrario, se producirá un error durante la exportación. En Visual Components, esta propiedad resulta útil al trabajar con Visual Components. La estructura lógica de un documento deja de ser válida si un usuario cambia el orden o el número de páginas del documento mediante la interfaz gráfica de usuario de Visual Components. Si dicho documento se exporta con los comandos disponibles en Visual Components, Visual Components sintetizan el documento automáticamente. Pero si usa los métodos de la API de FineReader Engine para exportarlo, usted es responsable de realizar la síntesis del documento antes de la exportación. Cabe señalar que no solo la estructura del documento, sino también la estructura de la página puede dejar de ser válida. Por lo tanto, antes de la exportación también debe comprobar que todas las páginas del documento tengan una estructura de página válida (consulte la propiedad IFRPage::PageStructureOutOfDate).
	, de solo lectura	Permite acceder a la colección de tarjetas de visita detectadas en el documento.
		Contiene información sobre el autor, las palabras clave, el asunto y el título del documento, y almacena el diccionario de información del documento.
		Devuelve la colección de archivos adjuntos del documento. Se extraen del documento PDF de entrada al abrirlo, o puede agregar sus propios archivos para adjuntarlos al archivo PDF de salida durante la exportación. Para adjuntar todos los archivos de esta colección al archivo PDF de salida, establezca en TRUE la propiedad.
	, de solo lectura	Devuelve la colección con los nombres de las fuentes extraídas de los recursos del archivo PDF de entrada. Si el documento se creó al abrir un archivo en otro formato o a partir de un archivo PDF que no contiene fuentes, se devolverá una colección vacía.
	, de solo lectura	Indica si al menos uno de los archivos de origen era un PDF con firma digital.
		Especifica si los objetos y de las páginas correspondientes deben descargarse y guardarse en disco si no hay referencias a ellos. En Linux, cuando el valor de esta propiedad se establece en PFP_KeepInMemory, los documentos de imagen y los layouts de las páginas no utilizadas no se guardan en disco. De forma predeterminada, esta propiedad es PFP_Auto. En macOS, se omite el valor de esta propiedad. Los documentos de imagen y los layouts de las páginas no utilizadas siempre se descargan en disco. En Windows: Para descargar y guardar en disco los objetos ImageDocument y Layout de páginas individuales del documento, use el método IFRPage::Flush para las páginas correspondientes. De forma predeterminada, esta propiedad es PFP_Auto.
		Especifica la ruta de la carpeta en la que se almacenan los archivos de imagen temporales en el formato interno de ABBYY FineReader Engine. De forma predeterminada, el valor de esta propiedad es “%TEMP%\ABBYY FineReader Engine 12”.

​

Métodos

Nombre	Descripción
AddImageDocument	Añade una imagen abierta, representada por el objeto ImageDocument, al documento.
AddImageFile	Abre un archivo de imagen y añade al documento las páginas correspondientes al archivo abierto.
AddImageFileFromAttachment	Abre un archivo de imagen desde el archivo adjunto y añade al documento las páginas correspondientes al archivo abierto.
AddImageFileFromMemory	Abre un archivo de imagen desde la memoria global, donde el usuario lo había cargado previamente, y añade al documento las páginas correspondientes al archivo abierto.
AddImageFileFromStream	Abre un archivo de imagen desde el flujo de entrada implementado por el usuario y añade al documento las páginas correspondientes al archivo abierto.
AddImageFileWithPassword	Abre un archivo de imagen protegido con contraseña y añade al documento las páginas correspondientes al archivo abierto.
AddImageFileWithPasswordCallback	Abre un archivo de imagen utilizando la interfaz IImagePasswordCallback y agrega al documento las páginas correspondientes al archivo abierto.
AddPage	Agrega una página al documento.
Analyze	Realiza el análisis de diseño de todas las páginas del documento.
AnalyzePages	Realiza el análisis de diseño en las páginas especificadas de un documento.
CheckTextLayer	Comprueba si la capa de texto está presente en las páginas especificadas del documento y si es fiable.
Close	Libera todos los recursos utilizados por el objeto FRDocument y devuelve el objeto a su estado inicial (como tras su creación con el método IEngine::CreateFRDocument).
ConvertFromOldVersion	Carga desde la carpeta especificada el contenido del objeto FRDocument guardado por versiones anteriores de ABBYY FineReader Engine.
Export	Guarda el documento en un archivo con un formato externo.
ExportPages	Guarda las páginas especificadas en un archivo con un formato externo.
ExportToMemory	Guarda el documento en memoria en un formato externo.
LoadFromFolder	Carga desde la carpeta especificada el contenido del objeto FRDocument guardado por ABBYY FineReader Engine 12.
Preprocess	Realiza el preprocesamiento de todas las páginas del documento: corrige la orientación de las páginas, la inversión y las distorsiones geométricas, y divide las páginas si es necesario.
PreprocessPages	Realiza el preprocesamiento de las páginas especificadas del documento: corrige la orientación de la página, la inversión y las distorsiones geométricas y, si es necesario, realiza la división de páginas.
Process	Realiza el preprocesamiento, el análisis de diseño, el reconocimiento y la síntesis de páginas y del documento de todas las páginas del documento.
ProcessPages	Realiza el preprocesamiento, el análisis de diseño, el reconocimiento y la síntesis de páginas y del documento para las páginas especificadas del documento.
Recognize	Realiza el reconocimiento y la síntesis de páginas en todas las páginas del documento.
RecognizePages	Realiza el reconocimiento y la síntesis de páginas de las páginas especificadas del documento.
SaveToFolder	Guarda el contenido del objeto FRDocument en la carpeta especificada.
SplitPages	Divide cada una de las páginas especificadas del documento en varias páginas. Este método resulta útil si la página corresponde a una doble página de un libro o contiene imágenes de varias tarjetas de visita. El método proporciona información sobre cómo se han dividido las páginas.
Synthesize	Realiza la síntesis del documento para todas las páginas del documento.
SynthesizePages	Realiza la síntesis del documento para las páginas especificadas del documento.

​

Objetos relacionados

Diagrama de objetos

​

Parámetro de salida

Este objeto es el parámetro de salida de los métodos CreateFRDocument y CreateFRDocumentFromImage del objeto Engine.

​

Parámetro de entrada

Este objeto se utiliza como parámetro de entrada en los siguientes métodos:

• método CreateObjectFromDocument del objeto ClassificationEngine
• método CompareDocuments del objeto Comparator
• método OnDocumentChanged de la interfaz IDocumentViewerEvents (para Visual Components)
• método OnDocumentChanged de la interfaz ITextValidatorEvents (para Visual Components)

​

Visual Components relacionados

​

Ejemplos

Código C#

FREngine.IEngine engine;
// Crear documento
FREngine.IFRDocument document = Engine.CreateFRDocument();
try {
 // Agregar archivo de imagen al documento
 document.AddImageFile( "D:\\Demo.tif", null, null );
 // Reconocer documento
 document.Process( null );
 // Guardar los resultados en rtf con los parámetros predeterminados
 document.Export( "D:\\Demo.rtf", FREngine.FileExportFormatEnum.FEF_RTF, null );
}
catch( Exception error )
{
 ...
}
finally {
 // Cerrar documento
 document.Close();
}

Código C++ (COM)

FREngine::IEnginePtr Engine;
// Crear documento
FREngine::IFRDocumentPtr frDocument = Engine->CreateFRDocument();
try {
 // Agregar archivo de imagen al documento
 frDocument->AddImageFile( L"D:\\Demo.tif", 0, 0 );
 // Reconocer documento
 frDocument->Process( 0 );
 // Guardar los resultados en rtf con los parámetros predeterminados
 frDocument->Export( L"D:\\Demo.rtf", FREngine::FEF_RTF, 0 );
} catch( _com_error& e ) {
 ...
 // Cerrar documento
 frDocument->Close();
}
// Cerrar documento
frDocument->Close();

El objeto se usa en casi todos los ejemplos de código, excepto en el ejemplo de código BatchProcessing para Linux y Windows.

​

Consulte también

FRPage

IFRDocumentEvents

Procesamiento paralelo con ABBYY FineReader Engine

Trabajar con objetos conectables

Trabajar con propiedades