メインコンテンツへスキップ
機能
ワークスペース内のアイテムを表します。バッチ、Document、またはページのいずれかです。
メソッド

Definition

Description

ApplyAutoLevelsFilter()

Important! This method is applicable only to gray and color images.

Automatically configures settings and applies the AdjustLevels filter.

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

Applies the selected enhancement profile to an image.

Example

An example of a script that applies the Photo enhancement profile to all images of the “photo” type:

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

ApplyShadowsHighlightsFilter()

Important! This method is applicable only to gray and color images.

Applies a locally adaptive image contrast enhancement.

ApplySigmaFilter()

Important! This method is applicable only to gray and color images.

Applies a sigma filter to delete digital noise from images.

AutoCrop( [optional] type: string )

Automatically searches for page boundaries on an image, crops the area that contains data for extraction, corrects skews and distortions. Possible values of the optional type are Photo, Scan, Generic.

BackToSourceImage()

Allows you to get back to a source image.

ChangeResolution (int)

Changes image resolution on a page (or all pages) of a document or a batch to the specified value.

ConvertToBW ( )

Converts a page (or all pages) of a document or a batch to black-and-white.

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

Copies a document or a page after the target item, or inside it. A target can be batch, document or page. Insertion can be made after the target at the same level (if the inside parameter is set to “false”) or inside the target to the beginning of the list (if the inside parameter is set to “true”).

CorrectBrightness( brightness: int )

Important! This method is applicable only to gray and color images.

Corrects brightness of an image. Possible values are from -100 to 100.

CorrectContrast( contrast: int )

Important! This method is applicable only to gray and color images.

Corrects contrast of an image. Possible values are from -100 to 100.

Crop (rect: IPageRect)

Crops an area on a page (or all pages) of a document or a batch.

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

Deskews a page (or all pages) of a document or a batch. By default, byLines and byBlackSquares parameters are set to “false” while byText parameter is set to “true”.

Despeckle ([optional] garbageSize: VARIANT)

Despeckles a page (or all pages) of a document or a batch.

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

Erases an area on a page (or all pages) of a document or a batch.

FlipHorizontal ( )

Flips a page (or all pages) of a document or a batch horizontal.

FlipVertical ( )

Flips a page (or all pages) of a document or a batch vertical.

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

Scales a page (or all pages) of a document or a batch according to specified values.

Invert ([optional] rect: IPageRect)

Inverts a page (or all pages) of a document or a batch.

IsPhoto: bool

Shows whether an image is a photo.

IsSuitableForOcr: bool

Shows whether an image is suitable for OCR.

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

Moves a document or a page after the target item, or inside it. A target can be batch, document or page. Insertion can be made after the target at the same level (if the inside parameter is set to “false”) or inside the target to the beginning of the list (if the inside parameter is set to “true”).

RemoveGeometricalDistortions()

Corrects geometrical distortions of trapeziums and crooked lines on an image.

RemoveMotionBlur()

Important! This method is applicable only to gray and color images.

Detects and removes blur that is caused by moving a document or a camera/scanner.

RemoveScannerShadowFromImage()

Removes shadow from a scanner (for example, in the center spread).

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

重要！ このメソッドはカラー画像にのみ適用できます。

画像からスタンプを削除します。

  • colorToFilter
    削除するスタンプの色。文字列値 Red、Green、Blue、Yellow を指定できます (大文字・小文字の区別なし) 。
  • rect
    スタンプを削除する画像内の領域。このパラメーターを指定しない場合、画像全体からスタンプが削除されます。
例

次のスクリプトは、選択範囲内のすべての画像の左半分から青いスタンプを削除するイベントハンドラーです。

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)

重要！ このメソッドはカラー画像にのみ適用されます。

画像からスタンプを削除します：

colorsToFilter - 削除するスタンプの色。

  • 文字列値：Red、Green、Blue、Yellow、Orange、LightBlue、Purple (大文字・小文字の区別なし) 。
  • カンマ区切りで複数の値を指定できます (例：“Red, Green”) 。
  • 値として空の文字列 ("") を指定することもできます。この場合、削除する色は自動的に選択されます。プログラムは、許容値のセットに含まれる色のうち、画像上で検出されたすべての色を削除します。

例

すべての文書ページから赤と緑のスタンプおよびマークを削除するスクリプトの例：

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

ResetPageProfile()

画像補正プロファイルをリセットし、すべての変更を破棄します。

Rotate (angle: int)

文書またはバッチの1ページ (またはすべてのページ) を回転させます。

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

ページ／ページ画像／バッチをファイルに保存します。

複数ページ文書 (またはバッチ) を単一ページ形式で保存しようとすると、例外が返されます。

Scale (ratio: int)

文書またはバッチの1ページ (またはすべてのページ) を、基準値100に対して相対的にスケーリングします。

SplitHorizontal (pos: int)

文書またはバッチの1ページ (またはすべてのページ) を水平方向に分割します。

SplitVertical (pos: int)

文書またはバッチの1ページ (またはすべてのページ) を垂直方向に分割します。

SuitabilityForOCR: float

画像がOCRにどの程度適しているかを示します。値の範囲は0.0〜1.0です。

プロパティ

Attachments

IAttachments

読み取り専用

添付ファイル

BatchInfo (DocumentInfo or PageInfo)

IBatchInfo/ IDocumentInfo / IExportPageInfo

読み取り専用

アイテムのプロパティです。要求されたプロパティがアイテムの型に対応していない場合は、IsBatch (IsDocument または IsPage) のチェックが実行されます。

Children

IWorkspaceItems

読み取り専用

子アイテム

IsBatch (IsDocument or IsPage)

bool

読み取り専用

アイテムがバッチ、Document、またはページのいずれであるかを指定します

IsExported

bool

読み取り/書き込み

アイテムがエクスポート済みかどうかを指定します。変更できるのは、エクスポート前スクリプト内のバッチアイテムのみです。

IsSelected

bool

読み取り/書き込み

アイテムが選択されているかどうかを指定します。特定のアイテムのこのプロパティ値を変更しても、他のアイテムには影響しません。

現在の選択範囲が異なる型の要素で構成されている場合は機能しません。

Index

int

読み取り専用

親コレクション内でのアイテムのインデックス

Name

string

読み取り/書き込み*

アイテム名

Next

IWorkspaceItem

読み取り専用

次のアイテム

Parent

IWorkspaceItem

読み取り専用

親アイテム

Prev

IWorkspaceItem

読み取り専用

前のアイテム

ScriptProperties

IScriptProperties

読み取り専用

スクリプトのプロパティ

  • – 注: IWorkspaceItem がページを表す場合、Name プロパティは読み取り専用です。