Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

Properties

id: string
structureTypeName: string
structureTypeName: string = "Texts$Text"
versionInfo: StructureVersionInfo = ...

Accessors

  • get container(): TContainer
  • Returns TContainer

  • get containerAsBottomBarItem(): BottomBarItem
  • Returns BottomBarItem

  • get containerAsButton(): Button
  • get containerAsLabel(): Label
  • get containerAsMasterDetailDetailRegion(): MasterDetailDetailRegion
  • Returns MasterDetailDetailRegion

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

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

    Returns boolean

  • get model(): TModel
  • Returns TModel

Methods

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

  • delete(): void
  • Deletes this element from the model.

    Returns void

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

    Returns Text

  • getContainerAs<T>(containerType: any): T
  • load(callback: (elem: Text) => void, forceRefresh?: boolean): void
  • load(forceRefresh?: boolean): Promise<Text>
  • 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: (elem: Text) => void
        • Parameters

          Returns void

    • Optional forceRefresh: boolean

    Returns void

  • Parameters

    • Optional forceRefresh: boolean

    Returns Promise<Text>

  • toJSON(): IStructureJSON
  • Renders the structure as plain JSON (without observables magic). This is intended for debugging and development convenience. Note that the resulting object is not of the interface type corresponding to this structure.

    Returns IStructureJSON

  • traverse(visit: (structure: IStructure) => void): void
  • Traverses this structure by calling the provided visitor function on itself and all the structures contained (as part) by it, in depth-first order, and it returns synchronously after that.

    Parameters

    Returns void

  • traverseFind<T>(visit: (structure: IStructure) => T): null | T
  • Traverses this structure, returning immediately when visit returns something other than null.

    Type parameters

    • T

    Parameters

    Returns null | T

  • traversePublicParts(visit: (structure: IStructure) => void): void
  • create(model: IModel): Text
  • 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

    • model: IModel

    Returns Text

  • 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

  • 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

  • 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

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

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

    Parameters

    Returns 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 reports.BasicReportAggregate element passed as argument.

    Parameters

    Returns 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 reports.BasicReportColumn element passed as argument.

    Parameters

    Returns Text

  • createInBottomBarItemUnderCaption(container: BottomBarItem): 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 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

    • container: BottomBarItem

    Returns Text

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • createInMasterDetailDetailRegionUnderTitle(container: MasterDetailDetailRegion): 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.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

    • container: MasterDetailDetailRegion

    Returns Text

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

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

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

    Parameters

    Returns Text

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

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

    Parameters

    Returns Text

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

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

    Parameters

    Returns 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 reports.ReportDateRangeField element passed as argument.

    Parameters

    Returns Text

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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