Reports the text that the Text Box displays.

Reports the text that the user composes in the Text Box using an input method editor (IME).

Sets the brush that highlights the selected text.

Sets the brush for the selected text.

Sets the brush that highlights the text that the user composes using an input method editor (IME).

Sets the brush for the text that the user composes using an input method editor (IME).

Sets the position of the cursor in the text shown in the Text Box node.

The position of the cursor that marks the beginning of text selection in the Text Box node.

The position of the cursor that marks the end of text selection in the Text Box node.

Indicates whether any of the text in the Text Box node is selected.

Sets whether the Text Box node is editable. When you enable this property, you can set the text only through the Text property and the user cannot edit the text in the Text Box node.

Sets the maximum length of text that the user can insert in the Text Box node. The unit is a UTF-8 character and the buffer byte length can be greater for multi-byte characters.

Sets the prefab template that defines the appearance of the cursor instead of the default cursor.

Sets the prefab template that defines the appearance of the selection handle at the beginning of text selection instead of the default handle.

Sets the prefab template that defines the appearance of the selection handle at the end of text selection instead of the default handle.

Sets the prefab template for showing placeholder content when the Text Box node is empty.

Sets whether to hide the placeholder content, which you set using the Text Hint Prefab property, when the Text Box node is in the editing state. To hide the placeholder content only when the user enters text in the Text Box node, disable this property.

Sets how the Text Box node shows text:

• Normal makes the inserted characters visible.
• No Echo makes the inserted characters invisible.
• Password makes the inserted character visible for a certain amount of time and then masks the character. Use the Password Masking Character property to set the masking character. The default is a bullet symbol. Use the Password Echo Timeout property to set the time in milliseconds that an inserted character is visible before masking.

Sets the input type of the input methods that provide the input layout to let the user enter and edit text of specific type in the Text Box node:

• Default for the default input type of the input method editor
• Numeric for numbers
• Email for email addresses
• URL for URL addresses

Sets how the Text Box node enters the editing state:

• Automatic makes the Text Box enter the editing state when focused, and leave the editing state when focus is lost.
• Triggered requires the user to trigger the Text Box to enter and leave the editing state.

Reports the editing state of the Text Box node.

Reports the text composition state of the Text Box node.

When the Echo Mode property is set to Password, this property sets the time in milliseconds that an inserted character is visible before being masked.

When the Echo Mode property is set to Password, this property sets the character that masks each character that the application user enters.

Sets the label of the user action button on the on-screen keyboard for this Text Box. By default uses the label of the default input method of the operating system.

Sets the text key navigation direction.

Occurs when an input method becomes available to a Text Box node. For example, an on-screen keyboard becomes available when it appears on the screen.

Arguments: TextBoxConceptMetadata.InputMethodAvailableMessageArguments

Occurs when the input method that is composing text in a Text Box node becomes unavailable. For example, an on-screen keyboard becomes unavailable when the user hides it.

Arguments: TextBoxConceptMetadata.InputMethodAvailableMessageArguments

Occurs when the user moves the cursor in a Text Box node.

Arguments: TextBoxConceptMetadata.CursorPositionMessageArguments

Occurs when the user changes the text in a Text Box node.

Arguments: TextBoxConceptMetadata.TextChangedMessageArguments

Occurs when the user changes the text selection in a Text Box node.

Arguments: TextBoxConceptMetadata.SelectedTextMessageArguments

Occurs when the user starts selecting text in a Text Box node.

Arguments: TextBoxConceptMetadata.SelectedTextMessageArguments

Occurs when the user clears or resets the text selection in a Text Box node.

Arguments: TextBoxConceptMetadata.CursorPositionMessageArguments

Occurs when the user makes the first modification to the text in a Text Box node that is in the editing state.

Arguments: TextBoxConceptMetadata.TextChangedMessageArguments

Occurs when a Text Box node leaves the editing state after the user modified the text content.

Arguments: TextBoxConceptMetadata.TextChangedMessageArguments

Occurs when the text produced in an Input Method Editor is updated in a Text Box node.

Arguments: TextBoxConceptMetadata.TextCompositionStateMessageArguments

Occurs:

• When the text composition in a Text Box node is canceled by Input Method that is in text composition state.
• When a trigger executes the Text Box: Cancel Text Composition action.

Arguments: TextBoxConceptMetadata.TextCompositionStateMessageArguments

Occurs:

• When the text produced in an Input Method Editor is committed to the cached text in a Text Box node.
• When a trigger executes the Text Box: Commit Composition Text action.

Arguments: TextBoxConceptMetadata.TextCompositionStateMessageArguments

Occurs when a Text Box node enters the editing state.

Arguments: TextBoxConceptMetadata.EditingStateChangedMessageArguments

Occurs when a Text Box node leaves the editing state

Arguments: TextBoxConceptMetadata.EditingStateChangedMessageArguments

Occurs when the user taps the action button on their on-screen keyboard while editing the text in a Text Box node.

Arguments: TextBoxConceptMetadata.InputMethodActionMessageArguments

In a Text Box node, adds text at the cursor position. Set the value of the Text property to the text that you want to add.

Arguments: TextBoxConceptMetadata.TextContentMessageArguments

In a Text Box node, deletes a character using backspace. For example, in text that uses a left-to-right script it deletes the character on the left side of the cursor.

Arguments: TextBoxMetadata.CharacterRemovalMessageArguments

In a Text Box node, deletes the characters until the next word boundary using backspace. For example, in text that uses a left-to-right script it deletes the characters between the cursor position and the closest word boundary on the left side of the cursor.

Arguments: TextBoxMetadata.CharacterRemovalMessageArguments

In a Text Box node, deletes a character using delete. For example, in text that uses a left-to-right script it deletes the character on the right side of the cursor.

Arguments: TextBoxMetadata.CharacterRemovalMessageArguments

In a Text Box node, deletes the characters until the next word boundary using delete. For example, in text that uses a left-to-right script it deletes the characters between the cursor position and the closest word boundary on the right side of the cursor.

Arguments: TextBoxMetadata.CharacterRemovalMessageArguments

In a Text Box node, moves the cursor backward by one character.

Arguments: TextBoxMetadata.MoveCursorMessageArguments

In a Text Box node, moves the cursor forward by one character.

Arguments: TextBoxMetadata.MoveCursorMessageArguments

In a Text Box node, moves the cursor backward to the previous word boundary.

Arguments: TextBoxMetadata.MoveCursorMessageArguments

In a Text Box node, moves the cursor forward to the next word boundary.

Arguments: TextBoxMetadata.MoveCursorMessageArguments

In a Text Box node, moves the cursor ahead of the first character of the text content.

Arguments: TextBoxMetadata.MoveCursorMessageArguments

In a Text Box node, moves the cursor after the last character of the text content.

Arguments: TextBoxMetadata.MoveCursorMessageArguments

In a Text Box node, moves the handle at the beginning of text selection forward by one character.

Arguments: TextBoxMetadata.ModifySelectionMessageArguments

In a Text Box node, moves the handle at the beginning of text selection backward by one character.

Arguments: TextBoxMetadata.ModifySelectionMessageArguments

In a Text Box node, moves the handle at the beginning of text selection forward to the start of the next word.

Arguments: TextBoxMetadata.ModifySelectionMessageArguments

In a Text Box node, moves the handle at the beginning of text selection backward to the start of the previous word.

Arguments: TextBoxMetadata.ModifySelectionMessageArguments

In a Text Box node, moves the handle at the end of text selection forward by one character.

Arguments: TextBoxMetadata.ModifySelectionMessageArguments

In a Text Box node, moves the handle at the end of text selection backward by one character.

Arguments: TextBoxMetadata.ModifySelectionMessageArguments

In a Text Box node, moves the handle at the end of text selection forward to the start of the next word.

Arguments: TextBoxMetadata.ModifySelectionMessageArguments

In a Text Box node, moves the handle at the end of text selection backward to the start of the previous word.

Arguments: TextBoxMetadata.ModifySelectionMessageArguments

In a Text Box node, selects the text between given start and end character indexes.

Arguments: TextBoxConceptMetadata.TextRangeMessageArguments

In a Text Box node, deletes the text between given start and end character indexes.

Arguments: TextBoxConceptMetadata.TextRangeMessageArguments

In a Text Box node, erases any currently selected text.

Arguments: TextBoxMetadata.DeleteSelectionMessageArguments

In a Text Box node, inserts text at a specified character index.

Arguments: TextBoxConceptMetadata.TextInsertionMessageArguments

In a Text Box node, selects the text from the start of the text to the cursor position.

Arguments: TextBoxMetadata.ModifySelectionMessageArguments

In a Text Box node, selects the text from the cursor position to the end of the text.

Arguments: TextBoxMetadata.ModifySelectionMessageArguments

In a Text Box node, clears the current text selection.

Arguments: TextBoxMetadata.ModifySelectionMessageArguments

In a Text Box node, selects all text.

Arguments: TextBoxMetadata.ModifySelectionMessageArguments

In a Text Box node, selects the word at the cursor position.

Arguments: TextBoxMetadata.ModifySelectionMessageArguments

Makes a Text Box node enter the editing state.

Arguments: TextBoxMetadata.ModifyEditingStateMessageArguments

Makes a Text Box node leave the editing state.

Arguments: TextBoxMetadata.ModifyEditingStateMessageArguments

Commits to a Text Box node the text composed in an Input Method Editor. This action works only when the Text Box node, which the action targets, is in the editing state.

Arguments: TextBoxConceptMetadata.TextCompositionStateMessageArguments

Discards the text composed in an Input Method Editor. This action works only when the Text Box node, which the action targets, is in the editing state.

Arguments: TextBoxConceptMetadata.TextCompositionStateMessageArguments

Contains the current position of the cursor.

Example

local value = arguments:getCursorPositionProperty()
arguments:setCursorPositionProperty(value)

Contains the index of the character in the beginning of the text selection.

Example

local value = arguments:getSelectionStartProperty()
arguments:setSelectionStartProperty(value)

Contains the end index of the selection.

Example

local value = arguments:getSelectionEndProperty()
arguments:setSelectionEndProperty(value)

Contains the content of a Text Box node.

Example

local value = arguments:getTextFieldContentProperty()
arguments:setTextFieldContentProperty(value)

The character index at which to insert text.

Example

local value = arguments:getPositionProperty()
arguments:setPositionProperty(value)

Sets the text to insert in the Text Box node.

Example

local value = arguments:getTextProperty()
arguments:setTextProperty(value)

Sets the index of the first character in the text range.

Example

local value = arguments:getStartPositionProperty()
arguments:setStartPositionProperty(value)

Sets the index of the last character in the text range.

Example

local value = arguments:getEndPositionProperty()
arguments:setEndPositionProperty(value)