IWorkSpace

Effet produit

Représente l'espace de travail du poste. L'objet est disponible dans les scripts via le mot clé « this ».

Méthodes
Définition Description
AddBatch (target: IWorkspaceItem, name: string, type: IBatchType ):  IWorkspaceItem

Un nouveau lot sera ajouté après le lot spécifié dans le paramètre target.

Si vous voulez ajouter le lot au début de la liste, définissez la valeur du paramètre target sur « Nothing » :

[VBscript]

me.AddBatch Nothing, "batch 1", me.BatchTypes.Item(0)

Si le paramètre name est vide, le nom de lot sera généré en fonction des paramètres du lot.

AddDocument (page: IWorkspaceItem, name: string): IWorkspaceItem Insère la page dans un nouveau document. Si la page est déjà incluse dans le document, trois documents seront créés : un document comportant les pages précédentes, un document comportant la page actuelle et un document comportant les pages suivantes. Si la propriété « name » est vide, le nom sera généré en fonction des paramètres du lot.
AddPages (fileName: string, target: IWorkspaceItem, [optional] inside: bool): IWorkspaceItems Ajoute des pages à partir d'un fichier. Des pages peuvent être ajoutées après l'élément target au même niveau ou à l'intérieur de l'élément target au début de la liste. Une cible peut être un lot, un document ou une page. Si la cible est un lot, le paramètre inside doit être défini sur « true » (les pages seront ajoutées au début du lot). Si la cible est une page, le paramètre inside doit être défini sur « false » (les pages seront ajoutées après la page spécifiée). Si la cible est un document, le paramètre inside peut être « true » ou « false ».
ClearSelection () Efface la sélection en cours
DeleteItem (item: IWorkspaceItem ) Supprime un élément spécifié
DetectPageEmpty (page: IWorkspaceItem, [optional] options: IEmptyPageDetectionOptions ): bool Détecte une page vierge
Exit ( ): bool Termine le travail en cours sur le poste
FindPageBarcodes (page: IWorkspaceItem, [optional] options:  IBarcodeFindingOptions ): IScriptFoundBarcodes Recherche des codes-barres sur la page
NewBarcodeFindingOptions ( ): IBarcodeFindingOptions Définit les options de recherche de codes-barres
NewEmptyPageDetectionOptions ( ): IEmptyPageDetectionOptions Définit les options permettant de détecter les pages vierges
NewImageSavingOptions ( ): IImageSavingOptions Définit les options d'enregistrement de l'image
NewPageRect ( ): IPageRect Définit un rectangle de page
RunScript (scriptName: string, [optional] info: string, [optional] skipShowError: bool): IScriptResult Lance l'exécution du script
Scan ([optional] folder: string) Commence la numérisation avec les paramètres du type de lot en cours
Send (batch: IWorkspaceItem) Exporte le lot avec les paramètres du type de lot en cours
SendByScript (batch: IWorkspaceItem, skipShowExportOptions: bool) Envoie le lot en utilisant un script avec les paramètres du type de lot en cours. Le paramètre skipShowExportOptions définit s'il faut afficher la boîte de dialogue Options d'exportation avant d'envoyer le lot.
SendToFC (batch: IWorkspaceItem, [optional] skipShowExportOptions: bool) Envoie le lot vers ABBYY FlexiCapture avec les paramètres du type de lot en cours. Le paramètre skipShowExportOptions définit s'il faut afficher la boîte de dialogue Options d'exportation avant d'envoyer le lot.
SendToFolder (batch: IWorkspaceItem, [optional] skipShowExportOptions: bool) Exporte le lot vers un dossier avec les paramètres du type de lot en cours. Le paramètre skipShowExportOptions définit s'il faut afficher la boîte de dialogue Options d'exportation avant d'envoyer le lot.
SendToFTP (batch: IWorkspaceItem, [optional] skipShowExportOptions: bool) Exporte le lot vers un dossier FTP avec les paramètres du type de lot en cours. Le paramètre skipShowExportOptions définit s'il faut afficher la boîte de dialogue Options d'exportation avant d'envoyer le lot.
SetPageImage (page: IWorkspaceItem, fileName: string, [optional] filePageIndex: int) Modifie l'image de la page
Wait (millisecond: int) Suspend l'exécution du script pendant la durée définie (en millisecondes)
Propriétés
Nom Type Accès Description
ActiveBatch IWorkspaceItem Lecture/écriture

Le lot actif

Retourne Null pour certains scripts d'événement (par ex. : On batch sending et On batch sent).

Batches IWorkspaceItems Lecture seule Lots
BatchTypes IBatchTypes Lecture seule Types de lots
CurrentBatchType IBatchType Lecture/écriture Le type de lot en cours
Result IScriptResult Lecture seule Le résultat de l'exécution du script
ScriptEnvInfo string Lecture seule

Informations sur les conditions de l'environnement sous lequel le script se déclenche.

Pour les scripts se déclenchant automatiquement avant ou après une exportation, sa valeur est « <exportType> <taskID> », où « exportType » peut être « Folder », « FTP », « FC », « RS » ou « Script » et où « taskID » est l'identificateur de tâche d'exportation.

Pour les scripts déclenchés automatiquement avant ou après la transformation d'une page, la propriété prend l'une des valeurs suivantes : « Rotate <angle> », « FlipHorizontal », « FlipVertical », « Invert », « ConvertToBW », « Descew », « Despeckle », « Erase <rectLeft> <rectTop> <rectRight> <rectBottom> », « Crop <rectLeft> <rectTop> <rectRight> <rectBottom> », « SplitHorizontal <pos> », « SplitVertical <pos> », « ChangeResolution <newRes> », « Scale <ratio> », « FreeScale <newWidth>, <newHeight>, <newRes> ».

ScriptItems IWorkspaceItems Lecture seule

Éléments pour lesquels le script est appelé. La valeur retournée est différente selon les évènements.

Pour les évènements  Au démarrage du poste et  À la fermeture du poste la valeur retournée est vide.

Pour l'évènement Au terme de la numérisation la valeur retournée est une liste de pages ajoutées pendant la session de numérisation.

Pour les autres évènements, la valeur retournée est un lot, un document ou une page selon l'évènement.

Lorsque le script est lancé par une commande utilisateur explicite, un ensemble d'éléments actuellement sélectionnés est retourné.

ScriptProperties IScriptProperties Lecture seule Propriétés du script
Selection IWorkspaceItems Lecture seule La sélection en cours. Contient uniquement des lots, des documents ou des pages.
SourceID string Lecture seule L'identificateur de poste

26.03.2024 13:49:51

Please leave your feedback about this article

Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.