Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

UMultiLineEditableTextBox

Allows a user to enter multiple lines of text

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UVisual

UWidget

UTextLayoutWidget

UMultiLineEditableTextBox

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

	Name	Description
bool	AllowContextMenu	Whether the context menu can be opened
bool	bIsReadOnly	Sets whether this text block can be modified interactively by the user
FText	HintText	Hint text that appears when there is no text in the text box
FGetText	HintTextDelegate	A bindable delegate to allow logic to drive the hint text of the widget
FText	K2_Cache_HintText
TSharedPtr< SMu...	MyEditableTextBlock
FOnMultiLineEdi...	OnTextChanged	Called whenever the text is changed programmatically or interactively by the user
FOnMultiLineEdi...	OnTextCommitted	Called whenever the text is committed.
FText	Text	The text content for this editable text box widget
FTextBlockStyle	TextStyle	The text style
EVirtualKeyboar...	VirtualKeyboardDismissAction	What action should be taken when the virtual keyboard is dismissed?
FVirtualKeyboar...	VirtualKeyboardOptions	Additional options to be used by the virtual keyboard summoned from this widget
FEditableTextBo...	WidgetStyle	The style

Constructors

	Name	Description
	UMultiLineEditableTextBox ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
FText	GetHintText()
FText	GetText()	Provide a alternative mechanism for error reporting.
void	HandleOnTextChanged ( const FText& Text )
void	HandleOnTextCommitted ( const FText& Text, ETextCommit::Type CommitMethod )
FText	K2_Gate_HintText()
void	SetError ( FText InError )
void	SetForegroundColor ( FLinearColor color )
void	SetHintText ( FText InHintText )
void	SetIsReadOnly ( bool bReadOnly )
void	SetText ( FText InText )
void	SetTextStyle ( const FTextBlockStyle& InTextStyle )

Overridden from UTextLayoutWidget

		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

	Name	Description
const FText	GetPaletteCategory()	Gets the palette category of the widget
TSharedRef< ...	RebuildWidget()	Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.
void	SynchronizeProperties()	Applies all properties to the native widget if possible.

Overridden from UVisual

		Name	Description
	void	ReleaseSlateResources ( bool bReleaseChildren )

Overridden from UObject

		Name	Description
	void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.

Classes

	Name	Description
	FOnMultiLineEditableTextBoxChangedEvent
	FOnMultiLineEditableTextBoxCommittedEvent

Deprecated Variables

	Name	Description
FLinearColor	BackgroundColor_DEPRECATED	The color of the background/border around the editable text (overrides Style)
FSlateFontInfo	Font_DEPRECATED	Font color and opacity (overrides Style)
FLinearColor	ForegroundColor_DEPRECATED	Text color and opacity (overrides Style)
FLinearColor	ReadOnlyForegroundColor_DEPRECATED	Text color and opacity when read-only (overrides Style)
TObjectPtr< USl...	Style_DEPRECATED