AddDocument

Adds a document node to the runtime hierarchy. All scanned pages become children of the document node.

Syntax

bool AddDocument ()

Parameters

None.

Returns

False if this action is invoked or called at the wrong level or if the setup DCO does not contain any document structure. In this case, the action will not add a document. Otherwise, True.

Level

Batch level.

Details

Places all scanned pages into a single, batch-wide document. This action must be called before the Scan action.

The action also adds ED (Expected Documents), AD (Actual Documents), EP (Expected Pages) and AP (Actual Pages) properties to the Page file (.xml) of a task.

This action allows a VScan task to create a batch that has all the same characteristics of a batch that is created using a standard scan task. It is not required to call this action. Use this action if your application relies on a document structure on import.

This action must precede the Scan action. If AddDocument is used and the Scan action is never subsequently called, the action will not be performed.

Example

AddDocument()
SetSortOrder("Name,ASC")
SetMaxImageFiles("100")
Scan()