Qué hace
Métodos
AddFileToExportResults( sourceFile : string, destinationName : string, replaceIfExists : bool ) * | Agrega un archivo de usuario a los resultados de exportación de documentos. En el parámetro sourceFile , especifique la ruta del archivo de usuario que se va a agregar. Nota: Asegúrese de especificar la ruta raíz de exportación en la configuración del proyecto. De lo contrario, el archivo de usuario se colocará en la carpeta del lote dentro 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 si desea sobrescribir cualquier archivo existente con el mismo nombre en el destino. Establezca el parámetro replaceIfExists en false si desea conservar cualquier archivo existente con el mismo nombre en el destino y agregar un mensaje de error al log. |
CheckRules( ) * | Comprueba todas las reglas del documento. Se requieren permisos de escritura sobre el documento. |
Permite acceder a un campo del documento mediante la ruta completa del campo. Se utilizan rutas completas. Es un campo interno**. No puede usarse en reglas. | |
HasField( name : string ) : bool * | Comprueba si existe un campo con la ruta especificada. Se usan rutas relativas. Es un campo interno**. No puede usarse en reglas. |
IndexedItemValue( name : string ) : VARIANT * | Recupera el valor del campo por nombre o por la ruta al campo. Está disponible desde los campos externos de los documentos y las páginas. Se puede 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 a partir del nombre o de la ruta del campo. Si un campo está marcado como campo de índice en la sección recurrente, el método devuelve todos los valores del campo de todas las secciones. Disponible en los campos externos de documentos y páginas. Se puede usar tanto el nombre del campo como la ruta completa al campo. 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. Nombres de las propiedades y valores devueltos:
|
SaveAs( filename : string, [optional] options : IExportImageSavingOptions ) * | Guarda la imagen de un documento de una sola página o de varias páginas. Si no se especifica ningún formato de guardado en las opciones, la imagen se guarda en un archivo *.tif. Este es un ** campo interno. |
SaveAsStream( [opcional] options: IExportImageSavingOptions) : byte[] * | Guarda el documento en un flujo de memoria y lo devuelve como un array de bytes (COM SafeArray). Nota: JScript y VBScript no admiten la iteración en este array. |
SaveXmlToFile( filename : string ) * | Guarda el archivo XML con la descripción del documento sin preprocesar en la ubicación especificada 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 su uso en la estación web de verificación. |
Propiedades
Acción * | De solo lectura | Solo surte efecto en scripts de exportación y posteriores a la exportación. | |
AsBatchItem * | De solo lectura | Convierte el documento en un objeto IBatchItem. | |
AssemblingErrors | De solo lectura | Una colección de errores de ensamblaje. El acceso a la colección es siempre de solo lectura. | |
Archivos adjuntos | De solo lectura | Archivos adjuntos del usuario | |
Lote | De solo lectura | El lote. Independientemente de los permisos del script sobre el documento, el acceso al lote es de solo lectura y los campos internos** de los documentos y las páginas no están accesibles. | |
BatchName | string | De solo lectura | El nombre del lote. |
Children * | De solo lectura | Campos secundarios (secciones del documento). A diferencia de la propiedad Sections, el orden de las secciones se corresponde con su orden 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**. No se puede usar en reglas. | |
Comentario | string | Lectura/escritura | Comentario del documento. |
DefinitionName | string | De solo lectura | El nombre de la Definición de Document. En el caso de los documentos no procesados ni reconocidos, la propiedad devuelve una cadena vacía. |
DocumentDefinition | De solo lectura | Información detallada sobre la Definición de Document que coincide con el documento. | |
HasErrors | bool | De solo lectura | Especifica si el documento tiene errores de uno o varios campos. |
HasUnpreparedImages | bool | De solo lectura | Indica si el documento contiene páginas sin preprocesar. |
HasWarnings | bool | De solo lectura | Especifica si el documento tiene advertencias relacionadas con reglas o formato. |
Id | cadena | De solo lectura | Identificador del documento (ID externa). El valor comienza con 1 y es único solo dentro de un lote. |
Index | int | De solo lectura | El índice del documento dentro del lote. El valor empieza en 0 y solo es único dentro de una misma tarea. |
IsAnalyzed | bool | De solo lectura | Especifica si el documento se ha analizado. El documento se considera analizado si se han analizado todas las páginas del documento. |
IsAssembled | bool | De solo lectura | Indica si el documento está ensamblado. |
IsExcludedFromAutomaticAssembling | bool | Lectura y escritura | Indica si el documento está incluido en el ensamblado automático. |
IsExported | bool | De solo lectura | Indica si el documento se ha exportado. |
IsRecognized | bool | De solo lectura | Especifica si el documento se ha reconocido. El documento se considera reconocido si cada página del documento se ha reconocido o es una página de anexo. |
IsUsedForTraining | bool | Lectura y escritura | Especifica si el documento se usa para entrenamiento. |
IsVerified | bool | De solo lectura | Indica si el documento está verificado. |
Pages | De solo lectura | Páginas del documento. | |
PreviousStageInfo * | De solo lectura | Devuelve el objeto IStageInfo, es decir, la fase de procesamiento del documento. Los campos TaskId y PrincipalId no se utilizan. | |
Prioridad | 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 estará 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. |
Propiedades | De solo lectura | Parámetros de registro del documento. | |
RecognizedSymbolsCount * | int | De solo lectura | Número de símbolos reconocidos. |
RuleErrors * | De solo lectura | Una colección de errores del documento (errores de formato, errores de reglas, errores al combinar resultados de doble verificación). Nota: Disponible solo para documentos abiertos. | |
Secciones * | De solo lectura | Una lista simple de secciones del documento. Si hay una sección repetida, la lista contiene todas sus repeticiones. Las secciones de la lista siguen el mismo orden que las primeras páginas de las secciones del documento. Las secciones sin páginas aparecen al final de la lista. Es un campo interno**. No se puede usar en reglas. | |
StageInfo | De solo lectura | Información sobre la etapa de procesamiento en el Servidor de aplicaciones. | |
SymbolsForVerificationCount | int | De solo lectura | El 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 | El número de símbolos dudosos. |