Passer au contenu principal
Description
Représente un élément de l’espace de travail. Il peut s’agir d’un lot, d’un document ou d’une page.
Méthodes

Définition

Description

ApplyAutoLevelsFilter()

Important ! Cette méthode s’applique uniquement aux images en niveaux de gris et en couleur.

Configure automatiquement les paramètres et applique le filtre AdjustLevels.

ApplyPageProfile( name: string, [optional] onlyModificators: bool )

Applique le profil d’amélioration sélectionné à une image.

Exemple

Exemple de script appliquant le profil d’amélioration Photo à toutes les images de type « photo » :

foreach( IWorkspaceItem item in Workspace.Selection )
{
if (item.PageInfo.IsPhoto)
{
item.ApplyPageProfile(“Photo”);
}
}

ApplyShadowsHighlightsFilter()

Important ! Cette méthode s’applique uniquement aux images en niveaux de gris et en couleur.

Applique une amélioration adaptative locale du contraste de l’image.

ApplySigmaFilter()

Important ! Cette méthode s’applique uniquement aux images en niveaux de gris et en couleur.

Applique un filtre sigma pour supprimer le bruit numérique des images.

AutoCrop( [optional] type: string )

Recherche automatiquement les limites de la page sur une image, recadre la zone contenant les données à extraire, et corrige les inclinaisons et distorsions. Les valeurs possibles du paramètre type facultatif sont Photo, Scan, Generic.

BackToSourceImage()

Permet de revenir à l’image source.

ChangeResolution (int)

Modifie la résolution de l’image sur une page (ou toutes les pages) d’un document ou d’un lot à la valeur spécifiée.

ConvertToBW ( )

Convertit une page (ou toutes les pages) d’un document ou d’un lot en noir et blanc.

Copy (target: IWorkspaceItem, [optional] inside: bool): IWorkspaceItem

Copie un document ou une page après l’élément cible, ou à l’intérieur de celui-ci. La cible peut être un lot, un document ou une page. L’insertion peut être effectuée après la cible au même niveau (si le paramètre inside est défini sur « false ») ou à l’intérieur de la cible, au début de la liste (si le paramètre inside est défini sur « true »).

CorrectBrightness( brightness: int )

Important ! Cette méthode s’applique uniquement aux images en niveaux de gris et en couleur.

Corrige la luminosité d’une image. Les valeurs possibles sont comprises entre -100 et 100.

CorrectContrast( contrast: int )

Important ! Cette méthode s’applique uniquement aux images en niveaux de gris et en couleur.

Corrige le contraste d’une image. Les valeurs possibles sont comprises entre -100 et 100.

Crop (rect: IPageRect)

Recadre une zone sur une page (ou toutes les pages) d’un document ou d’un lot.

Deskew ([optional] byLines: bool, [optional] byBlackSquares: bool, [optional] byText: bool)

Redresse une page (ou toutes les pages) d’un document ou d’un lot. Par défaut, les paramètres byLines et byBlackSquares sont définis sur « false », tandis que le paramètre byText est défini sur « true ».

Despeckle ([optional] garbageSize: VARIANT)

Supprime les taches parasites sur une page (ou toutes les pages) d’un document ou d’un lot.

Erase (rect: IPageRect, [optional] rColor: int, [optional] gColor: int, [optional] bColor: int)

Efface une zone sur une page (ou toutes les pages) d’un document ou d’un lot.

FlipHorizontal ( )

Retourne une page (ou toutes les pages) d’un document ou d’un lot horizontalement.

FlipVertical ( )

Retourne une page (ou toutes les pages) d’un document ou d’un lot verticalement.

FreeScale (newWidth: int, newHeight: int, newResolution: int)

Met à l’échelle une page (ou toutes les pages) d’un document ou d’un lot selon les valeurs spécifiées.

Invert ([optional] rect: IPageRect)

Inverse une page (ou toutes les pages) d’un document ou d’un lot.

IsPhoto: bool

Indique si une image est une photo.

IsSuitableForOcr: bool

Indique si une image est adaptée à la reconnaissance optique de caractères (OCR).

Move (target: IWorkspaceItem, [optional] inside: bool)

Déplace un document ou une page après l’élément cible, ou à l’intérieur de celui-ci. La cible peut être un lot, un document ou une page. L’insertion peut être effectuée après la cible au même niveau (si le paramètre inside est défini sur « false ») ou à l’intérieur de la cible, au début de la liste (si le paramètre inside est défini sur « true »).

RemoveGeometricalDistortions()

Corrige les distorsions géométriques des trapèzes et des lignes de travers sur une image.

RemoveMotionBlur()

Important ! Cette méthode s’applique uniquement aux images en niveaux de gris et en couleur.

Détecte et supprime le flou causé par le déplacement d’un document ou d’un appareil photo/scanner.

RemoveScannerShadowFromImage()

Supprime l’ombre provenant d’un scanner (par exemple, au centre d’une double page).

RemoveStamps (colorToFilter: string, [optional] rect: IPageRect)

Important ! Cette méthode s’applique uniquement aux images en couleur.

Supprime les tampons des images.

  • colorToFilter
    La couleur des tampons à supprimer. Accepte les valeurs de type string Red, Green, Blue et Yellow (non sensible à la casse).
  • rect
    La zone de l’image dont vous souhaitez supprimer les tampons. Si ce paramètre n’est pas spécifié, les tampons seront supprimés de l’intégralité de l’image.
Exemple

Le script suivant est un gestionnaire d’événements qui supprime les tampons bleus de la moitié gauche de toutes les images de la sélection.

foreach (IWorkspaceItem item in Workspace.Selection)
{
if (item.IsPage && item.PageInfo.IsColor)
{
IPageRect rect = Workspace.NewPageRect();
rect.Left = 0;
rect.Right = item.PageInfo.Width / 2;
rect.Top = 0;
rect.Bottom = item.PageInfo.Height;
item.RemoveStamps(“blue”, rect);
}
}

RemoveStampsExt (colorsToFilter: string)

Important ! Cette méthode s’applique uniquement aux images couleur.

Supprime les tampons des images :

colorsToFilter - couleur des tampons à supprimer.

  • Valeurs de type string : Red, Green, Blue, Yellow, Orange, LightBlue, Purple (quelle que soit la casse).
  • Vous pouvez spécifier plusieurs valeurs séparées par une virgule (par exemple, “Red, Green”).
  • Vous pouvez également spécifier une chaîne vide comme valeur (""). Dans ce cas, les couleurs à supprimer sont sélectionnées automatiquement. Le programme supprime toutes les couleurs trouvées dans l’image parmi l’ensemble des valeurs autorisées.

Exemple

Exemple de script qui supprime les tampons et marques rouges et verts de toutes les pages du document :

foreach( IWorkspaceItem item in Workspace.Selection )
{
if (item.PageInfo.IsColor)
{
item.RemoveStampsExt(“Red,Green”);
}
}

ResetPageProfile()

Réinitialise le profil d’amélioration d’image et annule toutes les modifications.

Rotate (angle: int)

Fait pivoter une page (ou toutes les pages) d’un document ou d’un lot.

SaveAs (fileName: string, [optional] options: IImageSavingOptions)

Enregistre des pages/une image de page/un lot dans un fichier.

Lors de l’enregistrement d’un document multi-pages (ou d’un lot) dans un format mono-page, une exception est levée.

Scale (ratio: int)

Met à l’échelle une page (ou toutes les pages) d’un document ou d’un lot par rapport à la valeur de base 100.

SplitHorizontal (pos: int)

Divise une page (ou toutes les pages) d’un document ou d’un lot horizontalement.

SplitVertical (pos: int)

Divise une page (ou toutes les pages) d’un document ou d’un lot verticalement.

SuitabilityForOCR: float

Indique dans quelle mesure une image est adaptée à la reconnaissance optique de caractères (OCR). Les valeurs possibles sont comprises entre 0,0 et 1,0.

Propriétés

Attachments

IAttachments

Lecture seule

Pièces jointes

BatchInfo (DocumentInfo or PageInfo)

IBatchInfo/ IDocumentInfo / IExportPageInfo

Lecture seule

Propriétés de l’élément. Si la propriété demandée ne correspond pas au type de l’élément, la vérification IsBatch (IsDocument ou IsPage) est effectuée.

Children

IWorkspaceItems

Lecture seule

Éléments enfants

IsBatch (IsDocument or IsPage)

bool

Lecture seule

Indique si l’élément est un lot, un document ou une page

IsExported

bool

Lecture/écriture

Indique si l’élément a été exporté. Cette propriété ne peut être modifiée que pour les éléments de lot dans les scripts de pré-export.

IsSelected

bool

Lecture/écriture

Indique si l’élément est sélectionné. La modification de la valeur de cette propriété pour un élément donné n’affecte pas les autres éléments.

Ne fonctionne pas si la sélection actuelle se compose d’éléments d’un autre type.

Index

int

Lecture seule

L’indice de l’élément dans la collection parente

Name

string

Lecture/écriture*

Nom de l’élément

Next

IWorkspaceItem

Lecture seule

L’élément suivant

Parent

IWorkspaceItem

Lecture seule

L’élément parent

Prev

IWorkspaceItem

Lecture seule

L’élément précédent

ScriptProperties

IScriptProperties

Lecture seule

Propriétés du script

  • Remarque. Si IWorkspaceItem est utilisé pour représenter une page, la propriété Name est en lecture seule.