UMultiLineEditableTextBox

Allows a user to enter multiple lines of text

Windows
MacOS
Linux

Inheritance Hierarchy

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

Public variable

bool

 

AllowContextMenu

Whether the context menu can be opened

Public variable

bool

 

bIsReadOnly

Sets whether this text block can be modified interactively by the user

Public variable

FText

 

HintText

Hint text that appears when there is no text in the text box

Public variable

FGetText

 

HintTextDelegate

A bindable delegate to allow logic to drive the hint text of the widget

Protected variable

FText

 

K2_Cache_HintText

Protected variable

TSharedPtr< SMu...

 

MyEditableTextBlock

Public variable

FOnMultiLineEdi...

 

OnTextChanged

Called whenever the text is changed programmatically or interactively by the user

Public variable

FOnMultiLineEdi...

 

OnTextCommitted

Called whenever the text is committed.

Public variable

FText

 

Text

The text content for this editable text box widget

Public variable

FTextBlockStyle

 

TextStyle

The text style

Public variable

EVirtualKeyboar...

 

VirtualKeyboardDismissAction

What action should be taken when the virtual keyboard is dismissed?

Public variable

FVirtualKeyboar...

 

VirtualKeyboardOptions

Additional options to be used by the virtual keyboard summoned from this widget

Public variable

FEditableTextBo...

 

WidgetStyle

The style

Constructors

Name Description

Public function

UMultiLineEditableTextBox

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Const

FText

 

GetHintText()

Public function Const

FText

 

GetText()

Provide a alternative mechanism for error reporting.

Protected function

void

 

HandleOnTextChanged

(
    const FText& Text
)

Protected function

void

 

HandleOnTextCommitted

(
    const FText& Text,
    ETextCommit::Type CommitMethod
)

Protected function

FText

 

K2_Gate_HintText()

Public function

void

 

SetError

(
    FText InError
)

Public function

void

 

SetHintText

(
    FText InHintText
)

Public function

void

 

SetIsReadOnly

(
    bool bReadOnly
)

Public function

void

 

SetText

(
    FText InText
)

Public function

void

 

SetTextStyle

(
    const FTextBlockStyle& InTextStyle
)

Overridden from UTextLayoutWidget

Name Description

Public function Virtual

void

 

SetJustification

(
    ETextJustify::Type InJustification
)

TODO UMG Add Set ReadOnlyForegroundColor TODO UMG Add Set BackgroundColor TODO UMG Add Set ForegroundColor TODO UMG Add Set Font

Overridden from UWidget

Name Description

Public function Virtual

const FText

 

GetPaletteCategory()

Gets the palette category of the widget

Protected function Virtual

TSharedRef< ...

 

RebuildWidget()

Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.

Public function Virtual

void

 

SynchronizeProperties()

Applies all properties to the native widget if possible.

Overridden from UVisual

Name Description

Public function Virtual

void

 

ReleaseSlateResources

(
    bool bReleaseChildren
)

Overridden from UObject

Name Description

Public function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.

Classes

Deprecated Variables

Name Description

Public variable

FLinearColor

 

BackgroundColor_DEPRECATED

The color of the background/border around the editable text (overrides Style)

Public variable

FSlateFontInfo

 

Font_DEPRECATED

Font color and opacity (overrides Style)

Public variable

FLinearColor

 

ForegroundColor_DEPRECATED

Text color and opacity (overrides Style)

Public variable

FLinearColor

 

ReadOnlyForegroundColor_DEPRECATED

Text color and opacity when read-only (overrides Style)

Public variable

USlateWidgetSty...

 

Style_DEPRECATED
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss