Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TextBox

See: relevant section in reference guide

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string

Static versionInfo

versionInfo: StructureVersionInfo

Accessors

appearance

  • In version 8.0.0: introduced

    Returns Appearance

  • In version 8.0.0: introduced

    Parameters

    Returns any

ariaRequired

  • get (): boolean
  • set (newValue: boolean): any

attributePath

  • get (): string
  • set (newValue: string): any

  • The value of this property is conceptually of type paths.LegacyAttributePath.

    In version 7.11.0: deleted

    Returns string

  • The value of this property is conceptually of type paths.LegacyAttributePath.

    In version 7.11.0: deleted

    Parameters

    • newValue: string

    Returns any

attributeRef

autocomplete

  • get (): boolean
  • set (newValue: boolean): any

  • In version 8.10.0: introduced

    Returns boolean

  • In version 8.10.0: introduced

    Parameters

    • newValue: boolean

    Returns any

autocompletePurpose

class

  • get (): string
  • set (newValue: string): any

  • In version 8.0.0: deleted

    Returns string

  • In version 8.0.0: deleted

    Parameters

    • newValue: string

    Returns any

conditionalEditabilitySettings

conditionalVisibilitySettings

container

containerAsBuildingBlock

containerAsDataView

containerAsDivContainer

containerAsGroupBox

containerAsHeader

containerAsLayout

containerAsLayoutCallArgument

containerAsLayoutGridColumn

containerAsListView

containerAsListViewTemplate

containerAsMasterDetailRegion

  • get (): MasterDetailRegion

containerAsNativeLayout

  • get (): NativeLayout

containerAsNativeLayoutCallArgument

  • get (): NativeLayoutCallArgument

containerAsNativeLayoutContent

containerAsNavigationListItem

containerAsReportPane

containerAsScrollContainerRegion

containerAsSnippet

containerAsSplitPane

containerAsTabPage

containerAsTableCell

containerAsTemplateGridContents

containerAsVerticalFlow

containerAsWebLayoutContent

containerAsWidgetValue

editable

formattingInfo

inputMask

  • get (): string
  • set (newValue: string): any

  • Returns string

  • Parameters

    • newValue: string

    Returns any

isLoaded

  • get (): boolean

  • Checks whether all attributes are available ATM

    • if false, a load is required to access these properties.

    Returns boolean

isPasswordBox

  • get (): boolean
  • set (newValue: boolean): any

  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns any

keyboardType

  • In version 8.0.0: introduced

    Returns KeyboardType

  • In version 8.0.0: introduced

    Parameters

    Returns any

label

  • get (): Text | null
  • set (newValue: Text | null): any

labelTemplate

maxLengthCode

  • get (): number
  • set (newValue: number): any

model

name

  • get (): string
  • set (newValue: string): any

  • Returns string

  • Parameters

    • newValue: string

    Returns any

onChangeAction

onChangeMicroflowSettings

onEnterAction

onEnterKeyPressAction

  • In version 8.7.0: introduced

    Returns ClientAction

  • In version 8.7.0: introduced

    Parameters

    Returns any

onEnterMicroflowSettings

onLeaveAction

onLeaveMicroflowSettings

placeholder

  • get (): Text
  • set (newValue: Text): any

readOnlyStyle

required

  • get (): boolean
  • set (newValue: boolean): any

requiredMessage

  • get (): Text
  • set (newValue: Text): any

screenReaderLabel

sourceVariable

style

  • get (): string
  • set (newValue: string): any

  • In version 8.0.0: deleted

    Returns string

  • In version 8.0.0: deleted

    Parameters

    • newValue: string

    Returns any

submitBehaviour

submitOnInputDelay

  • get (): number
  • set (newValue: number): any

  • In version 8.15.0: introduced

    Returns number

  • In version 8.15.0: introduced

    Parameters

    • newValue: number

    Returns any

tabIndex

  • get (): number
  • set (newValue: number): any

  • Returns number

  • Parameters

    • newValue: number

    Returns any

unit

validation

Methods

allProperties

  • allProperties(): AbstractProperty<any, any>[]

asLoaded

  • asLoaded(): this

  • Transforms a IElement interface into a Element class, loading the containing unit if necessary. (Those are technically already the same, but this function makes sure its properties are available.)

    • If invoked without callback, it checks whether the properties are available or it will throw;
    • If invoked with callback, it will load the data from the server if needed, and then invoke the callback.

    Returns this

deepCopy

deepCopyWithIdMap

delete

  • delete(): void

detach

  • detach(): this

  • Detaches this element from the model, so that it can be attached in a different place.

    Returns this

findElementById

Protected getContainerAs

  • getContainerAs<T>(containerType: any): T

load

  • load(callback: function, forceRefresh?: undefined | false | true): void
  • load(forceRefresh?: undefined | false | true): Promise<this>

  • Transforms a IElement interface into a Element class, loading the containing unit if necessary. (Those are technically already the same, but this function makes sure its properties are available.)

    • If invoked without callback, it checks whether the properties are available or it will throw;
    • If invoked with callback, it will load the data from the server if needed, and then invoke the callback.

    Parameters

    • callback: function
        • (elem: this): void

        • Parameters

          • elem: this

          Returns void

    • Optional forceRefresh: undefined | false | true

    Returns void

  • Parameters

    • Optional forceRefresh: undefined | false | true

    Returns Promise<this>

loadedProperties

  • loadedProperties(): AbstractProperty<any, any>[]

publicProperties

  • publicProperties(): AbstractProperty<any, any>[]

toJSON

traverse

  • traverse(visit: function): void

traverseFind

  • traverseFind<T>(visit: function): T | null

traversePublicParts

  • traversePublicParts(visit: function): void

Static create

  • Creates and returns a new TextBox instance in the SDK and on the server. Expects one argument: the IModel object the instance will "live on". After creation, assign or add this instance to a property that accepts this kind of objects.

    Parameters

    Returns TextBox

Static createInBuildingBlockUnderWidget

  • Creates and returns a new TextBox instance in the SDK and on the server. The new TextBox will be automatically stored in the 'widget' property of the parent BuildingBlock element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 7.7.0 to 7.14.0

    Parameters

    Returns TextBox

Static createInBuildingBlockUnderWidgets

  • Creates and returns a new TextBox instance in the SDK and on the server. The new TextBox will be automatically stored in the 'widgets' property of the parent BuildingBlock element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 7.15.0 and higher

    Parameters

    Returns TextBox

Static createInDataViewUnderFooterWidget

  • Creates and returns a new TextBox instance in the SDK and on the server. The new TextBox will be automatically stored in the 'footerWidget' property of the parent DataView element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 6.7.0 to 7.14.0

    Parameters

    Returns TextBox

Static createInDataViewUnderFooterWidgets

  • Creates and returns a new TextBox instance in the SDK and on the server. The new TextBox will be automatically stored in the 'footerWidgets' property of the parent DataView element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 7.15.0 and higher

    Parameters

    Returns TextBox

Static createInDataViewUnderWidget

  • Creates and returns a new TextBox instance in the SDK and on the server. The new TextBox will be automatically stored in the 'widget' property of the parent DataView element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0

    Parameters

    Returns TextBox

Static createInDataViewUnderWidgets

  • Creates and returns a new TextBox instance in the SDK and on the server. The new TextBox will be automatically stored in the 'widgets' property of the parent DataView element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 7.15.0 and higher

    Parameters

    Returns TextBox

Static createInDivContainerUnderWidget

  • Creates and returns a new TextBox instance in the SDK and on the server. The new TextBox will be automatically stored in the 'widget' property of the parent DivContainer element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0

    Parameters

    Returns TextBox

Static createInDivContainerUnderWidgets

  • Creates and returns a new TextBox instance in the SDK and on the server. The new TextBox will be automatically stored in the 'widgets' property of the parent DivContainer element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 7.15.0 and higher

    Parameters

    Returns TextBox

Static createInGroupBoxUnderWidget

  • Creates and returns a new TextBox instance in the SDK and on the server. The new TextBox will be automatically stored in the 'widget' property of the parent GroupBox element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0

    Parameters

    Returns TextBox

Static createInGroupBoxUnderWidgets

  • Creates and returns a new TextBox instance in the SDK and on the server. The new TextBox will be automatically stored in the 'widgets' property of the parent GroupBox element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 7.15.0 and higher

    Parameters

    Returns TextBox

Static createInHeaderUnderLeftWidget

  • Creates and returns a new TextBox instance in the SDK and on the server. The new TextBox will be automatically stored in the 'leftWidget' property of the parent Header element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0

    Parameters

    Returns TextBox

Static createInHeaderUnderLeftWidgets

  • Creates and returns a new TextBox instance in the SDK and on the server. The new TextBox will be automatically stored in the 'leftWidgets' property of the parent Header element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 7.15.0 and higher

    Parameters

    Returns TextBox

Static createInHeaderUnderRightWidget

  • Creates and returns a new TextBox instance in the SDK and on the server. The new TextBox will be automatically stored in the 'rightWidget' property of the parent Header element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0

    Parameters

    Returns TextBox

Static createInHeaderUnderRightWidgets

  • Creates and returns a new TextBox instance in the SDK and on the server. The new TextBox will be automatically stored in the 'rightWidgets' property of the parent Header element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 7.15.0 and higher

    Parameters

    Returns TextBox

Static createInLayoutCallArgumentUnderWidget

  • Creates and returns a new TextBox instance in the SDK and on the server. The new TextBox will be automatically stored in the 'widget' property of the parent LayoutCallArgument element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0

    Parameters

    Returns TextBox

Static createInLayoutCallArgumentUnderWidgets

  • Creates and returns a new TextBox instance in the SDK and on the server. The new TextBox will be automatically stored in the 'widgets' property of the parent LayoutCallArgument element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 7.15.0 and higher

    Parameters

    Returns TextBox

Static createInLayoutGridColumnUnderWidget

  • Creates and returns a new TextBox instance in the SDK and on the server. The new TextBox will be automatically stored in the 'widget' property of the parent LayoutGridColumn element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0

    Parameters

    Returns TextBox

Static createInLayoutGridColumnUnderWidgets

  • Creates and returns a new TextBox instance in the SDK and on the server. The new TextBox will be automatically stored in the 'widgets' property of the parent LayoutGridColumn element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 7.15.0 and higher

    Parameters

    Returns TextBox

Static createInLayoutUnderWidget

  • Creates and returns a new TextBox instance in the SDK and on the server. The new TextBox will be automatically stored in the 'widget' property of the parent Layout element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0

    Parameters

    Returns TextBox

Static createInLayoutUnderWidgets

  • Creates and returns a new TextBox instance in the SDK and on the server. The new TextBox will be automatically stored in the 'widgets' property of the parent Layout element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 7.15.0 to 7.23.0

    Parameters

    Returns TextBox

Static createInListViewTemplateUnderWidget

  • Creates and returns a new TextBox instance in the SDK and on the server. The new TextBox will be automatically stored in the 'widget' property of the parent ListViewTemplate element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0

    Parameters

    Returns TextBox

Static createInListViewTemplateUnderWidgets

  • Creates and returns a new TextBox instance in the SDK and on the server. The new TextBox will be automatically stored in the 'widgets' property of the parent ListViewTemplate element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 7.15.0 and higher

    Parameters

    Returns TextBox

Static createInListViewUnderWidget

  • Creates and returns a new TextBox instance in the SDK and on the server. The new TextBox will be automatically stored in the 'widget' property of the parent ListView element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0

    Parameters

    Returns TextBox

Static createInListViewUnderWidgets

  • Creates and returns a new TextBox instance in the SDK and on the server. The new TextBox will be automatically stored in the 'widgets' property of the parent ListView element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 7.15.0 and higher

    Parameters

    Returns TextBox

Static createInMasterDetailRegionUnderWidget

  • createInMasterDetailRegionUnderWidget(container: MasterDetailRegion): TextBox

  • Creates and returns a new TextBox instance in the SDK and on the server. The new TextBox will be automatically stored in the 'widget' property of the parent MasterDetailRegion element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 7.1.0 to 7.14.0

    Parameters

    • container: MasterDetailRegion

    Returns TextBox

Static createInNativeLayoutCallArgumentUnderWidgets

  • createInNativeLayoutCallArgumentUnderWidgets(container: NativeLayoutCallArgument): TextBox

  • Creates and returns a new TextBox instance in the SDK and on the server. The new TextBox will be automatically stored in the 'widgets' property of the parent nativepages.NativeLayoutCallArgument element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 7.23.0 to 7.23.0

    Parameters

    • container: NativeLayoutCallArgument

    Returns TextBox

Static createInNativeLayoutContentUnderSidebarWidgets

  • Creates and returns a new TextBox instance in the SDK and on the server. The new TextBox will be automatically stored in the 'sidebarWidgets' property of the parent NativeLayoutContent element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 8.5.0 and higher

    Parameters

    Returns TextBox

Static createInNativeLayoutContentUnderWidgets

  • Creates and returns a new TextBox instance in the SDK and on the server. The new TextBox will be automatically stored in the 'widgets' property of the parent NativeLayoutContent element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 8.0.0 and higher

    Parameters

    Returns TextBox

Static createInNativeLayoutUnderHeaderWidget

  • createInNativeLayoutUnderHeaderWidget(container: NativeLayout): TextBox

  • Creates and returns a new TextBox instance in the SDK and on the server. The new TextBox will be automatically stored in the 'headerWidget' property of the parent nativepages.NativeLayout element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 7.22.0 to 7.23.0

    Parameters

    • container: NativeLayout

    Returns TextBox

Static createInNativeLayoutUnderWidgets

  • createInNativeLayoutUnderWidgets(container: NativeLayout): TextBox

  • Creates and returns a new TextBox instance in the SDK and on the server. The new TextBox will be automatically stored in the 'widgets' property of the parent nativepages.NativeLayout element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 7.21.0 to 7.23.0

    Parameters

    • container: NativeLayout

    Returns TextBox

Static createInNavigationListItemUnderWidget

  • Creates and returns a new TextBox instance in the SDK and on the server. The new TextBox will be automatically stored in the 'widget' property of the parent NavigationListItem element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0

    Parameters

    Returns TextBox

Static createInNavigationListItemUnderWidgets

  • Creates and returns a new TextBox instance in the SDK and on the server. The new TextBox will be automatically stored in the 'widgets' property of the parent NavigationListItem element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 7.15.0 and higher

    Parameters

    Returns TextBox

Static createInReportPaneUnderParameterWidget

  • Creates and returns a new TextBox instance in the SDK and on the server. The new TextBox will be automatically stored in the 'parameterWidget' property of the parent reports.ReportPane element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 6.9.0

    Parameters

    Returns TextBox

Static createInReportPaneUnderReportWidget

  • Creates and returns a new TextBox instance in the SDK and on the server. The new TextBox will be automatically stored in the 'reportWidget' property of the parent reports.ReportPane element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 6.9.0

    Parameters

    Returns TextBox

Static createInScrollContainerRegionUnderWidget

  • Creates and returns a new TextBox instance in the SDK and on the server. The new TextBox will be automatically stored in the 'widget' property of the parent ScrollContainerRegion element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0

    Parameters

    Returns TextBox

Static createInScrollContainerRegionUnderWidgets

  • Creates and returns a new TextBox instance in the SDK and on the server. The new TextBox will be automatically stored in the 'widgets' property of the parent ScrollContainerRegion element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 7.15.0 and higher

    Parameters

    Returns TextBox

Static createInSnippetUnderWidget

  • Creates and returns a new TextBox instance in the SDK and on the server. The new TextBox will be automatically stored in the 'widget' property of the parent Snippet element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0

    Parameters

    Returns TextBox

Static createInSnippetUnderWidgets

  • Creates and returns a new TextBox instance in the SDK and on the server. The new TextBox will be automatically stored in the 'widgets' property of the parent Snippet element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 7.15.0 and higher

    Parameters

    Returns TextBox

Static createInSplitPaneUnderFirstWidget

  • Creates and returns a new TextBox instance in the SDK and on the server. The new TextBox will be automatically stored in the 'firstWidget' property of the parent SplitPane element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0

    Parameters

    Returns TextBox

Static createInSplitPaneUnderFirstWidgets

  • Creates and returns a new TextBox instance in the SDK and on the server. The new TextBox will be automatically stored in the 'firstWidgets' property of the parent SplitPane element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 7.15.0 to 7.23.0

    Parameters

    Returns TextBox

Static createInSplitPaneUnderSecondWidget

  • Creates and returns a new TextBox instance in the SDK and on the server. The new TextBox will be automatically stored in the 'secondWidget' property of the parent SplitPane element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0

    Parameters

    Returns TextBox

Static createInSplitPaneUnderSecondWidgets

  • Creates and returns a new TextBox instance in the SDK and on the server. The new TextBox will be automatically stored in the 'secondWidgets' property of the parent SplitPane element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 7.15.0 to 7.23.0

    Parameters

    Returns TextBox

Static createInTabPageUnderWidget

  • Creates and returns a new TextBox instance in the SDK and on the server. The new TextBox will be automatically stored in the 'widget' property of the parent TabPage element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0

    Parameters

    Returns TextBox

Static createInTabPageUnderWidgets

  • Creates and returns a new TextBox instance in the SDK and on the server. The new TextBox will be automatically stored in the 'widgets' property of the parent TabPage element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 7.15.0 and higher

    Parameters

    Returns TextBox

Static createInTableCellUnderWidget

  • Creates and returns a new TextBox instance in the SDK and on the server. The new TextBox will be automatically stored in the 'widget' property of the parent TableCell element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0

    Parameters

    Returns TextBox

Static createInTableCellUnderWidgets

  • Creates and returns a new TextBox instance in the SDK and on the server. The new TextBox will be automatically stored in the 'widgets' property of the parent TableCell element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 7.15.0 and higher

    Parameters

    Returns TextBox

Static createInTemplateGridContentsUnderWidget

  • Creates and returns a new TextBox instance in the SDK and on the server. The new TextBox will be automatically stored in the 'widget' property of the parent TemplateGridContents element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0

    Parameters

    Returns TextBox

Static createInTemplateGridContentsUnderWidgets

  • Creates and returns a new TextBox instance in the SDK and on the server. The new TextBox will be automatically stored in the 'widgets' property of the parent TemplateGridContents element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 7.15.0 and higher

    Parameters

    Returns TextBox

Static createInVerticalFlowUnderWidgets

  • Creates and returns a new TextBox instance in the SDK and on the server. The new TextBox will be automatically stored in the 'widgets' property of the parent VerticalFlow element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0

    Parameters

    Returns TextBox

Static createInWebLayoutContentUnderWidgets

  • Creates and returns a new TextBox instance in the SDK and on the server. The new TextBox will be automatically stored in the 'widgets' property of the parent WebLayoutContent element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 8.0.0 and higher

    Parameters

    Returns TextBox

Static createInWidgetValueUnderWidgets

  • Creates and returns a new TextBox instance in the SDK and on the server. The new TextBox will be automatically stored in the 'widgets' property of the parent customwidgets.WidgetValue element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 8.2.0 and higher

    Parameters

    Returns TextBox

Generated using TypeDoc