Batch Page

A Batch Page object represents an individual page within a Batch.

Remarks

Page objects are created during scanning, when a single-page image file is imported, or when the Content Action activity is used to split a multipage TIFF or PDF. Page objects store a variety of content files, including the page image, a thumbnail image, an optional "undo" image, OCR results, and etc. In cases where the page was created by splitting a PDF file, the page object may also store a copy of the original PDF page. Pages also store metadata such as the current display format and results from IP commands which have been executed against the page.

Inherits from: Batch Object

Properties

The following 13 properties are defined.

Property Name	Description
General
Image Information	Type: Image Info Provides information about a Batch Page's image.
Flag Region	Type: Rectangle Annotation The region of the page associated with the flag.
Flagged	Type: Boolean, Default: False Indicates that the item has been flagged for review.
Flag Reason	Type: String The reason why the item has been flagged.
Has PDF Version	Type: Boolean, Default: False Indicates whether this folder has a PDF version of its contents.
Description	Type: String Generic property allowing an administrator to document the purpose of this Grooper Node.
ScanOnce™
Display Pixel Format	Type: SimplePixelFormat, Default: None The color format in which this page will be displayed. Can be one of the following values: None - None. Grayscale - 8-Bit Grayscale Color - 24-Bit Color Binary - Black and White
Threshold Method	Type: BinarizationMethod, Default: Dynamic The threshold method to be used when displaying this page in black and white. Can be one of the following values: Simple - Thresholds an image to black and white using a fixed threshold value between 0 and 255. Auto - Selects a threshold value automatically using Otsu's Method. Adaptive - Thesholds pixels based on the intensity of pixels in the local neighborhood. Dynamic - Performs adaptive thresholding, while preserving dark areas on the page.
Threshold	Type: Int32, Default: 127, Range: 0 - 255 The threshold to be used when displaying this page in black and white.
Brightness	Type: Int32, Default: 0, Range: -100 - 100 The brightness value to use when displaying this page in grayscale or color.
Contrast	Type: Int32, Default: 0, Range: -100 - 100 The contrast value to use when displaying this page in grayscale or color.
Recognition
Culture	Type: Culture Data Indicates the primary culture of the text content.
Results	Type: Object The output generated by the Recognize activity.

Commands

Command Name	Shortcut Keys	Description
Add Multiple Items		Creates multiple items as children of the selected object.
Clear Children		Deletes all children of the selected object(s).
Batch Object - Clear Flag	Ctrl+Shift+L	Clears any existing flags on selected items.
Export to Zip Archive		Exports a set of Grooper nodes to a ZIP archive.
Batch Object - File System		Exports the selected folders or documents to a file system directory.
Batch Object - Flag Item	Ctrl+L	Marks the selected items as flagged.
Batch Object - Mail Recipient		Launches the default mail client, creating an email with the selected folders or documents attached.
Batch Object - Printer		Prints the selected items to a printer device.
Publish to Grooper Repository		Publishes one or more Nodes to one or more Target Grooper Repositories.
Batch Object - Remove PDF Version		Deletes the Grooper-generated PDF version from this item.
Batch Page - Rotate Left	Ctrl+Left	Rotate Page Left.
Batch Page - Rotate Right	Ctrl+Right	Rotate Page Right.
Batch Object - Test Batch		Appends a copy of the selected items to a test batch.
Batch Page - Toggle Display Format	Ctrl+Shift+I	Toggle the display format of the selected page between Color, Grayscale, and Binary.
Batch Page - Undo Image Cleanup	Ctrl+Z	Replace the selected page(s) with its Undo Image.
Unpublish		Unpublishes a set of Grooper Nodes to a Target Grooper Repository.
Batch Object - ZIP File		Exports the selected folders or documents to a ZIP archive.

Tabs

Tab Name	Description
Batch Page - General	Provides a user interface displaying the properties of a Batch Page and a Page Viewer to display the selected Batch Page.
Grooper Node - Scripting	Provides script viewing, compilation, management, and basic editing features.
Grooper Node - Contents	Provides a user interface for viewing and managing the children of a Grooper Node.
Grooper Node - Advanced	Displays detailed information about Grooper Node objects, and provides administrative functions for managing them.

Used By