Passer au contenu principal

Description

Représente l’espace de travail de la station. Cet objet est accessible dans les scripts via le mot-clé this.

Méthodes

DéfinitionDescription
AddBatch( target: IWorkspaceItem, name: string, type: IBatchType ): IWorkspaceItemAjoute un lot. Un nouveau lot est ajouté après le lot spécifié dans le paramètre target. Pour ajouter le lot au début de la liste, définissez le paramètre target sur “Nothing” (VBScript: me.AddBatch Nothing, "batch 1", me.BatchTypes.Item(0)). Si le paramètre name est vide, le nom du lot est généré en fonction des paramètres du lot.
AddDocument( page: IWorkspaceItem, name: string ): IWorkspaceItemInsère la page dans un nouveau document. Si la page est déjà incluse dans le document, trois documents sont créés : un avec les pages précédentes, un avec la page actuelle et un avec les pages suivantes. Si le paramètre name est vide, le nom du document est généré en fonction des paramètres du lot.
AddPages( fileName: string, target: IWorkspaceItem, [facultatif] inside: bool ): IWorkspaceItemsAjoute des pages à partir d’un fichier. Les 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. La cible peut être un batch, un document ou une page. Si la cible est un batch, le paramètre inside doit être “true” (les pages sont ajoutées au début du batch). Si la cible est une page, le paramètre inside doit être “false” (les pages sont 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 actuelle
DeleteItem( item: IWorkspaceItem )Supprime l’élément spécifié
DetectPageEmpty( page: IWorkspaceItem, [facultatif] options: IEmptyPageDetectionOptions ): boolDétecte une page vide
Exit(): boolMet fin au travail de la station
FindPageBarcodes( page: IWorkspaceItem, [facultatif] options: IBarcodeFindingOptions ): IScriptFoundBarcodesRecherche les code-barres sur la page
NewBarcodeFindingOptions(): IBarcodeFindingOptionsDéfinit les options de recherche de code-barres
NewEmptyPageDetectionOptions(): IEmptyPageDetectionOptionsDéfinit les options de détection des pages vides
NewImageSavingOptions(): IImageSavingOptionsDéfinit les options d’enregistrement des images
NewPageRect(): IPageRectDéfinit un rectangle de page
RunScript( scriptName: string, [optionnel] info: string, [optionnel] skipShowError: bool ): IScriptResultExécute le script
Scan( [facultatif] folder: string )Lance la numérisation avec les paramètres du type de lot courant
Send( batch: IWorkspaceItem )Exporte le lot avec les paramètres du type de lot courant
SendByScript( batch: IWorkspaceItem, skipShowExportOptions: bool )Envoie le lot au moyen d’un script, avec les paramètres du type de lot actuel. Le paramètre skipShowExportOptions indique s’il faut afficher la boîte de dialogue Options d’export avant l’envoi du lot.
SendToFC( batch: IWorkspaceItem, [facultatif] skipShowExportOptions: bool )Envoie le lot à ABBYY FlexiCapture avec les paramètres du type de lot actuel. Le paramètre skipShowExportOptions indique s’il faut afficher la boîte de dialogue Options d’export avant l’envoi du lot.
SendToFolder( batch: IWorkspaceItem, [optional] skipShowExportOptions: bool )Exporte le lot dans un dossier en utilisant les paramètres du type de lot actuel. Le paramètre skipShowExportOptions indique s’il faut afficher la boîte de dialogue Options d’export avant l’envoi du lot.
SendToFTP( batch: IWorkspaceItem, [facultatif] skipShowExportOptions: bool )Exporte le lot vers un dossier FTP en utilisant les paramètres du type de lot actuel. Le paramètre skipShowExportOptions indique s’il faut afficher la boîte de dialogue Options d’export avant l’envoi du lot.
SetPageImage( page: IWorkspaceItem, fileName: string, [facultatif] filePageIndex: int )Remplace l’image de la page
Wait( millisecond: int )Suspend l’exécution du script pendant la durée spécifiée (en millisecondes)

Propriétés

NomTypeAccèsDescription
ActiveBatchIWorkspaceItemLecture/écritureLe lot actif. Pour certains scripts d’événement (par exemple, Lors de l’envoi du lot et Après l’envoi du lot), renvoie null.
BatchesIWorkspaceItemsLecture seuleLots
BatchTypesIBatchTypesLecture seuleTypes de lots
CurrentBatchTypeIBatchTypeLecture/écritureLe type de lot en cours
ResultIScriptResultLecture seuleLe résultat de l’exécution du script
ScriptEnvInfostringLecture seuleInformations d’environnement sur les conditions de déclenchement du script. Pour les scripts déclenchés automatiquement avant ou après l’export, sa valeur est <exportType> <taskID>, où exportType peut être “Folder”, “FTP”, “FC”, “RS” ou “Script” et taskID est l’identifiant de la tâche d’export. 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, Deskew, Despeckle, Erase <rectLeft> <rectTop> <rectRight> <rectBottom>, Crop <rectLeft> <rectTop> <rectRight> <rectBottom>, SplitHorizontal <pos>, SplitVertical <pos>, ChangeResolution <newRes>, Scale <ratio>, FreeScale <newWidth>, <newHeight>, <newRes>.
ScriptItemsIWorkspaceItemsLecture seuleÉléments pour lesquels le script est exécuté. La valeur renvoyée diffère selon l’événement. Pour les événements Au démarrage de la station et À la fermeture de la station, la valeur renvoyée est vide. Pour l’événement À la fin de la numérisation, la valeur renvoyée est une liste des pages ajoutées pendant la session de numérisation. Pour les autres événements, la valeur renvoyée est un lot, un document ou une page, selon l’événement. Lorsque le script est lancé par une commande utilisateur explicite, une collection des éléments actuellement sélectionnés est renvoyée.
ScriptPropertiesIScriptPropertiesLecture seulePropriétés du script
SelectionIWorkspaceItemsLecture seuleLa sélection actuelle. Contient uniquement des lots, uniquement des documents ou uniquement des pages.
SourceIDstringLecture seuleL’identifiant de la station