IDocument - ABBYY Documentation

Representa un documento.

Algunos métodos y propiedades de este objeto no están disponibles en la estación web de verificación para comprobar reglas localmente. Los métodos y propiedades que no se admiten están marcados con un asterisco (*).

Métodos

Método	Descripción
`AddFileToExportResults( sourceFile : string, destinationName : string, replaceIfExists : bool )` *	Añade un archivo de usuario a los resultados de exportación del documento. En el parámetro `sourceFile`, especifique la ruta del archivo de usuario que se va a añadir. Asegúrese de especificar la ruta de exportación raíz en la configuración del proyecto. De lo contrario, el archivo de usuario se colocará en la carpeta del lote de la ubicación de almacenamiento de archivos. En el parámetro `destinationName`, especifique un destino de exportación. Establezca el parámetro `replaceIfExists` en `true` para sobrescribir cualquier archivo existente con el mismo nombre en el destino. Establézcalo en `false` para conservar cualquier archivo existente con el mismo nombre y añadir un mensaje de error al registro.
`CheckRules( )` *	Comprueba todas las reglas del documento. Se requieren permisos de escritura para el documento.
`Field( name : string ) : IField` *	Permite acceder a un campo del documento mediante su ruta completa. Se utilizan rutas completas. Se trata de un campo interno que requiere cargar el objeto en memoria. No se puede usar en reglas.
`HasField( name : string ) : bool` *	Comprueba si existe un campo con la ruta especificada. Se utilizan rutas relativas. Se trata de un campo interno que requiere cargar el objeto en memoria. No se puede usar en reglas.
`IndexedItemValue( name : string ) : VARIANT` *	Recupera el valor de un campo mediante su nombre o ruta. Está disponible para los campos externos de documentos y páginas. Se pueden usar tanto el nombre del campo como su ruta completa. No se puede usar en reglas.
`IndexedItemValues( name : string ) : IVARIANTArray` *	Recupera un conjunto de valores de índice correspondientes a un campo de la Definición de Document mediante su nombre o ruta. Si un campo está marcado como campo de índice en una sección recurrente, el método devuelve todos los valores de ese campo de todas las secciones. Está disponible para los campos externos de documentos y páginas. Se pueden usar tanto el nombre del campo como su ruta completa. No se puede usar en reglas.
`Property( name : string ) : VARIANT`	Recupera el valor de una propiedad especificada por su nombre. El valor devuelto puede ser una cadena, un número o una hora. Para consultar la lista de nombres de propiedades, vea Nombres de propiedades del documento.
`SaveAs( filename : string, [optional] options : IExportImageSavingOptions )` *	Guarda la imagen de un documento de una o varias páginas. Si no se especifica ningún formato en las opciones de guardado, la imagen se guarda en un archivo `*.tif`. Se trata de un campo interno que requiere cargar el objeto en memoria.
`SaveAsStream( [optional] options : IExportImageSavingOptions ) : byte[]` *	Guarda el documento en un flujo de memoria y lo devuelve como una matriz de bytes (COM SafeArray). JScript y VBScript no admiten la iteración en esta matriz.
`SaveXmlToFile( filename : string )` *	Guarda en la ubicación especificada el archivo XML con la descripción del documento sin preprocesamiento, para usarlo en la estación web de verificación.
`SaveXmlToFileStorage( )` *	Guarda en el almacenamiento de archivos el archivo XML con la descripción del documento sin preprocesamiento, para usarlo en la estación web de verificación.

El método Property no debe confundirse con la colección Properties, que contiene las propiedades del documento especificadas por el usuario.

Propiedades

Name	Tipo	Access	Descripción
Action *	IActionResult	De solo lectura	Solo es aplicable en scripts de exportación y posteriores a la exportación.
AsBatchItem *	IBatchItem	De solo lectura	Convierte el documento en un objeto IBatchItem.
AssemblingErrors	IAssemblingErrors	De solo lectura	Una colección de errores de ensamblaje. El acceso a la colección siempre es de solo lectura.
Attachments	IUserAttachments	De solo lectura	Archivos adjuntos del usuario.
Batch	IBatch	De solo lectura	El lote. Independientemente de los permisos del script para el documento, el acceso al lote es de solo lectura y los campos internos de los documentos y las páginas no están disponibles.
BatchName	string	De solo lectura	El nombre del lote.
Children *	IFields	De solo lectura	Campos secundarios (secciones del documento). A diferencia de la propiedad `Sections`, el orden de las secciones corresponde al definido en la Definición de Document. Las secciones recurrentes se representan como un único elemento, y se puede acceder a las instancias mediante el método `Items` de ese elemento. Es un campo interno que requiere cargar el objeto en memoria. No se puede usar en reglas.
Comment	string	Lectura/escritura	Un comentario del documento.
DefinitionName	string	De solo lectura	El nombre de la Definición de Document. En los documentos sin procesar ni reconocer, la propiedad devuelve una cadena vacía.
DocumentDefinition	IDocumentDefinitionInfo	De solo lectura	Información detallada sobre la Definición de Document asociada al documento.
HasErrors	bool	De solo lectura	Indica si el documento tiene errores de campo único o de varios campos.
HasUnpreparedImages	bool	De solo lectura	Indica si el documento contiene páginas sin preprocesar.
HasWarnings	bool	De solo lectura	Indica si el documento tiene advertencias de reglas o de formato.
Id	string	De solo lectura	Identificador del documento (Id. externo). El valor comienza en 1 y es único dentro de un lote.
Index	int	De solo lectura	El índice del documento en el lote. El valor comienza en 0 y es único dentro de una tarea.
IsAnalyzed	bool	De solo lectura	Indica si el documento se ha analizado. El documento se considera analizado si se han analizado todas sus páginas.
IsAssembled	bool	De solo lectura	Indica si el documento está ensamblado.
IsExcludedFromAutomaticAssembling	bool	Lectura/escritura	Indica si el documento está incluido en el ensamblaje automático.
IsExported	bool	De solo lectura	Indica si el documento se ha exportado.
IsRecognized	bool	De solo lectura	Indica si el documento se ha reconocido. El documento se considera reconocido si cada una de sus páginas se ha reconocido o es una página anexa.
IsUsedForTraining	bool	Lectura/escritura	Indica si el documento se utiliza para entrenamiento.
IsVerified	bool	De solo lectura	Indica si el documento se ha verificado.
Pages	IPages	De solo lectura	Páginas del documento.
PreviousStageInfo *	IStageInfo	De solo lectura	Devuelve el objeto IStageInfo, es decir, la etapa de procesamiento del documento. Los campos `TaskId` y `PrincipalId` no se utilizan.
Priority	TProcessingPriority	De solo lectura	La prioridad del documento.
ProcessingErrors *	string	De solo lectura	Errores de procesamiento separados por saltos de línea.
ProcessingWarnings *	string	De solo lectura	Advertencias de procesamiento separadas por saltos de línea.
ProhibitedUserId *	int	De solo lectura	Una tarea creada a partir del documento no está disponible para el usuario con el identificador especificado. De forma predeterminada, el valor es `0`, lo que significa que la tarea está disponible para todos los usuarios.
Properties	IProperties	De solo lectura	Parámetros de registro del documento.
RecognizedSymbolsCount *	int	De solo lectura	El número de símbolos reconocidos.
RuleErrors *	IRuleErrors	De solo lectura	Una colección de errores del documento (errores de formato, errores de regla y errores al combinar los resultados de la doble verificación). Disponible solo para documentos abiertos.
Sections *	IFields	De solo lectura	Una lista simple de secciones del documento. Si hay una sección recurrente, la lista contiene todas sus repeticiones. Las secciones de la lista aparecen en el mismo orden que las primeras páginas de las secciones del documento. Las secciones sin páginas se incluyen al final de la lista. Este es un campo interno que requiere cargar el objeto en memoria. No se puede utilizar en reglas.
StageInfo	IStageInfo	De solo lectura	Información sobre la etapa de procesamiento en el servidor de aplicaciones.
SymbolsForVerificationCount	int	De solo lectura	Número de símbolos que requieren verificación.
TotalSymbolsCount	int	De solo lectura	Número total de símbolos.
UncertainSymbolsCount	int	De solo lectura	Número de símbolos dudosos.

Nombres de propiedades del documento

El método Property recupera los valores de las siguientes propiedades:

Nombre	Valor devuelto
`Exported`	Fecha y hora de exportación del documento
`ExportedBy`	Usuario que exportó el documento
`Created`	Fecha y hora de creación del documento
`CreatedBy`	Usuario que creó el documento
`Recognized`	Fecha y hora de reconocimiento del documento
`RecognizedBy`	Usuario que reconoció el documento
`Modified`	Fecha y hora de la última modificación del documento
`ModifiedBy`	Usuario que modificó el documento
`TotalSymbolsCount`	Número total de símbolos
`UncertainSymbolsCount`	Número total de símbolos no seguros
`RecognizedSymbolsCount`	Número de símbolos reconocidos
`Comment`	Comentario del documento
`ProcessingErrors`	Errores de procesamiento del documento
`ProcessingWarnings`	Advertencias de procesamiento del documento
`Verified`	Fecha y hora de la última edición manual de los campos del documento
`VerifiedBy`	Usuario que realizó los últimos cambios manuales en los campos del documento (no guarda información de las estaciones de procesamiento)