Show / Hide Table of Contents
  • BC HTML Api reference
    • html-api
      • AnnotationArrowOrientation
      • AnnotationTextAlignment
      • AnnotationTextFontFamily
      • BarcodeOrientation
      • BarcodeThresholdMode
      • BarcodeType
      • BatchEnums
        • Mode
        • Queue
      • CallContext
      • DbClient
      • DbServer
      • FileMimeType
      • FileType
      • IAnnotation
      • IAnnotationProperties
      • IApplication
      • IBarcodeData
      • IBaseControl
      • IBatch
      • IBatchClass
      • IButton
      • ICheckBox
      • IComboBox
      • ICustomThemeConfig
      • IDocument
      • IDocumentClass
      • IField
      • IFieldValidation
      • IFileInfo
      • IFolder
      • IFolderClass
      • IFormType
      • IGroup
      • IIndexClass
      • IITModule
      • IJob
      • ILabel
      • ILicenseGroup
      • IListItem
      • IListView
      • ImageColorMode
      • ImageOperationType
      • INode
      • INodeComment
      • INodeReviewComment
      • INuanceEngineConfig
      • IOCRConfiguration
      • IPage
        • Side
      • IRadioButton
      • IRecognitionProfile
      • IRectangle
      • IRegexValidation
      • IScanProfile
      • ITable
      • ITabView
      • ITextBox
      • IthConfig
      • ITitledPanel
      • IUser
      • LevelName
      • NodeReviewStatus
      • NuanceEngine
      • NuanceLanguage
      • NuanceMode
      • PageSideMode
      • RecognitionEngine
      • RpcService
      • ScanService
      • ScanSource
      • ScriptActionType
      • ScriptResultConsts
      • ScriptResultProp
      • UnloadReason

Enum ScriptActionType

An enumeration for the different types of actions that take place on the application. It is possible to provide them to the function isContextActionEnabled at the Job-level script, which can disable specific actions.

Depending on the operation mode of the application, certain actions can be invoked programmatically by using the method from a script (either the global script, a Job-level script or an Index-level script).

Remarks

alias ActionType

Fields

Name Description
ApiImportDocument

Importing documents using the API.

**This action cannot be invoked by .**

BatchSeparation

Takes place when a Batch separation rule requires the creation of a NewBatch.

**This action cannot be invoked by .** Also, it cannot be disabled using the isContextActionEnabled scripting function.

Brightness

Change brightness on the selected Pages. This action is accompanied by a number property, named "brightness_change", which determines the change in brightness ranging from [-150,150].

The selected nodes must be Pages, they cannot be eDocuments and their image files must be available.

If you want to invoke this action programmatically, using the method, then the selectedNodes list should contain the Pages which need their brightness changed. In addition, a number property named "brightness_change" must be present in the actionProperties Map, ranging from [-150,150]. Note that if the selectedNodes list contains Nodes that are not Pages, then the action will not be performed.

CloseBatch

Close the current Batch.

This action is always enabled when it is invoked via the button or the batch menu item in the application and it cannot be disabled using the isContextActionEnabled scripting function.

Contrast

Change contrast on the selected Pages. This action is accompanied by a number property, named "contrast_change", which determines the change in contrast ranging from [-100,100].

The selected nodes must be Pages, they cannot be eDocuments and their image files must be available.

If you want to invoke this action programmatically, using the method, then the selectedNodes list should contain the Pages which need their contrast changed. In addition, a number property named "contrast_change" must be present in the actionProperties Map, ranging from [-100,100]. Note that if the selectedNodes list contains Nodes that are not Pages, then the action will not be performed.

CopyNodes

Duplicate the selected nodes to a specified location. This action is involved during DnD operations when the user chooses 'copy' instead of 'move'. This action exports two properties: one indicating whether model nodes are transferred or not and the other indicating the position into the action node's children list where the duplicated nodes are to be placed

**This action cannot be invoked by .**

CreateDocumentFromPages

Create a new Document from the selected Pages. The new Document is inserted after the Document that contains the last Page in the selection.

If you want to invoke this action programmatically, using the method, then the selectedNodes list should contain the Pages that must be included in the new Document. The order of the Pages in the selectedNodes list will determine the order of the Pages in the new Document.

Note that if the selectedNodes list contains Nodes that are not Pages, then the action will not be performed.

DecryptPages

Decrypt the selected Pages. The selected Pages must be encrypted eDocuments and they must belong to a Job that allows decryption.

If you want to invoke this action programmatically, using the method, then the selectedNodes list should contain the Pages which must be decrypted. The selectedNodes list should contain Nodes that:

  • are Pages,
  • are eDocuments (function should return true),
  • are encrypted (function should return true),
  • belong to a Job which allows decryption

If any of the above conditions do not hold, then the action will not be performed.

DeleteNodes

Delete the selected Nodes.

If you want to invoke this action programmatically, using the method, then the selectedNodes list should contain the Nodes that must be deleted.

Deskew

Deskew the selected Pages. The selected nodes must be Pages, they cannot be eDocuments and their image files must be available.

If you want to invoke this action programmatically, using the method, then the selectedNodes list should contain the Pages which must be deskewed. Note that if the selectedNodes list contains Nodes that are not Pages, then the action will not be performed.

Despeckle

Despeckle the selected Pages. The selected nodes must be Pages, they cannot be eDocuments and their image files must be available.

If you want to invoke this action programmatically, using the method, then the selectedNodes list should contain the Pages which must be despeckled. Note that if the selectedNodes list contains Nodes that are not Pages, then the action will not be performed.

DiscardBatch

Discard the current Batch.

This action is always enabled when it is invoked via the batch menu item in the application and it cannot be disabled using the isContextActionEnabled scripting function.

**This action cannot be invoked by .**

DownloadMultiImageFile

Downloading a prepared Document with the selected nodes.

**This action cannot be invoked by .**

DuplicateDocuments

Duplicate the selected Documents. The new Documents are added after the last Document in the selection. * If you want to invoke this action programmatically, using the method, then the selectedNodes list should contain the Documents that must be duplicated. The order of the Documents in the selectedNodes list will determine the order in which the Documents will be duplicated. Note that if the selectedNodes list contains Nodes that are not Documents, then the action will not be performed.

DuplicateFolders

Duplicate the selected Folders. The new Folders are added after the last Folder in the selection.

If you want to invoke this action programmatically, using the method, then the selectedNodes list should contain the Folders that must be duplicated. The order of the Folders in the selectedNodes list will determine the order in which the Folders will be duplicated. Note that if the selectedNodes list contains Nodes that are not Folders, then the action will not be performed.

DuplicatePages

Duplicate the selected Pages. The new Pages are added after the last Page in the selection.

If you want to invoke this action programmatically, using the method, then the selectedNodes list should contain the Pages that must be duplicated. The order of the Pages in the selectedNodes list will determine the order in which the Pages will be duplicated. Note that if the selectedNodes list contains Nodes that are not Pages, then the action will not be performed.

DuplicateStacks

Duplicate the selected Stacks. The new Stacks are added after the last Stack in the selection.

If you want to invoke this action programmatically, using the method, then the selectedNodes list should contain the Stacks that must be duplicated. The order of the Stacks in the selectedNodes list will determine the order in which the Stacks will be duplicated. Note that if the selectedNodes list contains Nodes that are not Stacks, then the action will not be performed.

Exit

Exit the application.

**This action cannot be invoked by .** Also, it cannot be disabled using the isContextActionEnabled scripting function.

ExportNodes

Export the images of the selected Nodes.

ExtractPages

Extract one or more pages from the selected page. This action is available only when a single page is selected. It exports one property ('crop_regions') which is a list of rectangles defining the areas (in absolute coordinates) of the selected page's image that will provide the images for the extracted pages.

**This action cannot be invoked by .**

FillPunchHoles

Fill page punch holes. The selected nodes must be Pages, they cannot be eDocuments and their image files must be available.

If you want to invoke this action programmatically, using the method, then the selectedNodes list should contain the Pages which must be changed. Note that if the selectedNodes list contains Nodes that are not Pages, then the action will not be performed.

FindNodes

Show the Find Nodes dialog.

**This action cannot be invoked by .**

FlipPage

Flip the selected Pages.

If you want to invoke this action programmatically, using the method, then the selectedNodes list should contain the Pages which must be flipped. Note that if the selectedNodes list contains Nodes that are not Pages, then the action will not be performed.

ImportDraggedFiles

Importing the drag and dropped files.

**This action cannot be invoked by .**

ImportPastedFiles

Importing Pasted from clipboard files.

**This action cannot be invoked by .**

InvertPage

Invert the colors on the selected Pages.

If you want to invoke this action programmatically, using the method, then the selectedNodes list should contain the Pages which must be inverted. Note that if the selectedNodes list contains Nodes that are not Pages, then the action will not be performed.

MergeDocuments

Merge the selected Documents into one Document. The first Document in the selection will receive all the Pages from the rest of the Documents.

If you want to invoke this action programmatically, using the method, then the selectedNodes list should contain the Documents that must be merged. The selectedNodes list should contain at least 2 Documents. The order of the Documents in the selectedNodes list will determine the order in which they will be merged. Note that if the selectedNodes list contains Nodes that are not Documents, then the action will not be performed.

MergeFolders

Merge the selected Folders into one Folder. The first Folder in the selection will receive all the Documents from the rest of the Folders.

If you want to invoke this action programmatically, using the method, then the selectedNodes list should contain the Folders that must be merged. The selectedNodes list should contain at least 2 Folders. The order of the Folders in the selectedNodes list will determine the order in which they will be merged. Note that if the selectedNodes list contains Nodes that are not Folders, then the action will not be performed.

MergeStacks

Merge the selected Stacks into one Stack. The first Stack in the selection will receive all the Folder from the rest of the Stacks.

If you want to invoke this action programmatically, using the method, then the selectedNodes list should contain the Stacks that must be merged. The selectedNodes list should contain at least 2 Stacks. The order of the Stacks in the selectedNodes list will determine the order in which they will be merged. Note that if the selectedNodes list contains Nodes that are not Stacks, then the action will not be performed.

MergeWithNextDocument

Merge the selected Document with the next Document. The selected Document will receive all the Pages from the next Document.

If you want to invoke this action programmatically, using the method, then the selectedNodes list should contain the Document that must be merged with the next Document. Note that if the selectedNodes list contains more than one Nodes, or a Node that is not a Document, then the action will not be performed.

MergeWithNextFolder

Merge the selected Folder with the next Folder. The selected Folder will receive all the Documents from the next Folder.

If you want to invoke this action programmatically, using the method, then the selectedNodes list should contain the Folder that must be merged with the next Folder. Note that if the selectedNodes list contains more than one Nodes, or a Node that is not a Folder, then the action will not be performed.

MergeWithNextStack

Merge the selected Stack with the next Stack. The selected Stack will receive all the Folders from the next Stack.

If you want to invoke this action programmatically, using the method, then the selectedNodes list should contain the Stack that must be merged with the next Stack. Note that if the selectedNodes list contains more than one Nodes, or a Node that is not a Stack, then the action will not be performed.

MergeWithPreviousDocument

Merge the selected Document with the previous Document. The previous Document will receive all the Pages from the selected Document.

If you want to invoke this action programmatically, using the method, then the selectedNodes list should contain the Document that must be merged with the previous Document. Note that if the selectedNodes list contains more than one Nodes, or a Node that is not a Document, then the action will not be performed.

MergeWithPreviousFolder

Merge the selected Folder with the previous Folder. The previous Folder will receive all the Documents from the selected Folder.

If you want to invoke this action programmatically, using the method, then the selectedNodes list should contain the Folder that must be merged with the previous Folder. Note that if the selectedNodes list contains more than one Nodes, or a Node that is not a Folder, then the action will not be performed.

MergeWithPreviousStack

Merge the selected Stack with the previous Stack. The previous Stack will receive all the Folders from the selected Stack.

If you want to invoke this action programmatically, using the method, then the selectedNodes list should contain the Stack that must be merged with the previous Stack. Note that if the selectedNodes list contains more than one Nodes, or a Node that is not a Stack, then the action will not be performed.

MoveNodes

Move the selected nodes to a specified location. This action is involved during DnD operations when the user chooses 'move' instead of 'copy'. This action exports two properties: one indicating whether model nodes are transferred or not and the other indicating the position into the action node's children list where the moved nodes are to be placed.

**This action cannot be invoked by .**

NewBatch

Create a new Batch and optionally start scanning.

This action is always enabled when it is invoked via the button or the batch menu item in the application and it cannot be disabled using the isContextActionEnabled scripting function.

NewDocumentAfter

Create a new Document after the selected Document. This action is available only when a single Document is selected.

If you want to invoke this action programmatically, using the method, then the selectedNodes list should contain the Document after which the new Document must be created.

NewDocumentBefore

Create a new Document before the selected Documents. This action is available only when a single Document is selected.

If you want to invoke this action programmatically, using the method, then the selectedNodes list should contain the Document before which the new Document must be created.

NewDocumentInEmptyBatch

Create a new Document when the Batch is empty. This action may also create a Folder if the Batch uses a Folder level in its hierarchy.

If you want to invoke this action programmatically, using the method, then the selectedNodes list should contain the Batch in which the new Document must be created.

NewDocumentInFolder

Create a new Document at the end of the selected Folder. This action is available only when a single Folder is selected.

If you want to invoke this action programmatically, using the method, then the selectedNodes list should contain the Folder in which the new Document must be created.

NewFolder

Create a new Folder at the end of the selected Batch.

If you want to invoke this action programmatically, using the method, then the selectedNodes list should contain the Batch in which the new Folder must be created.

NewFolderAfter

Create a new Folder after the selected Folder. This action is available only when a single Folder is selected.

If you want to invoke this action programmatically, using the method, then the selectedNodes list should contain the Folder after which the new Folder must be created.

NewFolderBefore

Create a new Folder before the selected Folder. This action is available only when a single Folder is selected.

If you want to invoke this action programmatically, using the method, then the selectedNodes list should contain the Folder before which the new Folder must be created.

NewStack

Create a new Stack at the end of the selected Batch.

If you want to invoke this action programmatically, using the method, then the selectedNodes list should contain the Batch in which the new Stack must be created.

NewStackAfter

Create a new Stack after the selected Stack. This action is available only when a single Stack is selected.

If you want to invoke this action programmatically, using the method, then the selectedNodes list should contain the Stack after which the new Stack must be created.

NewStackBefore

Create a new Stack before the selected Stack. This action is available only when a single Stack is selected.

If you want to invoke this action programmatically, using the method, then the selectedNodes list should contain the Stack before which the new Stack must be created.

OpenBatch

Open a Batch from the Batch Manager window. The selected Batch may be either in a Scan or Index step.

This action is always enabled when it is invoked via the menu item in the application and it cannot be disabled using the isContextActionEnabled scripting function.

**This action cannot be invoked by .**

OpenBatchToIndex

Open a Batch that is in an Index step. First, a dialog is shown that displays all available Batches that are in an Index step and then the user selects which Batch to open.

This action is always enabled when it is invoked via the batch menu item in the application and it cannot be disabled using the isContextActionEnabled scripting function.

**This action cannot be invoked by .**

OpenBatchToScan

Open a Batch that is in a Scan step. First, a dialog is shown that displays all available Batches that are in a Scan step and then the user selects which Batch to open.

This action is always enabled when it is invoked via the batch menu item in the application and it cannot be disabled using the isContextActionEnabled scripting function.

**This action cannot be invoked by .**

OpenInFloatingWindow

Open the selected Pages in new floating windows.

If you want to invoke this action programmatically, using the method, then the selectedNodes list should contain the Pages which must be opened. Note that if the selectedNodes list contains Nodes that are not Pages, then the action will not be performed.

OpenInNewTab

Open the selected Pages in new tabs.

If you want to invoke this action programmatically, using the method, then the selectedNodes list should contain the Pages which must be opened. Note that if the selectedNodes list contains Nodes that are not Pages, then the action will not be performed.

OpenNextBatchToIndex

Open the next Batch that needs to be indexed. The next Batch is automatically selected by the system and it is opened on the application.

This action is always enabled when it is invoked via the batch menu item in the application and it cannot be disabled using the isContextActionEnabled scripting function.

**This action cannot be invoked by .**

PrintNodes

Print the selected Nodes.

**This action cannot be invoked by .**

RedoLastImageOperation

Redo the last image operation on the selected Pages. This action can be used to repeat certain image operations after they have been undone:

  • rotation
  • color invertion
  • crop or split
  • contrast or brightness adjustment
  • deskew
  • black border removal
The selected nodes must be Pages, they cannot be eDocuments and their image files must be available. This action is available if at least one Page in the selection has been modified by an image operation which was undone (either with the action or with the action).

Pages that do not have any history of image modifications, will not be affected by this action.

If you want to invoke this action programmatically, using the method, then the selectedNodes list should contain the Pages which must move one step forward in the image history. Note that if the selectedNodes list contains Nodes that are not Pages, then the action will not be performed.

RemoveBlackBorder

Remove black border on the selected Pages. This action is accompanied by a boolean property, named "crop_border", which determines whether any surrounding black border should be cropped. If "crop_border" is false, then any surrounding black border will be filled with white pixels. If "crop_border" is true, then any surrounding black border will be cropped and the Page's pixel width and height may be reduced.

The selected nodes must be Pages, they cannot be eDocuments and their image files must be available.

If you want to invoke this action programmatically, using the method, then the selectedNodes list should contain the Pages which must have any existing black border removed. In addition, a boolean property named "crop_border" must be present in the actionProperties Map. Note that if the selectedNodes list contains Nodes that are not Pages, then the action will not be performed.

RestoreOriginalImage

Restore the original version of the image on the selected Pages. This action can be used to revert certain image operations:

  • rotation
  • color inversion
  • crop or split
  • contrast or brightness adjustment
  • deskew
  • black border removal
The selected nodes must be Pages, they cannot be eDocuments and their image files must be available. This action is available if at least one Page in the selection has been modified by an image operation. Pages that do not have any history of image modifications, will not be affected by this action.

If you want to invoke this action programmatically, using the method, then the selectedNodes list should contain the Pages which must move one step back in the image history. Note that if the selectedNodes list contains Nodes that are not Pages, then the action will not be performed.

RotatePage

Rotate the selected Pages. This action is accompanied by a rotation angle property.

If you want to invoke this action programmatically, using the method, then the selectedNodes list should contain the Pages which must be rotated. In addition, the rotation angle must be specified by providing a property named "rotation_angle" in the actionProperties Map. The value of the property must be an Integer number, either 90, 180 or 270. Note that if the selectedNodes list contains Nodes that are not Pages, then the action will not be performed.

ScanAllAndAppend

Scan multiple Pages and append them at the end of the Batch. The selectedNodes list may contain the Batch where Pages will be appended, or it may be empty. If it is empty, then the Pages will be appended to the the currently selected Batch.

If you want to invoke this action programmatically, using the method, then the selectedNodes list should contain the Batch where the Pages must be appended.

ScanAllAndInsert

Scan multiple Pages and insert them before the first selected Page. This action is available only when one or more Pages or Documents have been selected.

If you want to invoke this action programmatically, using the method, then the first Node in the selectedNodes list, will determine where the new Pages will be inserted. If the first Node is a Page, then the new Pages will be inserted before the selected Page. If the first Node is a Document, then the new Pages will be inserted at the end of the selected Document.

ScanAndReplacePages

Scan and replace the selected Pages. This action is available only when one or more Pages have been selected.

If you want to invoke this action programmatically, using the method, then the selectedNodes list should contain the Pages that must be replaced.

ScanSingleAndAppend

Scan a single Page and append it at the end of the Batch. The selectedNodes list may contain the Batch where the Page will be appended, or it may be empty. If it is empty, then the Page will be appended to the the currently selected Batch.

If you want to invoke this action programmatically, using the method, then the selectedNodes list should contain the Batch where the Page must be appended.

ScanSingleAndInsert

Scan a single Page and insert it before the first selected Page. This action is available only when one or more Pages or Documents have been selected.

If you want to invoke this action programmatically, using the method, then the first Node in the selectedNodes list, will determine where the new Page will be inserted. If the first Node is a Page, then the new Page will be inserted before the selected Page. If the first Node is a Document, then the new Page will be inserted at the end of the selected Document.

SplitBatch

Split the current Batch into two Batches. The current Batch is first saved to the server and then the user determines how the split will be performed. The user also decides whether to keep working with the existing or the newly created Batch.

**This action cannot be invoked by .**

SplitDocument

Split the current Document to the selected Page. This action is available only when a single Page is selected. The selected Page and all the remaining Pages of the Document are placed in a new Document.

The SplitDocument action is fired when:   1. Right clicking on a selected Page. In this case the selectedNodes list contains the selected Page. The actionNode is also the selected Page.
  2. The mouse moves between Pages and the scissors tool appears. In this case the selectedNodes is empty and the action node is the node where the Document will split.

**This action cannot be invoked by .**

SplitFolder

Split the currect Folder to the selected Document. This action is available only when a single Document is selected. The selected Document and all the remaining Documents of the Folder are placed in a new Folder.

**This action cannot be invoked by .**

SplitNodesEveryX

Split the selected nodes into multiple nodes, so that each node contains up to a given number of children. The newly created nodes are siblings of the original selected node and they are placed after the original node. This action is accompanied by an integer property, named "max_children", which determines the maximum number of children for the resulting nodes. The "max_children" property is valid if it is larger or equal to one.

Currently this action is available only on Document nodes.

If you want to invoke this action programmatically, using the method, then the selectedNodes list should contain the Nodes which must be split. If the "max_children" property is not defined, then an input dialog will be shown, prompting the user to enter the maximum number of children for the action.

Note that the isContextActionEnabled method may be called twice before the action is actually performed. If the "max_children" property is not defined, it will be called the first time with max_children=0. After the user has entered a valid value in the input dialog, the method will be called again with the given value for "max_children".

SplitStack

Split the currect Stack to the selected Document. This action is available only when a single Document is selected. The selected Document and all the remaining Documents of the Stack are placed in a new Stack.

**This action cannot be invoked by .**

SuspendBatch

Suspend the current Batch.

This action is always enabled when it is invoked via the button or the batch menu item in the application and it cannot be disabled using the isContextActionEnabled scripting function.

TestBatch

Create a new test Batch using the selected Job.

**This action cannot be invoked by .**

This action is always enabled when it is invoked via the menu item in the application and it cannot be disabled using the isContextActionEnabled scripting function.

UndoLastImageOperation

Restore the previous version of the image on the selected Pages. This action can be used to revert certain image operations:

  • rotation
  • color invertion
  • crop or split
  • contrast or brightness adjustment
  • deskew
  • black border removal
The selected nodes must be Pages, they cannot be eDocuments and their image files must be available. This action is available if at least one Page in the selection has been modified by an image operation. Pages that do not have any history of image modifications, will not be affected by this action.

If you want to invoke this action programmatically, using the method, then the selectedNodes list should contain the Pages which must be reverted to their original image. Note that if the selectedNodes list contains Nodes that are not Pages, then the action will not be performed.

Back to top Generated by DocFX