TextBox3DMetadata Interface Reference
Metadata definitions for TextBox3D. More...
Inheritance diagram for TextBox3DMetadata:
Public Attributes | |
| DynamicPropertyType< ColorRGBA > | CompositionBackgroundColorProperty |
| Sets the color that highlights the text that the user composes using an input method editor (IME). | |
| DynamicPropertyType< ColorRGBA > | CompositionFontColorProperty |
| Sets the color of the text that the user composes using an input method editor (IME). | |
| AbstractMetaclass | metaclass = new AbstractMetaclass("Kanzi.TextBox3D") |
| Metaclass for TextBox3D. | |
| DynamicPropertyType< ColorRGBA > | SelectionBackgroundColorProperty |
| Sets the color that highlights the selected text. | |
| DynamicPropertyType< ColorRGBA > | SelectionFontColorProperty |
| Sets the color of the selected text. | |
 Public Attributes inherited from Node3DMetadata | |
| DynamicPropertyType< Matrix4x4 > | FinalTransformationProperty |
| The combined location, orientation and scale of the node and its ancestor nodes. | |
| DynamicPropertyType< Float > | FrustumCullMarginProperty |
| The margin of the frustum cull radius of the node. | |
| DynamicPropertyType< SRTValue3D > | LayoutTransformationProperty |
| The location, orientation and scale of the node relative to its parent node. | |
| AbstractMetaclass | metaclass = new AbstractMetaclass("Kanzi.Node3D") |
| Metaclass for Node3D. | |
| DynamicPropertyType< SRTValue3D > | RenderTransformationProperty |
| The location, orientation, and scale of the node relative to its parent node. | |
| Public Attributes inherited from NodeMetadata | |
| DynamicPropertyType< Float > | ActualDepthProperty |
| The calculated size of the node in depth direction when used in a layout. | |
| DynamicPropertyType< Float > | ActualHeightProperty |
| The calculated height of the node when used in a layout. | |
| DynamicPropertyType< Float > | ActualWidthProperty |
| The calculated width of the node when used in a layout. | |
| DynamicPropertyType< Boolean > | ClipChildrenProperty |
| Sets whether to clip the child nodes of this node. | |
| DynamicPropertyType< NodeEnums.ContentStretch > | ContentStretchProperty |
| Sets how the content that belongs to this node is stretched (as opposed to manipulating the actual node size). | |
| DynamicPropertyType< Boolean > | CreatedFromKZBProperty |
| Kanzi internally uses this property to distinguish objects like bindings and triggers created in code from objects that are loaded from a kzb file. | |
| DynamicPropertyType< NodeEnums.DepthAlignment > | DepthAlignmentProperty |
| The alignment in depth direction the node should use when it resides under a layout. | |
| DynamicPropertyType< Vector2 > | DepthMarginProperty |
| Sets the depth distance between this node and other nodes that are adjacent to this node in a layout. | |
| DynamicPropertyType< Float > | DepthProperty = new DynamicPropertyType<>("Node.Depth", Float.class) |
| The size of the node in depth direction when used in a layout. | |
| DynamicPropertyType< Boolean > | EffectivelyEnabledProperty |
| Indicates whether this node and its ancestor nodes are enabled. | |
| DynamicPropertyType< Boolean > | EnabledProperty |
| Whether this node is enabled. | |
| DynamicPropertyType< Boolean > | FocusableProperty |
| Indicates whether the node can receive focus. | |
| DynamicPropertyType< Boolean > | FocusedProperty |
| Indicates whether the node has the key focus. | |
| DynamicPropertyType< FocusState > | FocusStateProperty |
| Reports the focus state of a node: | |
| DynamicPropertyType< Resource > | FontFamilyProperty |
| The font family used to render the text. | |
| DynamicPropertyType< Float > | HeightProperty |
| The height of the node when used in a layout. | |
| DynamicPropertyType< Boolean > | HitTestableContainerProperty |
| When enabled, Kanzi uses the layout bounds as geometry for hit testing. | |
| DynamicPropertyType< Boolean > | HitTestableProperty |
| When enabled, the node can be hit tested. | |
| DynamicPropertyType< NodeEnums.HorizontalAlignment > | HorizontalAlignmentProperty |
| The alignment in horizontal direction the node should use when it resides under a layout. | |
| DynamicPropertyType< Vector2 > | HorizontalMarginProperty |
| Sets the horizontal space between this node and other nodes that are adjacent to this node in a layout. | |
| DynamicPropertyType< Boolean > | HoverProperty |
| Indicates whether a node is the foremost hit testable node under the cursor. | |
| DynamicPropertyType< String > | LocaleProperty |
| The locale of the node. | |
| AbstractMetaclass | metaclass = new AbstractMetaclass("Kanzi.Node") |
| Metaclass for Node. | |
| DynamicPropertyType< String > | NameProperty = new DynamicPropertyType<>("Node.Name", String.class) |
| Node name. | |
| DynamicPropertyType< Float > | OpacityProperty |
| Opacity of the node. | |
| DynamicPropertyType< String > | PathProperty = new DynamicPropertyType<>("Node.Path", String.class) |
| Full path to the node. | |
| DynamicPropertyType< Float > | Projection2DTo3DScaleProperty |
| Sets the scale factor to project pixels to 3D size. | |
| DynamicPropertyType< Resource > | StateManagerProperty |
| Sets the State Manager to the node. | |
| DynamicPropertyType< Resource > | StyleProperty |
| Sets a style to the node. | |
| DynamicPropertyType< NodeEnums.VerticalAlignment > | VerticalAlignmentProperty |
| The alignment in vertical direction the node should use when it resides under a layout. | |
| DynamicPropertyType< Vector2 > | VerticalMarginProperty |
| Sets the vertical space between this node and other nodes that are adjacent to this node in a layout. | |
| DynamicPropertyType< Float > | VisibleAmountInParentProperty |
| Sets the amount the node is inside its parent. | |
| DynamicPropertyType< Boolean > | VisibleProperty |
| When disabled, Kanzi does not render the node. | |
| DynamicPropertyType< Float > | WidthProperty = new DynamicPropertyType<>("Node.Width", Float.class) |
| The width of the node when used in a layout. | |
| Public Attributes inherited from TextConceptMetadata | |
| DynamicPropertyType< ColorRGBA > | FontColorProperty |
| Sets the color of the text in a 3D text node. | |
| DynamicPropertyType< Resource > | FontMaterialProperty |
| Sets the material whose shader is used to render the text. | |
| DynamicPropertyType< Boolean > | HorizontalFitProperty |
| Whether to horizontally scale the glyphs to make them fit into the Layout Width of the Text Block. | |
| DynamicPropertyType< Vector2 > | HorizontalFitScaleLimitsProperty |
| When the Horizontal Fit property is enabled, sets the minimum and maximum scale for glyphs when the width of text in a Text Block does not match the Layout Width of that Text Block. | |
| DynamicPropertyType< Vector2 > | HorizontalPaddingProperty |
| Sets the padding spaces between the content and the left and right boundaries of the Text node. | |
| AbstractMetaclass | metaclass = new AbstractMetaclass("Kanzi.TextConcept") |
| Metaclass for TextConcept. | |
| DynamicPropertyType< String > | OverflowProperty |
| Sets the characters that represent the truncated text when the text does not fit in this node. | |
| DynamicPropertyType< Boolean > | RemoveSideBearingsProperty |
| Whether to position the leftmost characters of left-aligned text and rightmost characters of right-aligned text exactly within the boundary of the text node. | |
| DynamicPropertyType< TextFormatEnums.TextHorizontalAlignment > | TextHorizontalAlignmentProperty |
| Sets the horizontal alignment of the text. | |
| DynamicPropertyType< String > | TextProperty |
| Sets the text content that the text node renders. | |
| DynamicPropertyType< TextFormatEnums.TextVerticalAlignment > | TextVerticalAlignmentProperty |
| Sets the vertical alignment of the text. | |
| DynamicPropertyType< TextFormatEnums.TruncationDirection > | TruncationDirectionProperty |
| Sets which part Kanzi truncates when either the Truncation or Overflow property is set and the text does not fit in this node: | |
| DynamicPropertyType< TextFormatEnums.Truncation > | TruncationProperty |
| Sets how Kanzi truncates text when either Truncation or Overflow property is set and the text does not fit in this node: | |
| DynamicPropertyType< Vector2 > | VerticalPaddingProperty |
| Sets the padding spaces between the content and the top and bottom boundaries of the Text node. | |
| Public Attributes inherited from TextBoxConceptMetadata | |
| DynamicMessageType< TextBoxMetadata.CharacterRemovalMessageArguments > | BackspaceAtCursorMessage |
| In a Text Box node, deletes a character using backspace. | |
| DynamicMessageType< TextBoxMetadata.CharacterRemovalMessageArguments > | BackspaceWordAtCursorMessage |
| In a Text Box node, deletes the characters until the next word boundary using backspace. | |
| DynamicMessageType< TextBoxConceptMetadata.TextCompositionStateMessageArguments > | CancelTextCompositionMessage |
| Discards the text composed in an Input Method Editor. | |
| DynamicPropertyType< Integer > | CharacterCountProperty |
| DynamicMessageType< TextBoxMetadata.ModifySelectionMessageArguments > | ClearSelectionMessage |
| In a Text Box node, clears the current text selection. | |
| DynamicMessageType< TextBoxConceptMetadata.TextCompositionStateMessageArguments > | CommitCompositionTextMessage |
| Commits to a Text Box node the text composed in an Input Method Editor. | |
| DynamicPropertyType< Resource > | CompositionTextBackgroundBrushProperty |
| Sets the brush that highlights the text that the user composes using an input method editor (IME). | |
| DynamicMessageType< TextBoxConceptMetadata.TextCompositionStateMessageArguments > | CompositionTextChangedMessage |
| Occurs when the text produced in an Input Method Editor is updated in a Text Box node. | |
| DynamicMessageType< TextBoxConceptMetadata.TextCompositionStateMessageArguments > | CompositionTextCommittedMessage |
| Occurs: | |
| DynamicPropertyType< Resource > | CompositionTextForegroundBrushProperty |
| Sets the brush for the text that the user composes using an input method editor (IME). | |
| DynamicPropertyType< String > | CompositionTextProperty |
| Reports the text that the user composes in the Text Box using an input method editor (IME). | |
| DynamicMessageType< TextBoxConceptMetadata.CursorPositionMessageArguments > | CursorMovedMessage |
| Occurs when the user moves the cursor in a Text Box node. | |
| DynamicPropertyType< Integer > | CursorPositionProperty |
| Sets the position of the cursor in the text shown in the Text Box node. | |
| DynamicPropertyType< Resource > | CursorPrefabProperty |
| Sets the prefab template that defines the appearance of the cursor instead of the default cursor. | |
| DynamicMessageType< TextBoxMetadata.CharacterRemovalMessageArguments > | DeleteAtCursorMessage |
| In a Text Box node, deletes a character using delete. | |
| DynamicMessageType< TextBoxMetadata.DeleteSelectionMessageArguments > | DeleteSelectionMessage |
| In a Text Box node, erases any currently selected text. | |
| DynamicMessageType< TextBoxConceptMetadata.TextRangeMessageArguments > | DeleteTextMessage |
| In a Text Box node, deletes the text between given start and end character indexes. | |
| DynamicMessageType< TextBoxMetadata.CharacterRemovalMessageArguments > | DeleteWordAtCursorMessage |
| In a Text Box node, deletes the characters until the next word boundary using delete. | |
| DynamicPropertyType< String > | DisplayTextProperty |
| Reports the text that the Text Box displays. | |
| DynamicPropertyType< EchoMode > | EchoModeProperty |
| Sets how the Text Box node shows text: | |
| DynamicMessageType< TextBoxConceptMetadata.TextChangedMessageArguments > | EditingFinishedMessage |
| Occurs when a Text Box node leaves the editing state after the user modified the text content. | |
| DynamicMessageType< TextBoxConceptMetadata.TextChangedMessageArguments > | EditingStartedMessage |
| Occurs when the user makes the first modification to the text in a Text Box node that is in the editing state. | |
| DynamicPropertyType< TextBoxConceptEnums.EditMode > | EditModeProperty |
| Sets how the Text Box node enters the editing state: | |
| DynamicMessageType< TextBoxConceptMetadata.EditingStateChangedMessageArguments > | EnteredEditingStateMessage |
| Occurs when a Text Box node enters the editing state. | |
| DynamicMessageType< TextBoxMetadata.ModifyEditingStateMessageArguments > | EnterEditingMessage |
| Makes a Text Box node enter the editing state. | |
| DynamicMessageType< TextBoxMetadata.ModifyEditingStateMessageArguments > | ExitEditingMessage |
| Makes a Text Box node leave the editing state. | |
| DynamicPropertyType< Boolean > | HasSelectionProperty |
| Indicates whether any of the text in the Text Box node is selected. | |
| DynamicPropertyType< Boolean > | HideTextHintWhenEditingProperty |
| 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. | |
| DynamicMessageType< TextBoxConceptMetadata.InputMethodActionMessageArguments > | InputMethodActionMessage |
| Occurs when the user taps the action button on their on-screen keyboard while editing the text in a Text Box node. | |
| DynamicPropertyType< InputMethodAction > | InputMethodActionProperty |
| Sets the label of the user action button on the on-screen keyboard for this Text Box. | |
| DynamicMessageType< TextBoxConceptMetadata.InputMethodAvailableMessageArguments > | InputMethodAvailableMessage |
| Occurs when an input method becomes available to a Text Box node. | |
| DynamicMessageType< TextBoxConceptMetadata.InputMethodAvailableMessageArguments > | InputMethodUnavailableMessage |
| Occurs when the input method that is composing text in a Text Box node becomes unavailable. | |
| DynamicPropertyType< InputType > | InputTypeProperty |
| 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: | |
| DynamicMessageType< TextBoxConceptMetadata.TextContentMessageArguments > | InsertTextAtCursorMessage |
| In a Text Box node, adds text at the cursor position. | |
| DynamicMessageType< TextBoxConceptMetadata.TextInsertionMessageArguments > | InsertTextMessage |
| In a Text Box node, inserts text at a specified character index. | |
| DynamicPropertyType< Boolean > | IsComposingTextProperty |
| Reports the text composition state of the Text Box node. | |
| DynamicPropertyType< Boolean > | IsEditingProperty |
| Reports the editing state of the Text Box node. | |
| DynamicMessageType< TextBoxConceptMetadata.EditingStateChangedMessageArguments > | LeftEditingStateMessage |
| Occurs when a Text Box node leaves the editing state. | |
| DynamicPropertyType< Integer > | MaximumTextLengthProperty |
| Sets the maximum length of text that the user can insert in the Text Box node. | |
| AbstractMetaclass | metaclass = new AbstractMetaclass("Kanzi.TextBoxConcept") |
| Metaclass for TextBoxConcept. | |
| DynamicMessageType< TextBoxMetadata.MoveCursorMessageArguments > | MoveCursorBackwardMessage |
| In a Text Box node, moves the cursor backward by one character. | |
| DynamicMessageType< TextBoxMetadata.MoveCursorMessageArguments > | MoveCursorForwardMessage |
| In a Text Box node, moves the cursor forward by one character. | |
| DynamicMessageType< TextBoxMetadata.MoveCursorMessageArguments > | MoveCursorHomeMessage |
| In a Text Box node, moves the cursor ahead of the first character of the text content. | |
| DynamicMessageType< TextBoxMetadata.MoveCursorMessageArguments > | MoveCursorToEndMessage |
| In a Text Box node, moves the cursor after the last character of the text content. | |
| DynamicMessageType< TextBoxMetadata.MoveCursorMessageArguments > | MoveCursorToNextWordMessage |
| In a Text Box node, moves the cursor forward to the next word boundary. | |
| DynamicMessageType< TextBoxMetadata.MoveCursorMessageArguments > | MoveCursorToPreviousWordMessage |
| In a Text Box node, moves the cursor backward to the previous word boundary. | |
| DynamicMessageType< TextBoxMetadata.ModifySelectionMessageArguments > | MoveSelectionEndBackwardMessage |
| In a Text Box node, moves the handle at the end of text selection backward by one character. | |
| DynamicMessageType< TextBoxMetadata.ModifySelectionMessageArguments > | MoveSelectionEndForwardMessage |
| In a Text Box node, moves the handle at the end of text selection forward by one character. | |
| DynamicMessageType< TextBoxMetadata.ModifySelectionMessageArguments > | MoveSelectionEndToNextWordMessage |
| In a Text Box node, moves the handle at the end of text selection forward to the start of the next word. | |
| DynamicMessageType< TextBoxMetadata.ModifySelectionMessageArguments > | MoveSelectionEndToPreviousWordMessage |
| In a Text Box node, moves the handle at the end of text selection backward to the start of the previous word. | |
| DynamicMessageType< TextBoxMetadata.ModifySelectionMessageArguments > | MoveSelectionStartBackwardMessage |
| In a Text Box node, moves the handle at the beginning of text selection backward by one character. | |
| DynamicMessageType< TextBoxMetadata.ModifySelectionMessageArguments > | MoveSelectionStartForwardMessage |
| In a Text Box node, moves the handle at the beginning of text selection forward by one character. | |
| DynamicMessageType< TextBoxMetadata.ModifySelectionMessageArguments > | MoveSelectionStartToNextWordMessage |
| In a Text Box node, moves the handle at the beginning of text selection forward to the start of the next word. | |
| DynamicMessageType< TextBoxMetadata.ModifySelectionMessageArguments > | MoveSelectionStartToPreviousWordMessage |
| In a Text Box node, moves the handle at the beginning of text selection backward to the start of the previous word. | |
| DynamicPropertyType< Integer > | PasswordEchoTimeoutProperty |
| 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. | |
| DynamicPropertyType< String > | PasswordMaskingCharacterProperty |
| When the Echo Mode property is set to Password, this property sets the character that masks each character that the application user enters. | |
| DynamicPropertyType< Boolean > | ReadOnlyProperty |
| Sets whether the Text Box node is editable. | |
| DynamicMessageType< TextBoxMetadata.ModifySelectionMessageArguments > | SelectAllMessage |
| In a Text Box node, selects all text. | |
| DynamicPropertyType< Resource > | SelectionBackgroundBrushProperty |
| Sets the brush that highlights the selected text. | |
| DynamicMessageType< TextBoxConceptMetadata.SelectedTextMessageArguments > | SelectionChangedMessage |
| Occurs when the user changes the text selection in a Text Box node. | |
| DynamicMessageType< TextBoxConceptMetadata.CursorPositionMessageArguments > | SelectionClearedMessage |
| Occurs when the user clears or resets the text selection in a Text Box node. | |
| DynamicPropertyType< Integer > | SelectionEndCursorPositionProperty |
| The position of the cursor that marks the end of text selection in the Text Box node. | |
| DynamicPropertyType< Resource > | SelectionEndPrefabProperty |
| Sets the prefab template that defines the appearance of the selection handle at the end of text selection instead of the default handle. | |
| DynamicPropertyType< Resource > | SelectionForegroundBrushProperty |
| Sets the brush for the selected text. | |
| DynamicPropertyType< Integer > | SelectionStartCursorPositionProperty |
| The position of the cursor that marks the beginning of text selection in the Text Box node. | |
| DynamicMessageType< TextBoxConceptMetadata.SelectedTextMessageArguments > | SelectionStartedMessage |
| Occurs when the user starts selecting text in a Text Box node. | |
| DynamicPropertyType< Resource > | SelectionStartPrefabProperty |
| Sets the prefab template that defines the appearance of the selection handle at the beginning of text selection instead of the default handle. | |
| DynamicMessageType< TextBoxConceptMetadata.TextRangeMessageArguments > | SelectTextMessage |
| In a Text Box node, selects the text between given start and end character indexes. | |
| DynamicMessageType< TextBoxMetadata.ModifySelectionMessageArguments > | SelectToEndMessage |
| In a Text Box node, selects the text from the cursor position to the end of the text. | |
| DynamicMessageType< TextBoxMetadata.ModifySelectionMessageArguments > | SelectToHomeMessage |
| In a Text Box node, selects the text from the start of the text to the cursor position. | |
| DynamicMessageType< TextBoxMetadata.ModifySelectionMessageArguments > | SelectWordAtCursorMessage |
| In a Text Box node, selects the word at the cursor position. | |
| DynamicMessageType< TextBoxConceptMetadata.TextChangedMessageArguments > | TextChangedMessage |
| Occurs when the user changes the text in a Text Box node. | |
| DynamicMessageType< TextBoxConceptMetadata.TextCompositionStateMessageArguments > | TextCompositionCanceledMessage |
| Occurs: | |
| DynamicPropertyType< Resource > | TextHintPrefabProperty |
| Sets the prefab template for showing placeholder content when the Text Box node is empty. | |
| DynamicPropertyType< TextKeyNavigationDirection > | TextKeyNavigationDirectionProperty |
| Sets the text key navigation direction. | |
| DynamicPropertyType< Integer > | WordCountProperty |
| Public Attributes inherited from FontStyleConceptMetadata | |
| DynamicPropertyType< Float > | CharacterSpacingProperty |
| Sets the character spacing in pixels. | |
| DynamicPropertyType< Float > | FixedCharacterWidthProperty |
| When set, overrides the font advance widths to make each character take a fixed amount of space specified in pixels. | |
| DynamicPropertyType< FontHintingPreference > | FontHintingPreferenceProperty |
| Sets the hinting preference of the font. | |
| DynamicPropertyType< Boolean > | FractionalCharacterWidthProperty |
| Sets whether Kanzi uses fractional or rounded character widths to lay out text. | |
| DynamicPropertyType< Float > | LineSpacingProperty |
| Sets the line spacing in multiples of the normal line height of the selected font. | |
| AbstractMetaclass | metaclass = new AbstractMetaclass("Kanzi.FontStyleConcept") |
| Metaclass for FontStyleConcept. | |
| DynamicPropertyType< Float > | SizeProperty |
| Sets the size of the font in pixels. | |
| DynamicPropertyType< Boolean > | SnapCharacterToPixelPropertyProperty |
| Sets whether Kanzi positions characters in 2D rendering to the nearest pixel: | |
| DynamicPropertyType< FontStyle > | StyleProperty |
| Sets the style of the font. | |
| DynamicPropertyType< FontWeight > | WeightProperty |
| Sets the weight of the font. | |
Detailed Description
Metadata definitions for TextBox3D.
Member Data Documentation
◆ CompositionBackgroundColorProperty
| DynamicPropertyType<ColorRGBA> CompositionBackgroundColorProperty |
Initial value:
=
new DynamicPropertyType<>("TextBox3D.CompositionBackgroundColor", ColorRGBA.class)
Sets the color that highlights the text that the user composes using an input method editor (IME).
◆ CompositionFontColorProperty
| DynamicPropertyType<ColorRGBA> CompositionFontColorProperty |
Initial value:
=
new DynamicPropertyType<>("TextBox3D.CompositionFontColor", ColorRGBA.class)
Sets the color of the text that the user composes using an input method editor (IME).
◆ SelectionBackgroundColorProperty
| DynamicPropertyType<ColorRGBA> SelectionBackgroundColorProperty |
Initial value:
=
new DynamicPropertyType<>("TextBox3D.SelectionBackgroundColor", ColorRGBA.class)
Sets the color that highlights the selected text.
◆ SelectionFontColorProperty
| DynamicPropertyType<ColorRGBA> SelectionFontColorProperty |
Initial value:
=
new DynamicPropertyType<>("TextBox3D.SelectionFontColor", ColorRGBA.class)
Sets the color of the selected text.