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 IFormType

Information about a form type.

Properties list

description documentClass name recognitionProfile typeUuid

Methods list

getDescription() getDocumentClass() getName() getRecognitionProfile() getTypeUuid()

Properties

description

see IFormType.getDescription()

Declaration
readonly description: string;
Property Value
Type Description
string

documentClass

see IFormType.getDocumentClass()

Declaration
readonly documentClass: IDocumentClass;
Property Value
Type Description
IDocumentClass

name

see IFormType.getName()

Declaration
readonly name: string;
Property Value
Type Description
string

recognitionProfile

see IFormType.getRecognitionProfile()

Declaration
readonly recognitionProfile: IRecognitionProfile;
Property Value
Type Description
IRecognitionProfile

typeUuid

see IFormType.getTypeUuid()

Declaration
readonly typeUuid: string;
Property Value
Type Description
string

Methods

getDescription()

Declaration
getDescription(): string;
Returns
Type Description
string

the description of the form type

getDocumentClass()

Declaration
getDocumentClass(): IDocumentClass;
Returns
Type Description
IDocumentClass

the IDocumentClass this form type belongs to

getName()

Declaration
getName(): string;
Returns
Type Description
string

the name of the form type

getRecognitionProfile()

Declaration
getRecognitionProfile(): IRecognitionProfile;
Returns
Type Description
IRecognitionProfile

the IRecognitionProfile profile of the form type

getTypeUuid()

Declaration
getTypeUuid(): string;
Returns
Type Description
string

a unique id that identifies this form type that does not change when publishing a Job. It is useful for identification purposes.

Back to top Generated by DocFX