MultilineTextBox Typescript API

Interface

MultilineTextBox

Defines a multi-line text input control. MultilineTextBox can hold an unlimited number of characters, and the text renders in a fixed-width font

Selector

smart-multiline-text-box

Properties

animationAnimation

Sets or gets the animation mode. Animation is disabled when the property is set to 'none'

Default valueadvanced

autoCapitalizeMultilineTextBoxAutoCapitalize

Determines whether and how the value should be automatically capitalized as it is entered/edited by the user.

Default valuenone

autoCompleteAutoComplete

Determines whether the value of the control can be automatically completed by the browser.

Default valueoff

autoFocusboolean

Determines whether the input should be focused when the page is loaded.

Default valuefalse

colsnumber

The cols attribute specifies the visible width of a input. If it is specified, it must be a positive integer. If it is not specified, the default value is 20.

Default value20

disabledboolean

Enables or disables the element.

Default valuefalse

displayModeTextBoxDisplayMode

Specifies how the characters are displayed inside the input.

Default valuedefault

enterKeyBehaviorMultilineTextBoxEnterKeyBehavior

Determines the behavior on "Enter" key.

Default valuenewLine

formstring

The form element that the element is associated with (its "form owner"). The value of the attribute must be the ID of a form element in the same document.

Default value"

hintany

Sets additional helper text below the element. Appears only when the element is focused.

horizontalScrollBarVisibilityHorizontalScrollBarVisibility

Controls horizontal scrollbar's visibility.

Default valueauto

inputPurposestring

Sets the purpose of the input and what, if any, permission the user agent has to provide automated assistance in filling out the element's input when in a form, as well as guidance to the browser as to the type of information expected in the element. This value corresponds to the standard HTML autocomplete attribute and can be set to values such as 'on', 'name', 'organization', 'street-address', etc.

Default value"off

labelstring

Sets label above the element. The label is displayed above the input and it's always visible.

Default value"

localestring

Sets or gets the language. Used in conjunction with the property messages.

Default value"en

localizeFormatFunctionany

Callback used to customize the format of the messages that are returned from the Localization Module.

maxLengthnumber

Sets or gets the maximum number of characters that the user can enter.

minLengthnumber

Sets or gets the minimum number of characters that the user can enter.

Default value0

messagesany

Sets or gets an object specifying strings used in the widget that can be localized. Used in conjunction with the property locale.

Default value


"en": {

"propertyUnknownType": "'{{name}}' property is with undefined 'type' member!",

"propertyInvalidValue": "Invalid '{{name}}' property value! Actual value: {{actualValue}}, Expected value: {{value}}!",

"propertyInvalidValueType": "Invalid '{{name}}' property value type! Actual type: {{actualType}}, Expected type: {{type}}!",

"elementNotInDOM": "Element does not exist in DOM! Please, add the element to the DOM, before invoking a method.",

"moduleUndefined": "Module is undefined.",

"missingReference": "{{elementType}}: Missing reference to {{files}}.",

"htmlTemplateNotSuported": "{{elementType}}: Browser doesn't support HTMLTemplate elements.",

"invalidTemplate": "{{elementType}}: '{{property}}' property accepts a string that must match the id of an HTMLTemplate element from the DOM.",

"invalidNode": "{{elementType}}: Invalid parameter '{{node}}' when calling {{method}}."

}


namestring

Sets or gets the name attribute for the element. Name is used when submiting HTML forms.

Default value"

placeholderstring

The placeholder text that is displayed when no value is applied to the element.

Default value"

readonlyboolean

If enabled the users cannot iteract with the element.

Default valuefalse

requiredboolean

Specifies that the user must fill in a value before submitting a form that contains the element.

Default valuefalse

resizableboolean

Enables/ disables the resizing of the element. If enabled a resizing indicator appears in the bottom corner of the input area.

Default valuefalse

rightToLeftboolean

Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts.

Default valuefalse

rowsnumber

The number of visible text lines for the control.

Default value5

selectAllOnFocusboolean

Specifies whether the content of the input will be selected on focus.

Default valuefalse

selectionEndnumber

Indicates the index of the last character in the current selection.

Default value0

selectionStartnumber

Indicates the index to the first character in the current selection.

Default value0

spellCheckboolean

Specifies whether the element is to have its spelling and grammar checked or not.

Default valuefalse

themestring

Determines the theme. Theme defines the look of the element

Default value"

unfocusableboolean

If is set to true, the element cannot be focused.

Default valuefalse

valuestring

Sets or gets the value of the element.

Default value"

verticalScrollBarVisibilityVerticalScrollBarVisibility

Controls vertical scrollbar's visibility.

Default valueauto

wrapMultilineTextBoxWrap

Indicates how the control wraps text.

Default valuesoft

onchange((this: Window, ev: Event) => any) | null

This event is triggered when the value of the text box is changed.

Arguments

evEvent
ev.detailObject
ev.detail.oldValue - The previous value of the element before it was changed.
ev.detail.value - The new value of the element.
ev.detail.type - Indicates when the element was called, e.g. on blur or submit.

Methods

focus(): void

Focuses the element.


reset(): void

The method is used to reset the value of the element box to it's initial state.


selection( displayMode: string): string

Returns the currenctly selected text.

Arguments

displayModestring

If displayMode is set to 'escaped', the value returned from the method contains escaped special characters.

Returnsstring

select( rangeFrom?: any, rangeTo?: any): void

Selects a certain part of the input text. If no arguments are specified the whole text will be selected.

Arguments

rangeFrom?any

Determines the start index of the text selection.

rangeTo?any

Determines the end index of the text selection.



Enums

Animation

None Simple Advanced

AutoComplete

On Off

HorizontalScrollBarVisibility

Auto Disabled Hidden Visible

MultilineTextBoxAutoCapitalize

None Characters Words

MultilineTextBoxEnterKeyBehavior

ClearOnSubmit NewLine Submit

MultilineTextBoxWrap

Hard Soft Off

TextBoxDisplayMode

Default Escaped

VerticalScrollBarVisibility

Auto Disabled Hidden Visible