Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Text

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string

Static versionInfo

Accessors

container

containerAsAssociationDeleteBehavior

containerAsAttributeWidget

containerAsAttributeWidgetWithPlaceholder

containerAsBasicReportAggregate

containerAsBasicReportColumn

containerAsBottomBarItem

containerAsButton

containerAsCallNanoflowClientAction

containerAsClientTemplate

containerAsConfirmationInfo

containerAsControlBarButton

containerAsDataGridColumn

containerAsDataView

containerAsDropDown

containerAsDropDownButtonItem

containerAsEnumerationValue

containerAsGridColumn

containerAsInputWidget

containerAsLabel

containerAsLoginTextBox

containerAsMasterDetailDetailRegion

containerAsMenuItem

containerAsMicroflow

containerAsMicroflowSettings

containerAsNavigationProfile

containerAsPage

containerAsPageSettings

containerAsReferenceSelector

containerAsReportButton

containerAsReportChart

containerAsReportChartSeries

containerAsReportDateRangeField

containerAsReportDateRangeSelector

containerAsSearchField

containerAsStaticLabel

containerAsSystemText

containerAsTabPage

containerAsTextArea

containerAsTextTemplate

containerAsTitle

containerAsValidationRule

containerAsWidgetValidation

containerAsWidgetValue

isLoaded

  • get (): boolean
  • Checks whether all attributes are available ATM

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

    Returns boolean

model

translations

unit

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

Static createInAssociationDeleteBehaviorUnderChildErrorMessage

  • Creates and returns a new Text instance in the SDK and on the server. The new Text will be automatically stored in the 'childErrorMessage' property of the parent domainmodels.AssociationDeleteBehavior element passed as argument.

    Parameters

    Returns Text

Static createInAssociationDeleteBehaviorUnderParentErrorMessage

  • Creates and returns a new Text instance in the SDK and on the server. The new Text will be automatically stored in the 'parentErrorMessage' property of the parent domainmodels.AssociationDeleteBehavior element passed as argument.

    Parameters

    Returns Text

Static createInAttributeWidgetUnderRequiredMessage

  • Creates and returns a new Text instance in the SDK and on the server. The new Text will be automatically stored in the 'requiredMessage' property of the parent pages.AttributeWidget element passed as argument.

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

    Parameters

    Returns Text

Static createInAttributeWidgetWithPlaceholderUnderPlaceholder

  • Creates and returns a new Text instance in the SDK and on the server. The new Text will be automatically stored in the 'placeholder' property of the parent pages.AttributeWidgetWithPlaceholder element passed as argument.

    Parameters

    Returns Text

Static createInBasicReportAggregateUnderCaption

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

    Parameters

    Returns Text

Static createInBasicReportColumnUnderCaption

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

    Parameters

    Returns Text

Static createInBottomBarItemUnderCaption

  • Creates and returns a new Text instance in the SDK and on the server. The new Text will be automatically stored in the 'caption' property of the parent nativepages.BottomBarItem 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 Text

Static createInButtonUnderTooltip

  • createInButtonUnderTooltip(container: Button): Text
  • Creates and returns a new Text instance in the SDK and on the server. The new Text will be automatically stored in the 'tooltip' property of the parent pages.Button element passed as argument.

    Parameters

    Returns Text

Static createInCallNanoflowClientActionUnderProgressMessage

  • Creates and returns a new Text instance in the SDK and on the server. The new Text will be automatically stored in the 'progressMessage' property of the parent pages.CallNanoflowClientAction element passed as argument.

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

    Parameters

    Returns Text

Static createInClientTemplateUnderFallback

  • Creates and returns a new Text instance in the SDK and on the server. The new Text will be automatically stored in the 'fallback' property of the parent pages.ClientTemplate element passed as argument.

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

    Parameters

    Returns Text

Static createInClientTemplateUnderTemplate

  • Creates and returns a new Text instance in the SDK and on the server. The new Text will be automatically stored in the 'template' property of the parent pages.ClientTemplate element passed as argument.

    Parameters

    Returns Text

Static createInConfirmationInfoUnderCancelButtonCaption

  • Creates and returns a new Text instance in the SDK and on the server. The new Text will be automatically stored in the 'cancelButtonCaption' property of the parent pages.ConfirmationInfo element passed as argument.

    Parameters

    Returns Text

Static createInConfirmationInfoUnderProceedButtonCaption

  • Creates and returns a new Text instance in the SDK and on the server. The new Text will be automatically stored in the 'proceedButtonCaption' property of the parent pages.ConfirmationInfo element passed as argument.

    Parameters

    Returns Text

Static createInConfirmationInfoUnderQuestion

  • Creates and returns a new Text instance in the SDK and on the server. The new Text will be automatically stored in the 'question' property of the parent pages.ConfirmationInfo element passed as argument.

    Parameters

    Returns Text

Static createInControlBarButtonUnderTooltip

  • Creates and returns a new Text instance in the SDK and on the server. The new Text will be automatically stored in the 'tooltip' property of the parent pages.ControlBarButton element passed as argument.

    Parameters

    Returns Text

Static createInDataGridColumnUnderCaption

  • Creates and returns a new Text instance in the SDK and on the server. The new Text will be automatically stored in the 'caption' property of the parent documenttemplates.DataGridColumn element passed as argument.

    Parameters

    Returns Text

Static createInDataViewUnderNoEntityMessage

  • createInDataViewUnderNoEntityMessage(container: DataView): Text
  • Creates and returns a new Text instance in the SDK and on the server. The new Text will be automatically stored in the 'noEntityMessage' property of the parent pages.DataView element passed as argument.

    Parameters

    Returns Text

Static createInDropDownButtonItemUnderCaption

  • Creates and returns a new Text instance in the SDK and on the server. The new Text will be automatically stored in the 'caption' property of the parent pages.DropDownButtonItem element passed as argument.

    Parameters

    Returns Text

Static createInDropDownUnderEmptyOptionCaption

  • createInDropDownUnderEmptyOptionCaption(container: DropDown): Text
  • Creates and returns a new Text instance in the SDK and on the server. The new Text will be automatically stored in the 'emptyOptionCaption' property of the parent pages.DropDown element passed as argument.

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

    Parameters

    Returns Text

Static createInEnumerationValueUnderCaption

  • Creates and returns a new Text instance in the SDK and on the server. The new Text will be automatically stored in the 'caption' property of the parent enumerations.EnumerationValue element passed as argument.

    Parameters

    Returns Text

Static createInGridColumnUnderAggregateCaption

  • createInGridColumnUnderAggregateCaption(container: GridColumn): Text
  • Creates and returns a new Text instance in the SDK and on the server. The new Text will be automatically stored in the 'aggregateCaption' property of the parent pages.GridColumn element passed as argument.

    Parameters

    Returns Text

Static createInGridColumnUnderCaption

  • Creates and returns a new Text instance in the SDK and on the server. The new Text will be automatically stored in the 'caption' property of the parent pages.GridColumn element passed as argument.

    Parameters

    Returns Text

Static createInInputWidgetUnderLabel

  • Creates and returns a new Text instance in the SDK and on the server. The new Text will be automatically stored in the 'label' property of the parent pages.InputWidget element passed as argument.

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

    Parameters

    Returns Text

Static createInLabelUnderCaption

  • createInLabelUnderCaption(container: Label): Text
  • Creates and returns a new Text instance in the SDK and on the server. The new Text will be automatically stored in the 'caption' property of the parent pages.Label element passed as argument.

    Parameters

    Returns Text

Static createInLoginTextBoxUnderLabel

  • Creates and returns a new Text instance in the SDK and on the server. The new Text will be automatically stored in the 'label' property of the parent pages.LoginTextBox element passed as argument.

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

    Parameters

    Returns Text

Static createInLoginTextBoxUnderPlaceholder

  • Creates and returns a new Text instance in the SDK and on the server. The new Text will be automatically stored in the 'placeholder' property of the parent pages.LoginTextBox element passed as argument.

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

    Parameters

    Returns Text

Static createInMasterDetailDetailRegionUnderTitle

  • Creates and returns a new Text instance in the SDK and on the server. The new Text will be automatically stored in the 'title' property of the parent pages.MasterDetailDetailRegion 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 Text

Static createInMenuItemUnderAlternativeText

  • createInMenuItemUnderAlternativeText(container: MenuItem): Text
  • Creates and returns a new Text instance in the SDK and on the server. The new Text will be automatically stored in the 'alternativeText' property of the parent menus.MenuItem element passed as argument.

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

    Parameters

    Returns Text

Static createInMenuItemUnderCaption

  • Creates and returns a new Text instance in the SDK and on the server. The new Text will be automatically stored in the 'caption' property of the parent menus.MenuItem element passed as argument.

    Parameters

    Returns Text

Static createInMicroflowSettingsUnderProgressMessage

  • Creates and returns a new Text instance in the SDK and on the server. The new Text will be automatically stored in the 'progressMessage' property of the parent pages.MicroflowSettings element passed as argument.

    Parameters

    Returns Text

Static createInMicroflowUnderConcurrencyErrorMessage

  • createInMicroflowUnderConcurrencyErrorMessage(container: Microflow): Text
  • Creates and returns a new Text instance in the SDK and on the server. The new Text will be automatically stored in the 'concurrencyErrorMessage' property of the parent microflows.Microflow element passed as argument.

    Parameters

    Returns Text

Static createInNavigationProfileUnderAppTitle

  • Creates and returns a new Text instance in the SDK and on the server. The new Text will be automatically stored in the 'appTitle' property of the parent navigation.NavigationProfile element passed as argument.

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

    Parameters

    Returns Text

Static createInPageSettingsUnderFormTitle

  • Creates and returns a new Text instance in the SDK and on the server. The new Text will be automatically stored in the 'formTitle' property of the parent pages.PageSettings element passed as argument.

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

    Parameters

    Returns Text

Static createInPageUnderTitle

  • createInPageUnderTitle(container: Page): Text
  • Creates and returns a new Text instance in the SDK and on the server. The new Text will be automatically stored in the 'title' property of the parent pages.Page element passed as argument.

    Parameters

    Returns Text

Static createInReferenceSelectorUnderEmptyOptionCaption

  • Creates and returns a new Text instance in the SDK and on the server. The new Text will be automatically stored in the 'emptyOptionCaption' property of the parent pages.ReferenceSelector element passed as argument.

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

    Parameters

    Returns Text

Static createInReferenceSelectorUnderRequiredMessage

  • Creates and returns a new Text instance in the SDK and on the server. The new Text will be automatically stored in the 'requiredMessage' property of the parent pages.ReferenceSelector element passed as argument.

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

    Parameters

    Returns Text

Static createInReportButtonUnderCaption

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

    Parameters

    Returns Text

Static createInReportChartSeriesUnderCaption

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

    Parameters

    Returns Text

Static createInReportChartUnderXAxisCaption

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

    Parameters

    Returns Text

Static createInReportChartUnderYAxisCaption

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

    Parameters

    Returns Text

Static createInReportDateRangeFieldUnderCaption

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

    Parameters

    Returns Text

Static createInReportDateRangeSelectorUnderFromCaption

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

    Parameters

    Returns Text

Static createInReportDateRangeSelectorUnderToCaption

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

    Parameters

    Returns Text

Static createInSearchFieldUnderCaption

  • Creates and returns a new Text instance in the SDK and on the server. The new Text will be automatically stored in the 'caption' property of the parent pages.SearchField element passed as argument.

    Parameters

    Returns Text

Static createInSearchFieldUnderPlaceholder

  • Creates and returns a new Text instance in the SDK and on the server. The new Text will be automatically stored in the 'placeholder' property of the parent pages.SearchField 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 Text

Static createInStaticLabelUnderCaption

  • Creates and returns a new Text instance in the SDK and on the server. The new Text will be automatically stored in the 'caption' property of the parent documenttemplates.StaticLabel element passed as argument.

    Parameters

    Returns Text

Static createInSystemTextUnderText

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

    Parameters

    Returns Text

Static createInTabPageUnderCaption

  • createInTabPageUnderCaption(container: TabPage): Text
  • Creates and returns a new Text instance in the SDK and on the server. The new Text will be automatically stored in the 'caption' property of the parent pages.TabPage element passed as argument.

    Parameters

    Returns Text

Static createInTextAreaUnderCounterMessage

  • createInTextAreaUnderCounterMessage(container: TextArea): Text
  • Creates and returns a new Text instance in the SDK and on the server. The new Text will be automatically stored in the 'counterMessage' property of the parent pages.TextArea element passed as argument.

    Parameters

    Returns Text

Static createInTextAreaUnderTextTooLongMessage

  • createInTextAreaUnderTextTooLongMessage(container: TextArea): Text
  • Creates and returns a new Text instance in the SDK and on the server. The new Text will be automatically stored in the 'textTooLongMessage' property of the parent pages.TextArea element passed as argument.

    Parameters

    Returns Text

Static createInTextTemplateUnderText

  • Creates and returns a new Text instance in the SDK and on the server. The new Text will be automatically stored in the 'text' property of the parent microflows.TextTemplate element passed as argument.

    Parameters

    Returns Text

Static createInTitleUnderCaption

  • createInTitleUnderCaption(container: Title): Text
  • Creates and returns a new Text instance in the SDK and on the server. The new Text will be automatically stored in the 'caption' property of the parent documenttemplates.Title element passed as argument.

    Parameters

    Returns Text

Static createInValidationRuleUnderErrorMessage

  • Creates and returns a new Text instance in the SDK and on the server. The new Text will be automatically stored in the 'errorMessage' property of the parent domainmodels.ValidationRule element passed as argument.

    Parameters

    Returns Text

Static createInWidgetValidationUnderMessage

  • Creates and returns a new Text instance in the SDK and on the server. The new Text will be automatically stored in the 'message' property of the parent pages.WidgetValidation element passed as argument.

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

    Parameters

    Returns Text

Static createInWidgetValueUnderTranslatableValue

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

    Parameters

    Returns Text

Generated using TypeDoc