IWorkspaceItem

ABBYY Scanning Station のスクリプトモデルにおける IWorkspaceItem オブジェクト: バッチ内のページを編集、切り抜き、変換、保存するためのメソッドとプロパティ。

​

機能

ワークスペース内のアイテムを表します。バッチ、Document、またはページのいずれかです。

​

メソッド

定義	説明
ApplyAutoLevelsFilter()	重要: このメソッドは、グレースケール画像およびカラー画像にのみ適用できます。設定を自動調整し、AdjustLevels フィルターを適用します。
ApplyPageProfile( name: string, [optional] onlyModificators: bool )	選択した画像補正プロファイルを画像に適用します。補正プロファイルを適用するを参照してください。
ApplyShadowsHighlightsFilter()	重要: このメソッドは、グレースケール画像およびカラー画像にのみ適用できます。局所適応型の画像コントラスト補正を適用します。
ApplySigmaFilter()	重要: このメソッドは、グレースケール画像およびカラー画像にのみ適用できます。画像からデジタルノイズを除去するために sigma フィルターを適用します。
AutoCrop( [optional] type: string )	画像内のページ境界を自動的に検出し、データ抽出対象の領域を切り抜いて、傾きやゆがみを補正します。省略可能な type に指定できる値は Photo、Scan、Generic です。
BackToSourceImage()	元の画像に戻ります。
ChangeResolution( int )	文書またはバッチのページ (またはすべてのページ) の画像解像度を指定した値に変更します。
ConvertToBW()	文書またはバッチのページ (またはすべてのページ) を白黒画像に変換します。
Copy( target: IWorkspaceItem, [optional] inside: bool ): IWorkspaceItem	文書またはページを、対象アイテムの後に、またはその内部にコピーします。対象にはバッチ、文書、またはページを指定できます。挿入は、対象と同じレベルでその後に行うことも (inside パラメーターが “false” に設定されている場合) 、対象の内部のリスト先頭に行うこともできます (inside パラメーターが “true” に設定されている場合) 。
CorrectBrightness( brightness: int )	重要: このメソッドは、グレースケール画像およびカラー画像にのみ適用できます。画像の明るさを補正します。指定可能な値は -100 ～ 100 です。
CorrectContrast( contrast: int )	重要: このメソッドは、グレースケール画像およびカラー画像にのみ適用できます。画像のコントラストを補正します。指定可能な値は -100 ～ 100 です。
Crop( rect: IPageRect )	文書またはバッチのページ (またはすべてのページ) の領域を切り抜きます。
Deskew( [optional] byLines: bool, [optional] byBlackSquares: bool, [optional] byText: bool )	文書またはバッチのページ (またはすべてのページ) の傾きを補正します。既定では、byLines と byBlackSquares パラメーターは “false”、byText パラメーターは “true” に設定されています。
Despeckle( [optional] garbageSize: VARIANT )	文書またはバッチのページ (またはすべてのページ) のごみを除去します。
Erase( rect: IPageRect, [optional] rColor: int, [optional] gColor: int, [optional] bColor: int )	文書またはバッチのページ (またはすべてのページ) の領域を消去します。
FlipHorizontal()	文書またはバッチのページ (またはすべてのページ) を左右反転します。
FlipVertical()	文書またはバッチのページ (またはすべてのページ) を上下反転します。
FreeScale( newWidth: int, newHeight: int, newResolution: int )	文書またはバッチのページ (またはすべてのページ) を、指定した値に従って拡大縮小します。
Invert( [optional] rect: IPageRect )	文書またはバッチのページ (またはすべてのページ) の色を反転します。
IsPhoto: bool	画像が写真かどうかを示します。
IsSuitableForOcr: bool	画像が OCR に適しているかどうかを示します。
Move( target: IWorkspaceItem, [optional] inside: bool )	文書またはページを、対象アイテムの後に、またはその内部に移動します。対象にはバッチ、文書、またはページを指定できます。挿入は、対象と同じレベルでその後に行うことも (inside パラメーターが “false” に設定されている場合) 、対象の内部のリスト先頭に行うこともできます (inside パラメーターが “true” に設定されている場合) 。
RemoveGeometricalDistortions()	画像内の台形ゆがみや曲がった線などの幾何学的なゆがみを補正します。
RemoveMotionBlur()	重要: このメソッドは、グレースケール画像およびカラー画像にのみ適用できます。文書やカメラ/スキャナの動きによって生じたぶれを検出して除去します。
RemoveScannerShadowFromImage()	スキャナによる影を除去します (たとえば、見開き中央の影) 。
RemoveStamps( colorToFilter: string, [optional] rect: IPageRect )	重要: このメソッドはカラー画像にのみ適用できます。画像からスタンプを削除します。colorToFilter — 削除するスタンプの色です。文字列値 Red、Green、Blue、Yellow を受け付けます (大文字と小文字は区別されません) 。rect — スタンプを削除する画像の領域です。このパラメーターを指定しない場合、画像全体からスタンプが削除されます。画像の一部からスタンプを削除するを参照してください。
RemoveStampsExt( colorsToFilter: string )	重要: このメソッドはカラー画像にのみ適用できます。画像からスタンプを削除します。colorsToFilter — 削除するスタンプの色です。文字列値: Red、Green、Blue、Yellow、Orange、LightBlue、Purple (大文字と小文字は区別されません) 。複数の値をカンマ区切りで指定できます (たとえば、“Red, Green”) 。値として空文字列 ("") を指定することもできます。この場合、削除する色は自動的に選択され、プログラムは許容値の集合の中から画像内で見つかったすべての色を削除します。特定の色のスタンプを削除するを参照してください。
ResetPageProfile()	画像補正プロファイルをリセットし、すべての変更を破棄します。
Rotate( angle: int )	文書またはバッチのページ (またはすべてのページ) を回転します。
SaveAs( fileName: string, [optional] options: IImageSavingOptions )	ページ、ページ画像、またはバッチをファイルに保存します。複数ページ文書 (またはバッチ) を単一ページ形式で保存すると、例外が返されます。
Scale( ratio: int )	100 を基準値として、ドキュメントまたはバッチのページ (またはすべてのページ) を拡大または縮小します。
SplitHorizontal( pos: int )	ドキュメントまたはバッチのページ (またはすべてのページ) を水平方向に分割します。
SplitVertical( pos: int )	ドキュメントまたはバッチのページ (またはすべてのページ) を垂直方向に分割します。
SuitabilityForOCR: float	画像が Optical Character Recognition (OCR) にどの程度適しているかを示します。値の範囲は 0.0 から 1.0 です。

​

プロパティ

名前	型	アクセス	説明
Attachments	IAttachments	読み取り専用	添付ファイル
BatchInfo (DocumentInfo or PageInfo)	IBatchInfo / IDocumentInfo / IExportPageInfo	読み取り専用	アイテムのプロパティ。要求されたプロパティがアイテムの種類に対応していない場合は、IsBatch (IsDocument または IsPage) のチェックが行われます。
Children	IWorkspaceItems	読み取り専用	子アイテム
IsBatch (IsDocument or IsPage)	bool	読み取り専用	アイテムがバッチ、文書、またはページであるかどうかを指定します
IsExported	bool	読み取り/書き込み	アイテムがエクスポート済みかどうかを指定します。変更できるのは、エクスポート前スクリプト内のバッチアイテムのみです。
IsSelected	bool	読み取り/書き込み	アイテムが選択されているかどうかを指定します。特定のアイテムのこのプロパティ値を変更しても、ほかのアイテムには影響しません。現在の選択範囲が別の種類のアイテムで構成されている場合は機能しません。
Index	int	読み取り専用	親コレクション内のアイテムのインデックス
Name	string	読み取り/書き込み	アイテム名。注: IWorkspaceItem がページを表す場合、このプロパティは読み取り専用です。
Next	IWorkspaceItem	読み取り専用	次のアイテム
Parent	IWorkspaceItem	読み取り専用	親アイテム
Prev	IWorkspaceItem	読み取り専用	前のアイテム
ScriptProperties	IScriptProperties	読み取り専用	スクリプトプロパティ

​

例

​

画像補正プロファイルを適用する

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");
    }
}

​

画像の一部からスタンプを削除

選択範囲内にあるすべての画像の左半分から青いスタンプを削除するイベントハンドラー:

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);
    }
}

​

特定の色のスタンプを削除

すべての文書ページから赤と緑のスタンプやマークを削除するスクリプト:

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