Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TextArea

See: relevant section in reference guide

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

attributePath

attributePath: string

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

In version 7.11.0: deleted

attributeRef

attributeRef: AttributeRef | null

In version 7.11.0: introduced

class

class: string

conditionalEditabilitySettings

conditionalEditabilitySettings: ConditionalEditabilitySettings | null

conditionalVisibilitySettings

conditionalVisibilitySettings: ConditionalVisibilitySettings | null

container

container: AbstractElement

containerAsBuildingBlock

containerAsBuildingBlock: BuildingBlock

containerAsDataView

containerAsDataView: DataView

containerAsDivContainer

containerAsDivContainer: DivContainer

containerAsGroupBox

containerAsGroupBox: GroupBox

containerAsHeader

containerAsHeader: Header

containerAsLayout

containerAsLayout: Layout

containerAsLayoutCallArgument

containerAsLayoutCallArgument: LayoutCallArgument

containerAsLayoutGridColumn

containerAsLayoutGridColumn: LayoutGridColumn

containerAsListView

containerAsListView: ListView

containerAsListViewTemplate

containerAsListViewTemplate: ListViewTemplate

containerAsMasterDetailRegion

containerAsMasterDetailRegion: MasterDetailRegion

containerAsNativeLayout

containerAsNativeLayout: NativeLayout

containerAsNativeLayoutCallArgument

containerAsNativeLayoutCallArgument: NativeLayoutCallArgument

containerAsNavigationListItem

containerAsNavigationListItem: NavigationListItem

containerAsNestedWidgetValue

containerAsNestedWidgetValue: NestedWidgetValue

containerAsPluginWidget

containerAsPluginWidget: PluginWidget

containerAsReportPane

containerAsReportPane: ReportPane

containerAsScrollContainerRegion

containerAsScrollContainerRegion: ScrollContainerRegion

containerAsSnippet

containerAsSnippet: Snippet

containerAsSplitPane

containerAsSplitPane: SplitPane

containerAsTabPage

containerAsTabPage: TabPage

containerAsTableCell

containerAsTableCell: TableCell

containerAsTemplateGridContents

containerAsTemplateGridContents: TemplateGridContents

containerAsTemplatedWidgetValue

containerAsTemplatedWidgetValue: TemplatedWidgetValue

containerAsVerticalFlow

containerAsVerticalFlow: VerticalFlow

counterMessage

counterMessage: Text

editable

editable: EditableEnum

id

id: string

isLoaded

isLoaded: boolean

Checks whether all attributes are available ATM

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

label

label: Text | null

In version 7.18.0: deleted

labelTemplate

labelTemplate: ClientTemplate | null

In version 7.18.0: introduced

maxLengthCode

maxLengthCode: number

model

model: IModel

name

name: string

numberOfLines

numberOfLines: number

onChangeAction

onChangeAction: ClientAction

In version 7.13.0: introduced

onChangeMicroflowSettings

onChangeMicroflowSettings: MicroflowSettings

In version 7.13.0: deleted

onEnterAction

onEnterAction: ClientAction

In version 7.13.0: introduced

onEnterMicroflowSettings

onEnterMicroflowSettings: MicroflowSettings

In version 7.13.0: deleted

onLeaveAction

onLeaveAction: ClientAction

In version 7.13.0: introduced

onLeaveMicroflowSettings

onLeaveMicroflowSettings: MicroflowSettings

In version 7.13.0: deleted

placeholder

placeholder: Text

readOnlyStyle

readOnlyStyle: ReadOnlyStyle

In version 6.9.0: introduced

required

required: boolean

In version 7.6.0: deleted

requiredMessage

requiredMessage: Text

In version 7.6.0: deleted

structureTypeName

structureTypeName: string

style

style: string

tabIndex

tabIndex: number

textTooLongMessage

textTooLongMessage: Text

unit

unit: ModelUnit

validation

validation: WidgetValidation

In version 7.6.0: introduced

Static structureTypeName

structureTypeName: string

Static versionInfo

versionInfo: StructureVersionInfo

Methods

allProperties

asLoaded

  • asLoaded()

  • 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.

deepCopy

deepCopyWithIdMap

delete

  • delete(): void

detach

  • detach()

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

findElementById

Protected getContainerAs

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

load

  • load(callback: function, forceRefresh?: boolean): void
  • load(forceRefresh?: boolean): Promise

  • 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: ): void

        • Parameters

          • elem:

          Returns void

    • Optional forceRefresh: boolean

    Returns void

  • Parameters

    • Optional forceRefresh: boolean

    Returns Promise

loadedProperties

publicProperties

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 TextArea 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 TextArea

Static createInBuildingBlockUnderWidget

  • Creates and returns a new TextArea instance in the SDK and on the server. The new TextArea 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 TextArea

Static createInBuildingBlockUnderWidgets

  • Creates and returns a new TextArea instance in the SDK and on the server. The new TextArea 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 TextArea

Static createInDataViewUnderFooterWidget

  • Creates and returns a new TextArea instance in the SDK and on the server. The new TextArea 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 TextArea

Static createInDataViewUnderFooterWidgets

  • Creates and returns a new TextArea instance in the SDK and on the server. The new TextArea 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 TextArea

Static createInDataViewUnderWidget

  • Creates and returns a new TextArea instance in the SDK and on the server. The new TextArea 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 TextArea

Static createInDataViewUnderWidgets

  • Creates and returns a new TextArea instance in the SDK and on the server. The new TextArea 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 TextArea

Static createInDivContainerUnderWidget

  • Creates and returns a new TextArea instance in the SDK and on the server. The new TextArea 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 TextArea

Static createInDivContainerUnderWidgets

  • Creates and returns a new TextArea instance in the SDK and on the server. The new TextArea 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 TextArea

Static createInGroupBoxUnderWidget

  • Creates and returns a new TextArea instance in the SDK and on the server. The new TextArea 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 TextArea

Static createInGroupBoxUnderWidgets

  • Creates and returns a new TextArea instance in the SDK and on the server. The new TextArea 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 TextArea

Static createInHeaderUnderLeftWidget

  • Creates and returns a new TextArea instance in the SDK and on the server. The new TextArea 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 TextArea

Static createInHeaderUnderLeftWidgets

  • Creates and returns a new TextArea instance in the SDK and on the server. The new TextArea 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 TextArea

Static createInHeaderUnderRightWidget

  • Creates and returns a new TextArea instance in the SDK and on the server. The new TextArea 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 TextArea

Static createInHeaderUnderRightWidgets

  • Creates and returns a new TextArea instance in the SDK and on the server. The new TextArea 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 TextArea

Static createInLayoutCallArgumentUnderWidget

  • Creates and returns a new TextArea instance in the SDK and on the server. The new TextArea 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 TextArea

Static createInLayoutCallArgumentUnderWidgets

  • Creates and returns a new TextArea instance in the SDK and on the server. The new TextArea 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 TextArea

Static createInLayoutGridColumnUnderWidget

  • Creates and returns a new TextArea instance in the SDK and on the server. The new TextArea 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 TextArea

Static createInLayoutGridColumnUnderWidgets

  • Creates and returns a new TextArea instance in the SDK and on the server. The new TextArea 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 TextArea

Static createInLayoutUnderWidget

  • Creates and returns a new TextArea instance in the SDK and on the server. The new TextArea 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 TextArea

Static createInLayoutUnderWidgets

  • Creates and returns a new TextArea instance in the SDK and on the server. The new TextArea 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 and higher

    Parameters

    Returns TextArea

Static createInListViewTemplateUnderWidget

  • Creates and returns a new TextArea instance in the SDK and on the server. The new TextArea 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 TextArea

Static createInListViewTemplateUnderWidgets

  • Creates and returns a new TextArea instance in the SDK and on the server. The new TextArea 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 TextArea

Static createInListViewUnderWidget

  • Creates and returns a new TextArea instance in the SDK and on the server. The new TextArea 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 TextArea

Static createInListViewUnderWidgets

  • Creates and returns a new TextArea instance in the SDK and on the server. The new TextArea 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 TextArea

Static createInMasterDetailRegionUnderWidget

  • Creates and returns a new TextArea instance in the SDK and on the server. The new TextArea 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

    Returns TextArea

Static createInNativeLayoutCallArgumentUnderWidgets

  • Creates and returns a new TextArea instance in the SDK and on the server. The new TextArea 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 and higher

    Parameters

    Returns TextArea

Static createInNativeLayoutUnderHeaderWidget

  • Creates and returns a new TextArea instance in the SDK and on the server. The new TextArea 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 and higher

    Parameters

    Returns TextArea

Static createInNativeLayoutUnderWidgets

  • Creates and returns a new TextArea instance in the SDK and on the server. The new TextArea 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 and higher

    Parameters

    Returns TextArea

Static createInNavigationListItemUnderWidget

  • Creates and returns a new TextArea instance in the SDK and on the server. The new TextArea 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 TextArea

Static createInNavigationListItemUnderWidgets

  • Creates and returns a new TextArea instance in the SDK and on the server. The new TextArea 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 TextArea

Static createInReportPaneUnderParameterWidget

  • Creates and returns a new TextArea instance in the SDK and on the server. The new TextArea 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 TextArea

Static createInReportPaneUnderReportWidget

  • Creates and returns a new TextArea instance in the SDK and on the server. The new TextArea 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 TextArea

Static createInScrollContainerRegionUnderWidget

  • Creates and returns a new TextArea instance in the SDK and on the server. The new TextArea 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 TextArea

Static createInScrollContainerRegionUnderWidgets

  • Creates and returns a new TextArea instance in the SDK and on the server. The new TextArea 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 TextArea

Static createInSnippetUnderWidget

  • Creates and returns a new TextArea instance in the SDK and on the server. The new TextArea 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 TextArea

Static createInSnippetUnderWidgets

  • Creates and returns a new TextArea instance in the SDK and on the server. The new TextArea 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 TextArea

Static createInSplitPaneUnderFirstWidget

  • Creates and returns a new TextArea instance in the SDK and on the server. The new TextArea 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 TextArea

Static createInSplitPaneUnderFirstWidgets

  • Creates and returns a new TextArea instance in the SDK and on the server. The new TextArea 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 and higher

    Parameters

    Returns TextArea

Static createInSplitPaneUnderSecondWidget

  • Creates and returns a new TextArea instance in the SDK and on the server. The new TextArea 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 TextArea

Static createInSplitPaneUnderSecondWidgets

  • Creates and returns a new TextArea instance in the SDK and on the server. The new TextArea 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 and higher

    Parameters

    Returns TextArea

Static createInTabPageUnderWidget

  • Creates and returns a new TextArea instance in the SDK and on the server. The new TextArea 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 TextArea

Static createInTabPageUnderWidgets

  • Creates and returns a new TextArea instance in the SDK and on the server. The new TextArea 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 TextArea

Static createInTableCellUnderWidget

  • Creates and returns a new TextArea instance in the SDK and on the server. The new TextArea 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 TextArea

Static createInTableCellUnderWidgets

  • Creates and returns a new TextArea instance in the SDK and on the server. The new TextArea 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 TextArea

Static createInTemplateGridContentsUnderWidget

  • Creates and returns a new TextArea instance in the SDK and on the server. The new TextArea 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 TextArea

Static createInTemplateGridContentsUnderWidgets

  • Creates and returns a new TextArea instance in the SDK and on the server. The new TextArea 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 TextArea

Static createInVerticalFlowUnderWidgets

  • Creates and returns a new TextArea instance in the SDK and on the server. The new TextArea 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 TextArea

Generated using TypeDoc