Interface TextBox

See: relevant section in reference guide

interface TextBox {
    $CreationOptions?: TextBoxCreationOptions;
    $ID: string;
    $Type: "Pages$TextBox";
    appearance: Appearance;
    ariaRequired: boolean;
    attributeRef: null | AttributeRef;
    autocomplete: boolean;
    autocompletePurpose: AutocompletePurposeType;
    autoFocus: boolean;
    conditionalEditabilitySettings: null | ConditionalEditabilitySettings;
    conditionalVisibilitySettings: null | ConditionalVisibilitySettings;
    editable: EditableEnum;
    formattingInfo: FormattingInfo;
    inputMask: string;
    isPasswordBox: boolean;
    keyboardType: KeyboardType;
    labelTemplate: null | ClientTemplate;
    maxLengthCode: number;
    name: string;
    nativeAccessibilitySettings: null | AccessibilitySettings;
    onChangeAction: ClientAction;
    onEnterAction: ClientAction;
    onEnterKeyPressAction: ClientAction;
    onLeaveAction: ClientAction;
    placeholderTemplate: ClientTemplate;
    readOnlyStyle: ReadOnlyStyle;
    screenReaderLabel: null | ClientTemplate;
    sourceVariable: null | PageVariable;
    submitBehaviour: SubmitBehaviourType;
    submitOnInputDelay: number;
    tabIndex: number;
    validation: WidgetValidation;
}

Hierarchy (view full)

TextWidgetBase
- TextBox

Properties

`Optional`$CreationOptions

$CreationOptions?: TextBoxCreationOptions

Options to pass during the element creation

$ID

$ID: string

The unique id of the element.

$Type

$Type

The type of the element.

appearance

appearance: Appearance

ariaRequired

ariaRequired: boolean

attributeRef

attributeRef: null | AttributeRef

autocomplete

autocomplete: boolean

autocompletePurpose

autocompletePurpose: AutocompletePurposeType

autoFocus

autoFocus: boolean

conditionalEditabilitySettings

conditionalEditabilitySettings: null | ConditionalEditabilitySettings

conditionalVisibilitySettings

conditionalVisibilitySettings: null | ConditionalVisibilitySettings

editable

editable: EditableEnum

formattingInfo

formattingInfo: FormattingInfo

inputMask

inputMask: string

isPasswordBox

isPasswordBox: boolean

keyboardType

keyboardType: KeyboardType

labelTemplate

labelTemplate: null | ClientTemplate

maxLengthCode

maxLengthCode: number

name

name: string

nativeAccessibilitySettings

nativeAccessibilitySettings: null | AccessibilitySettings

onChangeAction

onChangeAction: ClientAction

onEnterAction

onEnterAction: ClientAction

onEnterKeyPressAction

onEnterKeyPressAction: ClientAction

onLeaveAction

onLeaveAction: ClientAction

placeholderTemplate

placeholderTemplate: ClientTemplate

readOnlyStyle

readOnlyStyle: ReadOnlyStyle

screenReaderLabel

screenReaderLabel: null | ClientTemplate

sourceVariable

sourceVariable: null | PageVariable

submitBehaviour

submitBehaviour: SubmitBehaviourType

submitOnInputDelay

submitOnInputDelay: number

tabIndex

tabIndex: number

validation

validation: WidgetValidation