Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Text

See: relevant section in reference guide

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private ___translations

___translations: any

container

container: AbstractElement

containerAsAssociationDeleteBehavior

containerAsAssociationDeleteBehavior: AssociationDeleteBehavior

containerAsAttributeWidget

containerAsAttributeWidget: AttributeWidget

containerAsAttributeWidgetWithPlaceholder

containerAsAttributeWidgetWithPlaceholder: AttributeWidgetWithPlaceholder

containerAsBasicReportAggregate

containerAsBasicReportAggregate: BasicReportAggregate

containerAsBasicReportColumn

containerAsBasicReportColumn: BasicReportColumn

containerAsButton

containerAsButton: Button

containerAsClientTemplate

containerAsClientTemplate: ClientTemplate

containerAsConfirmationInfo

containerAsConfirmationInfo: ConfirmationInfo

containerAsControlBarButton

containerAsControlBarButton: ControlBarButton

containerAsDataGridColumn

containerAsDataGridColumn: DataGridColumn

containerAsDataView

containerAsDataView: DataView

containerAsDropDownButtonItem

containerAsDropDownButtonItem: DropDownButtonItem

containerAsEnumerationValue

containerAsEnumerationValue: EnumerationValue

containerAsGridColumn

containerAsGridColumn: GridColumn

containerAsInputWidget

containerAsInputWidget: InputWidget

containerAsLabel

containerAsLabel: Label

containerAsMenuItem

containerAsMenuItem: MenuItem

containerAsMicroflow

containerAsMicroflow: Microflow

containerAsMicroflowSettings

containerAsMicroflowSettings: MicroflowSettings

containerAsPage

containerAsPage: Page

containerAsPageSettings

containerAsPageSettings: PageSettings

containerAsReferenceSelector

containerAsReferenceSelector: ReferenceSelector

containerAsReportButton

containerAsReportButton: ReportButton

containerAsReportChart

containerAsReportChart: ReportChart

containerAsReportChartSeries

containerAsReportChartSeries: ReportChartSeries

containerAsReportDateRangeField

containerAsReportDateRangeField: ReportDateRangeField

containerAsReportDateRangeSelector

containerAsReportDateRangeSelector: ReportDateRangeSelector

containerAsSearchField

containerAsSearchField: SearchField

containerAsStaticLabel

containerAsStaticLabel: StaticLabel

containerAsSystemText

containerAsSystemText: SystemText

containerAsTabPage

containerAsTabPage: TabPage

containerAsTextArea

containerAsTextArea: TextArea

containerAsTextTemplate

containerAsTextTemplate: TextTemplate

containerAsTitle

containerAsTitle: Title

containerAsValidationRule

containerAsValidationRule: ValidationRule

containerAsWidgetValue

containerAsWidgetValue: WidgetValue

id

id: string

isLoaded

isLoaded: boolean

Checks whether all attributes are available ATM

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

model

model: IModel

qualifiedName

qualifiedName: string

Calculates the fully qualified name of this element, by visiting all parents that have $isNamespace set to true.

translations

translations: IList<Translation>

typeName

typeName: string

unit

unit: ModelUnit

versionInfo

versionInfo: StructureVersionInfo

Static typeName

typeName: string

Static versionInfo

versionInfo: StructureVersionInfo

Methods

Protected _scheduleDeltaAfterCreate

  • _scheduleDeltaAfterCreate(delta: IDelta): void

Protected _sendDeleteDelta

  • _sendDeleteDelta(): void

Protected _updateElementsContainer

  • _updateElementsContainer(unit: ModelUnit): void

  • updateElementsContainer recursively sets the unit to which this elements belong During deserialization this is not needed, but if used in the SDK, we only can set the unit once an element is actually added to the tree (buy pushing / assigning it to some part property)

    Parameters

    Returns void

Protected _updateWithJsonImpl

allProperties

deepCopyInto

delete

  • delete(): void

Protected getContainerAs

load

  • load<T>(callback: function, forceRefresh?: boolean): any
  • load<T>(): T

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

    Type parameters

    Parameters

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

        • Parameters

          • elem: T

          Returns void

    • Optional forceRefresh: boolean

    Returns any

  • Type parameters

    Returns T

toJSON

  • toJSON(): Object

traverse

  • traverse(visit: function): void

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.

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

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

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

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