IBatch - ABBYY Documentation

Representa el lote.

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

Métodos

Los siguientes métodos requieren permisos para modificar la estructura Batch. Solo pueden llamarse desde el script de procesamiento de lote.

Método	Descripción
`CleanRecognitionResults( document : IDocument )` *	Elimina los resultados de reconocimiento del documento.
`CreateDocumentFromPage( targetPosition : int, page : IPage ) : IDocument` *	Toma una página del documento y crea un nuevo documento a partir de ella. En el parámetro `targetPosition`, especifique el índice del nuevo documento en el lote. El índice debe ser un número entre 0 y N, donde N es el número total de documentos del lote. Para obtener más información, consulte Crear un documento a partir de una página.
`CreatePageFromImage( page : IPictureObject, [optional] target : IDocument, [optional] position : int, [optional] sourceInfo : string ) : IPage` *	Crea una página a partir de un objeto IPictureObject y devuelve la página creada. Para obtener más información, consulte Crear una página a partir de una imagen.
`DeleteDocument( document : IDocument )` *	Elimina el documento.
`DeletePage( page : IPage )` *	Elimina la página.
`MoveDocument( source : IDocument, targetPosition : int )` *	Mueve el documento a la posición especificada del lote.
`MovePage( source : IDocument, target : IDocument, sourcePageIndex : int, targetPageIndex : int )` *	Mueve la página con índice `sourcePageIndex` del documento de origen a la posición `targetPageIndex` del documento de destino.

Crear un documento a partir de una página

El método CreateDocumentFromPage toma una página de un documento y crea un documento nuevo a partir de ella. Especifique el índice del nuevo documento en el parámetro targetPosition. El índice debe ser un número entre 0 y N, donde N es el número total de documentos del lote. Al llamar al método:

Los documentos con índices del 0 al targetPosition - 1 permanecen en sus posiciones originales.
Los documentos con índices desde targetPosition hasta N avanzan una posición.
El nuevo documento se coloca en la posición targetPosition que queda vacante.

Si el documento queda vacío después de quitar la página, se elimina. En el siguiente ejemplo se procesa el primer documento:

IDocument document = Documents[0];
for( int i = document.Pages.Count - 1; i >= 0; --i ) 
{
    Batch.CreateDocumentFromPage( document.Index + 1, document.Pages[i] );
}

Crear una página a partir de una imagen

El método CreatePageFromImage crea una página a partir de un objeto IPictureObject y devuelve la página creada:

Si se especifica un documento de destino, la página se agrega a dicho documento. Para crear un documento de una sola página, especifique null como documento de destino.
Si se especifica una posición, la página se agrega en la posición indicada del documento (cuando se especifica un documento de destino). De lo contrario, se agrega un documento de una sola página en la posición indicada del lote (cuando se especifica null como documento de destino). La posición inicial corresponde a 0 y el final del documento o del lote corresponde a -1.
Si se especifica el parámetro sourceInfo, se incluye en la información sobre el origen de la página. De lo contrario, la información sobre el origen de la página se obtiene de IPictureObject.

Propiedades

Nombre	Tipo	Acceso	Descripción
AsBatchItem *	IBatchItem	De solo lectura	Convierte el lote en un objeto IBatchItem.
Attachments	IUserAttachments	De solo lectura	Archivos adjuntos del usuario.
BatchTypeName	string	De solo lectura	El nombre del tipo de lote.
Comment	string	Lectura/escritura	El comentario.
CreatedBy	IPrincipal	De solo lectura	El autor del lote recién creado. En la versión Standalone de ABBYY FlexiCapture, devuelve `null`.
CreationDate	DateTime	De solo lectura	La fecha y hora de creación del lote.
Documents	IDocuments	De solo lectura	Los documentos que componen el lote.
Id	int	De solo lectura	El identificador del lote (único dentro del proyecto).
Name	string	Lectura/escritura	El nombre del lote.
Priority	TProcessingPriority	Lectura/escritura	La prioridad del lote.
Project	IProject	De solo lectura	El proyecto que contiene el lote.
Properties	IProperties	De solo lectura	Parámetros con nombre del lote.
SLAExpirationDate	DateTime	Lectura/escritura	Fecha límite de procesamiento del lote.
SlaStartDate	DateTime	De solo lectura	La fecha y hora de inicio del procesamiento del lote.
SlaWarningPeriod *	Int	Lectura/escritura	El momento de inicio del período durante el cual se muestra una advertencia sobre la proximidad de la fecha límite de la tarea. Se especifica como los minutos restantes hasta la fecha límite.
StageInfo	IStageInfo	De solo lectura	Devuelve el objeto IStageInfo con información sobre la etapa de procesamiento del documento. Los campos `TaskId` y `PrincipalId` no se utilizan.

​Métodos

​Crear un documento a partir de una página

​Crear una página a partir de una imagen

​Propiedades

Métodos

Crear un documento a partir de una página

Crear una página a partir de una imagen

Propiedades