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 |
| Brightness | Change brightness on the selected Pages. This action is accompanied by a number property, named 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 |
| 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 |
| Contrast | Change contrast on the selected Pages. This action is accompanied by a number property, named 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 |
| 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 Note that if the |
| 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
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 |
| 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 |
| 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 |
| 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 **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 |
| 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 |
| 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 |
| 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 |
| Exit | Exit the application. **This action cannot be invoked by .** Also, it cannot be disabled using the |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 **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 **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 **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 |
| OpenInNewTab | Open the selected Pages in new tabs. If you want to invoke this action programmatically, using the method, then the |
| 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 **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:
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 |
| RemoveBlackBorder | Remove black border on the selected Pages. This action is accompanied by a boolean property, named 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 |
| RestoreOriginalImage | Restore the original version of the image on the selected Pages. This action can be used to revert certain image operations:
If you want to invoke this action programmatically, using the method, then the |
| 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 |
| ScanAllAndAppend | Scan multiple Pages and append them at the end of the Batch. The If you want to invoke this action programmatically, using the method, then the |
| 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 |
| 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 |
| ScanSingleAndAppend | Scan a single Page and append it at the end of the Batch. The If you want to invoke this action programmatically, using the method, then the |
| 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 |
| 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 **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 Currently this action is available only on Document nodes. If you want to invoke this action programmatically, using the method, then the Note that the |
| 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 |
| 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 |
| UndoLastImageOperation | Restore the previous version of the image on the selected Pages. This action can be used to revert certain image operations:
If you want to invoke this action programmatically, using the method, then the |