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 ITextBox

Inheritance
IBaseControl

Properties list

enabled placeholder readOnly textAlignment value
Inherited Properties
el

Methods list

blur() focus()
Inherited Methods
addEventListener(ev, listener)
removeEventListener(ev, listener)

Properties

enabled

context
Not available.
Declaration
enabled: boolean;
Property Value
Type Description
boolean

placeholder

The placeholder text of this text box. This is the prompt that is displayed in the text box when its value is null or empty.

context
Not available.
Declaration
placeholder: string;
Property Value
Type Description
string

readOnly

Control whether this text box is read only or not. A readonly textbox looks like a normal text box. It can get the focus but text cannot be entered in it using the keyboard.

context
Not available.
Declaration
readOnly: boolean;
Property Value
Type Description
boolean

textAlignment

The horizontal text alignment of this text box. This controls the alignment of both the content and the placeholder text. Value must be one of "left", "right", "center".

context
Not available.
Declaration
textAlignment: string;
Property Value
Type Description
string

value

The text content of this text box.

context
Not available.
Declaration
value: string;
Property Value
Type Description
string

Methods

blur()

Request this text box to release the keyboard focus.

context
Not available.
Declaration
blur(): void;
Returns
Type Description
void

focus()

Move the keyboard focus to this text box

context
Not available.
Declaration
focus(): void;
Returns
Type Description
void
Back to top Generated by DocFX