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

Interface IScanProfile

Describes the characteristics of a scan operation.

Properties list

customData name scanner source

Methods list

getCustomData() getName() getScanner() getSource()

Properties

customData

see IScanProfile.getCustomData()

Declaration
readonly customData: Blob;
Property Value
Type Description
Blob

name

see IScanProfile.getName()

Declaration
readonly name: string;
Property Value
Type Description
string

scanner

see IScanProfile.getScanner()

Declaration
readonly scanner: string;
Property Value
Type Description
string

source

see IScanProfile.getSource()

Declaration
readonly source: ScanSource;
Property Value
Type Description
ScanSource

Methods

getCustomData()

Returns scanner custom data. This is binary data read from the TWAIN interface and used to initialize the scanner.

context
returns a Byte[] instead of a Blob
context
returns a Byte[] instead of a Blob
Declaration
getCustomData(): Blob;
Returns
Type Description
Blob

scanner custom data

getName()

Returns the name of this Scan Profile.

If this is the default Scan Profile that gets created automatically, then this method will return "Default Scan Profile". This will return the same String that is displayed on the ImageTrust client bar, when this Scan Profile is used.

Declaration
getName(): string;
Returns
Type Description
string

the name of this Scan Profile

getScanner()

The name of the scanner of this Scan Profile

context
Not available.
context
Not available.
Declaration
getScanner(): string;
Returns
Type Description
string

getSource()

Returns the scan source for this Scan Profile.

Declaration
getSource(): ScanSource;
Returns
Type Description
ScanSource

the scan source for this Scan Profile

Back to top Generated by DocFX