IWorkspaceItem - ABBYY Documentation

Represents an item of the workspace. Can be a batch, a document or a page.

Methods

Definition	Description
ApplyAutoLevelsFilter()	Automatically configures settings and applies the AdjustLevels filter. Applies only to gray and color images.
ApplyPageProfile( name: string, [optional] onlyModificators: bool )	Applies the selected enhancement profile to an image. See Apply an enhancement profile.
ApplyShadowsHighlightsFilter()	Applies a locally adaptive image contrast enhancement. Applies only to gray and color images.
ApplySigmaFilter()	Applies a sigma filter to delete digital noise from images. Applies only to gray and color images.
AutoCrop( [optional] type: string )	Automatically searches for page boundaries on an image, crops the area that contains data for extraction, and corrects skews and distortions. Possible values of the optional `type` are `Photo`, `Scan`, and `Generic`.
BackToSourceImage()	Returns to the 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 a batch, a document, or a page. Set `inside` to `false` to insert after the target at the same level. Set it to `true` to insert inside the target, at the beginning of the list.
CorrectBrightness( brightness: int )	Corrects the brightness of an image. Possible values are from `-100` to `100`. Applies only to gray and color images.
CorrectContrast( contrast: int )	Corrects the contrast of an image. Possible values are from `-100` to `100`. Applies only to gray and color images.
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, the `byLines` and `byBlackSquares` parameters are set to `false` while the `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 horizontally.
FlipVertical()	Flips a page (or all pages) of a document or a batch vertically.
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 a batch, a document, or a page. Set `inside` to `false` to insert after the target at the same level. Set it to `true` to insert inside the target, at the beginning of the list.
RemoveGeometricalDistortions()	Corrects geometrical distortions of trapeziums and crooked lines on an image.
RemoveMotionBlur()	Detects and removes blur that is caused by moving a document or a camera/scanner. Applies only to gray and color images.
RemoveScannerShadowFromImage()	Removes shadow from a scanner (for example, in the center spread).
RemoveStamps( colorToFilter: string, [optional] rect: IPageRect )	Removes stamps from images. Applies only to color images. `colorToFilter` is the color of the stamps to remove. It accepts `Red`, `Green`, `Blue`, and `Yellow`, and is not case-sensitive. `rect` is the area to remove stamps from. If `rect` is omitted, stamps are removed from the entire image. For more information, see Remove stamps from part of an image.
RemoveStampsExt( colorsToFilter: string )	Removes stamps from images. Applies only to color images. `colorsToFilter` is the color of the stamps to remove. It accepts `Red`, `Green`, `Blue`, `Yellow`, `Orange`, `LightBlue`, and `Purple`, and is not case-sensitive. Separate several values with a comma, for example `Red, Green`. Pass an empty string to select the colors automatically. Every accepted color found on the image is then removed. For more information, see Remove stamps of specific colors.
ResetPageProfile()	Resets the image enhancement profile and discards all changes.
Rotate( angle: int )	Rotates a page (or all pages) of a document or a batch.
SaveAs( fileName: string, [optional] options: IImageSavingOptions )	Saves pages, a page image, or a batch to a file. When saving a multi-page document (or a batch) in a single-page format, an exception is returned.
Scale( ratio: int )	Scales a page (or all pages) of a document or a batch relative to the basic value of 100.
SplitHorizontal( pos: int )	Splits a page (or all pages) of a document or a batch horizontally.
SplitVertical( pos: int )	Splits a page (or all pages) of a document or a batch vertically.
SuitabilityForOCR: float	Shows how suitable an image is for OCR. Possible values are from 0.0 to 1.0.

Properties

Name	Type	Access	Description
Attachments	IAttachments	Read-only	Attachments.
BatchInfo (DocumentInfo or PageInfo)	IBatchInfo / IDocumentInfo / IExportPageInfo	Read-only	Item properties. If the requested property does not correspond to the item type, the `IsBatch` (`IsDocument` or `IsPage`) check is performed.
Children	IWorkspaceItems	Read-only	Child items.
IsBatch (IsDocument or IsPage)	bool	Read-only	Specifies whether the item is a batch, a document or a page.
IsExported	bool	Read/write	Specifies whether the item is exported. Can be modified only for batch items in pre-export scripts.
IsSelected	bool	Read/write	Specifies whether the item is selected. Changing this property value for a particular item does not affect other items. Does not work if the current selection consists of elements of a different type.
Index	int	Read-only	The item index in the parent collection.
Name	string	Read/write	The item name. If `IWorkspaceItem` represents a page, this property is read-only.
Next	IWorkspaceItem	Read-only	The next item.
Parent	IWorkspaceItem	Read-only	The parent item.
Prev	IWorkspaceItem	Read-only	The previous item.
ScriptProperties	IScriptProperties	Read-only	Script properties.

Examples

Apply an enhancement profile

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

Remove stamps from part of an image

An event handler that removes blue stamps from the left half of all images in the selection:

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

Remove stamps of specific colors

A script that deletes red and green stamps and marks from all document pages:

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