Navigation
API > API/Runtime > API/Runtime/UMG > API/Runtime/UMG/Components
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UVisual
- UWidget
- UTextLayoutWidget
- UMultiLineEditableTextBox
- UEditorUtilityMultiLineEditableTextBox
References
| Module | UMG |
| Header | /Engine/Source/Runtime/UMG/Public/Components/MultiLineEditableTextBox.h |
| Include | #include "Components/MultiLineEditableTextBox.h" |
Syntax
class UMultiLineEditableTextBox : public UTextLayoutWidget
Remarks
Allows a user to enter multiple lines of text
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
bool | AllowContextMenu | Whether the context menu can be opened |
 |
FGetText | HintTextDelegate | A bindable delegate to allow logic to drive the hint text of the widget |
 |
FText | K2_Cache_HintText | |
 |
TSharedPtr< SMultiLineEditableTextBox > | MyEditableTextBlock | |
 |
FOnMultiLineEditableTextBoxChangedEvent | OnTextChanged | Called whenever the text is changed programmatically or interactively by the user |
 |
FOnMultiLineEditableTextBoxCommittedEvent | OnTextCommitted | Called whenever the text is committed. |
 |
EVirtualKeyboardDismissAction | VirtualKeyboardDismissAction | What action should be taken when the virtual keyboard is dismissed? |
 |
FVirtualKeyboardOptions | VirtualKeyboardOptions | Additional options to be used by the virtual keyboard summoned from this widget |
 |
FEditableTextBoxStyle | WidgetStyle | The style |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
UMultiLineEditableTextBox
(
const FObjectInitializer& ObjectInitializer |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
FText | GetHintText () |
Returns the Hint text that appears when there is no text in the text box |
  |
bool | Return true when this text cannot be modified interactively by the user | |
  |
FText | GetText () |
Provide a alternative mechanism for error reporting. Gets the widget text |
 |
void | HandleOnTextChanged
(
const FText& Text |
|
 |
void | HandleOnTextCommitted
(
const FText& Text, |
|
 |
FText | ||
 |
void | ||
 |
void | SetForegroundColor
(
FLinearColor color |
|
 |
void | SetHintText
(
FText InHintText |
Sets the Hint text that appears when there is no text in the text box |
 |
void | SetIsReadOnly
(
bool bReadOnly |
Sets the Text as Readonly to prevent it from being modified interactively by the user |
 |
void | Directly sets the widget text. | |
 |
void | SetTextStyle
(
const FTextBlockStyle& InTextStyle |
Overridden from UTextLayoutWidget
| Type | Name | Description | |
|---|---|---|---|
  |
void | SetJustification
(
ETextJustify::Type InJustification |
TODO UMG Add Set ReadOnlyForegroundColor TODO UMG Add Set BackgroundColor TODO UMG Add Set Font |
Overridden from UWidget
| Type | Name | Description | |
|---|---|---|---|
  |
const FText | Gets the palette category of the widget | |
  |
TSharedRef< SWidget > | Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed. | |
  |
void | Applies all properties to the native widget if possible. |
Overridden from UVisual
| Type | Name | Description | |
|---|---|---|---|
  |
void | ReleaseSlateResources
(
bool bReleaseChildren |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
  |
void | Handles reading, writing, and reference collecting using FArchive. |
Classes
| Type | Name | Description | |
|---|---|---|---|
 |
FOnMultiLineEditableTextBoxChangedEvent | ||
 |
FOnMultiLineEditableTextBoxCommittedEvent |
Deprecated Variables
| Type | Name | Description | |
|---|---|---|---|
 |
bool | bIsReadOnly | Direct access to IsReadOnly is deprecated. Please use the getter or setter. |
 |
FText | HintText | Direct access to HintText is deprecated. Please use the getter or setter. |
 |
FText | Text | Direct access to Text is deprecated. Please use the getter or setter. |
 |
FTextBlockStyle | TextStyle_DEPRECATED | TextStyle has been deprecated as it was mainly duplicated information already available inside WidgetStyle. Please use the WidgetStyle.TextStyle instead. |