Module text_box Copy item path cursor_position_message_arguments selected_text_message_arguments text_content_message_arguments text_insertion_message_arguments text_range_message_arguments BACKSPACE_AT_CURSOR 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. BACKSPACE_WORD_AT_CURSOR 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. CANCEL_TEXT_COMPOSITION 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. CHARACTER_COUNT_PROPERTY CLEAR_SELECTION In a Text Box node, clears the current text selection. COMMIT_COMPOSITION_TEXT 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. COMPOSITION_TEXT_BACKGROUND_BRUSH_PROPERTY Sets the brush that highlights the text that the user composes using an input method editor (IME). COMPOSITION_TEXT_CHANGED Occurs when the text produced in an Input Method Editor is updated in a Text Box node. COMPOSITION_TEXT_COMMITTED Occurs: COMPOSITION_TEXT_FOREGROUND_BRUSH_PROPERTY Sets the brush for the text that the user composes using an input method editor (IME). COMPOSITION_TEXT_PROPERTY Reports the text that the user composes in the Text Box using an input method editor (IME). CURSOR_MOVED Occurs when the user moves the cursor in a Text Box node. CURSOR_POSITION_PROPERTY Sets the position of the cursor in the text shown in the Text Box node. CURSOR_PREFAB_PROPERTY Sets the prefab template that defines the appearance of the cursor instead of the default cursor. CharacterRemovalMessageArguments CursorPositionMessageArguments DELETE_AT_CURSOR 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. DELETE_SELECTION In a Text Box node, erases any currently selected text. DELETE_TEXT In a Text Box node, deletes the text between given start and end character indexes. DELETE_WORD_AT_CURSOR 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. DISPLAY_TEXT_PROPERTY Reports the text that the Text Box displays. DeleteSelectionMessageArguments ECHO_MODE_PROPERTY Sets how the Text Box node shows text: EDITING_FINISHED Occurs when a Text Box node leaves the editing state after the user modified the text content. EDITING_STARTED Occurs when the user makes the first modification to the text in a Text Box node that is in the editing state. EDIT_MODE_PROPERTY Sets how the Text Box node enters the editing state: ENTERED_EDITING_STATE Occurs when a Text Box node enters the editing state. ENTER_EDITING Makes a Text Box node enter the editing state. EXIT_EDITING Makes a Text Box node leave the editing state. EditingStateChangedMessageArguments HAS_SELECTION_PROPERTY Indicates whether any of the text in the Text Box node is selected. HIDE_TEXT_HINT_WHEN_EDITING_PROPERTY 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. INPUT_METHOD_ACTION Occurs when the user taps the action button on their on-screen keyboard while editing the text in a Text Box node. INPUT_METHOD_ACTION_PROPERTY 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. INPUT_METHOD_AVAILABLE 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. INPUT_METHOD_UNAVAILABLE 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. INPUT_TYPE_PROPERTY 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: INSERT_TEXT In a Text Box node, inserts text at a specified character index. INSERT_TEXT_AT_CURSOR 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. IS_COMPOSING_TEXT_PROPERTY Reports the text composition state of the Text Box node. IS_EDITING_PROPERTY Reports the editing state of the Text Box node. InputMethodActionMessageArguments InputMethodAvailableMessageArguments LEFT_EDITING_STATE Occurs when a Text Box node leaves the editing state MAXIMUM_TEXT_LENGTH_PROPERTY 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. MOVE_CURSOR_BACKWARD In a Text Box node, moves the cursor backward by one character. MOVE_CURSOR_FORWARD In a Text Box node, moves the cursor forward by one character. MOVE_CURSOR_HOME In a Text Box node, moves the cursor ahead of the first character of the text content. MOVE_CURSOR_TO_END In a Text Box node, moves the cursor after the last character of the text content. MOVE_CURSOR_TO_NEXT_WORD In a Text Box node, moves the cursor forward to the next word boundary. MOVE_CURSOR_TO_PREVIOUS_WORD In a Text Box node, moves the cursor backward to the previous word boundary. MOVE_SELECTION_END_BACKWARD In a Text Box node, moves the handle at the end of text selection backward by one character. MOVE_SELECTION_END_FORWARD In a Text Box node, moves the handle at the end of text selection forward by one character. MOVE_SELECTION_END_TO_NEXT_WORD In a Text Box node, moves the handle at the end of text selection forward to the start of the next word. MOVE_SELECTION_END_TO_PREVIOUS_WORD In a Text Box node, moves the handle at the end of text selection backward to the start of the previous word. MOVE_SELECTION_START_BACKWARD In a Text Box node, moves the handle at the beginning of text selection backward by one character. MOVE_SELECTION_START_FORWARD In a Text Box node, moves the handle at the beginning of text selection forward by one character. MOVE_SELECTION_START_TO_NEXT_WORD In a Text Box node, moves the handle at the beginning of text selection forward to the start of the next word. MOVE_SELECTION_START_TO_PREVIOUS_WORD In a Text Box node, moves the handle at the beginning of text selection backward to the start of the previous word. ModifyEditingStateMessageArguments ModifySelectionMessageArguments MoveCursorMessageArguments PASSWORD_ECHO_TIMEOUT_PROPERTY 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. PASSWORD_MASKING_CHARACTER_PROPERTY When the Echo Mode property is set to Password , this property sets the character that masks each character that the application user enters. READ_ONLY_PROPERTY 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. SELECTION_BACKGROUND_BRUSH_PROPERTY Sets the brush that highlights the selected text. SELECTION_CHANGED Occurs when the user changes the text selection in a Text Box node. SELECTION_CLEARED Occurs when the user clears or resets the text selection in a Text Box node. SELECTION_END_CURSOR_POSITION_PROPERTY The position of the cursor that marks the end of text selection in the Text Box node. SELECTION_END_PREFAB_PROPERTY Sets the prefab template that defines the appearance of the selection handle at the end of text selection instead of the default handle. SELECTION_FOREGROUND_BRUSH_PROPERTY Sets the brush for the selected text. SELECTION_STARTED Occurs when the user starts selecting text in a Text Box node. SELECTION_START_CURSOR_POSITION_PROPERTY The position of the cursor that marks the beginning of text selection in the Text Box node. SELECTION_START_PREFAB_PROPERTY Sets the prefab template that defines the appearance of the selection handle at the beginning of text selection instead of the default handle. SELECT_ALL In a Text Box node, selects all text. SELECT_TEXT In a Text Box node, selects the text between given start and end character indexes. SELECT_TO_END In a Text Box node, selects the text from the cursor position to the end of the text. SELECT_TO_HOME In a Text Box node, selects the text from the start of the text to the cursor position. SELECT_WORD_AT_CURSOR In a Text Box node, selects the word at the cursor position. SelectedTextMessageArguments TEXT_CHANGED Occurs when the user changes the text in a Text Box node. TEXT_COMPOSITION_CANCELED Occurs: TEXT_HINT_PREFAB_PROPERTY Sets the prefab template for showing placeholder content when the Text Box node is empty. TEXT_KEY_NAVIGATION_DIRECTION_PROPERTY Sets the text key navigation direction. TextBoxConcept TextChangedMessageArguments TextCompositionStateMessageArguments TextContentMessageArguments TextInsertionMessageArguments TextRangeMessageArguments WORD_COUNT_PROPERTY EditMode The edit modes. ITextBoxConcept Use the Text %Box nodes to add single-line text input to your application. Use TextBox3D to add text
input in 3D space and TextBox2D to add text input in 2D space.