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 ScriptResultConsts

Defines constants that can be used as return values in several javascript methods

Remarks

alias ScriptResult.ScriptResultConsts

Fields

Name Description
AbortOp

Abort an operation

It may be used as a return value of the Job javascript methods batchWillClose, preScan and pageScanned methods.

Async

Upload the selected Batch asynchronously.

It may be used as a return value of the Job javascript method batchWillClose. For example:

function batchWillClose(batch, suspend){
     return { UploadMode : Const.Async };
}

Closing

Used as the 3rd parameter in getBranchName(): this is the action the user is performing that causes the Step's branching script to execute.

DeleteImage

Delete the scanned image

It may be used as a return value of the Job javascript method pageArrived. For example:

function pageArrived(batch, page){
     return { Retention : Const.DeleteImage};
}

DeletePage

Delete the scanned image and the back side (if scanning in duplex mode)

It may be used as a return value of the Job javascript method pageArrived. For example:

function pageArrived(batch, page){
     return { Retention : Const.DeletePage};
}

KeepImage

Keep the scanned image

It may be used as a return value of the Job javascript method pageArrived. For example:

function pageArrived(batch, page){
     return { Retention : Const.KeepImage};
}

MoveToField

Move focus to a specific Index Field specified by name.

It may be used as a return value of the fieldFocusGained Indexing javascript method. For example:

function fieldFocusGained(field){
     return { Const.MoveToField: "&lt FieldName &gt" };
}

MoveToNextField

Move focus to the next Index Field

It may be used as a return value of the fieldFocusGained Indexing javascript method. For example:

function fieldFocusGained(field){
     return Const.MoveToNextField;
}

MoveToNextNode

Move focus to the next Node

It may be used as a return value of the fieldFocusGained/fieldFocusGained Indexing javascript methods. For example:

function fieldFocusGained(field){
     return Const.MoveToNextNode;
}

MoveToRow
MovingToIndex

Used as the 3rd parameter in getBranchName(): this is the action the user is performing that causes the Step's branching script to execute.

NoValue
SepDefault

Execute all separation rules defined by the Job

It may be used as a return value of the Job javascript method pageArrived. For example:

function pageArrived(batch, page){
     return { Separation : Const.SepDefault };
}

SepNewDoc

Create a new Document

It may be used as a return value of the Job javascript method pageArrived. For example:

function pageArrived(batch, page){
     return { Separation : Const.SepNewDoc };
}

SepNewFolder

Create a new Folder

It may be used as a return value of the Job javascript method pageArrived. For example:

function pageArrived(batch, page){
     return { Separation : Const.SepNewFolder};
}

SepNone

Suppress execution of all separation rules defined by the Job

It may be used as a return value of the Job javascript method pageArrived. For example:

function pageArrived(batch, page){
     return { Separation : Const.SepNone };
}

Sync

Upload the selected Batch synchronously.

It may be used as a return value of the Job javascript method batchWillClose. For example:

function batchWillClose(batch, suspend){
     return { UploadMode : Const.Sync };
}

Back to top Generated by DocFX