1. Epic GamesDeveloper
  3. UMultiLineEditableTextBox

UMultiLineEditableTextBox

Allows a user to enter multiple lines of text

API > API/Runtime > API/Runtime/UMG

Allows a user to enter multiple lines of text

   
Name UMultiLineEditableTextBox
Type class
Header File /Engine/Source/Runtime/UMG/Public/Components/MultiLineEditableTextBox.h
Include Path #include "Components/MultiLineEditableTextBox.h"

Syntax

UCLASS (Meta=(DisplayName="Text Box (Multi-Line)"), MinimalAPI)  
class UMultiLineEditableTextBox : public UTextLayoutWidget

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UMultiLineEditableTextBox ( const FObjectInitializer& ObjectInitializer
)

   Components/MultiLineEditableTextBox.h  

Classes

Name Remarks
FOnMultiLineEditableTextBoxChangedEvent  
FOnMultiLineEditableTextBoxCommittedEvent  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AllowContextMenu bool Whether the context menu can be opened Components/MultiLineEditableTextBox.h
  • EditAnywhere
  • Category=Behavior
  • AdvancedDisplay
bIsReadOnly bool Sets the Text as Readonly to prevent it from being modified interactively by the user Components/MultiLineEditableTextBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter=GetIsReadOnly
  • Setter=SetIsReadOnly
  • Category=Appearance
HintText FText Hint text that appears when there is no text in the text box Components/MultiLineEditableTextBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • BlueprintGetter="GetHintText"
  • BlueprintSetter="SetHintText"
  • Category=Content
  • Meta=(MultiLine="true")
HintTextDelegate FGetText A bindable delegate to allow logic to drive the hint text of the widget Components/MultiLineEditableTextBox.h  
OnTextChanged FOnMultiLineEditableTextBoxChangedEvent Called whenever the text is changed programmatically or interactively by the user Components/MultiLineEditableTextBox.h
  • BlueprintAssignable
  • Category="Widget Event"
  • Meta=(DisplayName="OnTextChanged (Multi-Line Text Box)")
OnTextCommitted FOnMultiLineEditableTextBoxCommittedEvent Called whenever the text is committed. Components/MultiLineEditableTextBox.h
  • BlueprintAssignable
  • Category="Widget Event"
  • Meta=(DisplayName="OnTextCommitted (Multi-Line Text Box)")
Text FText The text content for this editable text box widget Components/MultiLineEditableTextBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • BlueprintGetter="GetText"
  • BlueprintSetter="SetText"
  • FieldNotify
  • Category=Content
  • Meta=(MultiLine="true")
VirtualKeyboardDismissAction EVirtualKeyboardDismissAction What action should be taken when the virtual keyboard is dismissed? Components/MultiLineEditableTextBox.h
  • EditAnywhere
  • Category=Behavior
  • AdvancedDisplay
VirtualKeyboardOptions FVirtualKeyboardOptions Additional options to be used by the virtual keyboard summoned from this widget Components/MultiLineEditableTextBox.h
  • EditAnywhere
  • Category=Behavior
  • AdvancedDisplay
WidgetStyle FEditableTextBoxStyle The style Components/MultiLineEditableTextBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Style"
  • Meta=(DisplayName="Style")

Protected

Name Type Remarks Include Path Unreal Specifiers
bIsFontDeprecationDone bool   Components/MultiLineEditableTextBox.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

FText GetHintText()

 Returns the Hint text that appears when there is no text in the text box Components/MultiLineEditableTextBox.h
  • BlueprintCallable
  • Category="Widget"
  • Meta=(DisplayName="GetHintText (Multi-Line Text Box)")

bool GetIsReadOnly()

 Return true when this text cannot be modified interactively by the user Components/MultiLineEditableTextBox.h  

FText GetText()

 Provide a alternative mechanism for error reporting. Gets the widget text Components/MultiLineEditableTextBox.h
  • BlueprintCallable
  • Category="Widget"
  • Meta=(DisplayName="GetText (Multi-Line Text Box)")

void SetError ( FText InError
)

   Components/MultiLineEditableTextBox.h
  • BlueprintCallable
  • Category="Widget"
  • Meta=(DisplayName="SetError (Multi-Line Text Box)")

void SetForegroundColor ( FLinearColor color
)

   Components/MultiLineEditableTextBox.h
  • BlueprintCallable
  • Category="Widget"
  • Meta=(DisplayName="SetForegroundColor (Multi-Line Text Box)")

void SetHintText ( FText InHintText
)

 Sets the Hint text that appears when there is no text in the text box Components/MultiLineEditableTextBox.h
  • BlueprintCallable
  • Category="Widget"
  • Meta=(DisplayName="SetHintText (Multi-Line Text Box)")

void SetIsReadOnly ( bool bReadOnly
)

 Sets the Text as Readonly to prevent it from being modified interactively by the user Components/MultiLineEditableTextBox.h
  • BlueprintCallable
  • Category="Widget"
  • Meta=(DisplayName="SetIsReadOnly (Multi-Line Text Box)")

void SetText ( FText InText
)

 Directly sets the widget text. Components/MultiLineEditableTextBox.h
  • BlueprintCallable
  • Category="Widget"
  • Meta=(DisplayName="SetText (Multi-Line Text Box)")

void SetTextStyle ( const FTextBlockStyle& InTextStyle
)

   Components/MultiLineEditableTextBox.h
  • BlueprintCallable
  • Category="Widget"
  • Meta=(DisplayName="SetTextStyle (Multi-Line Text Box)")

Overridden from UWidget

Name Remarks Include Path Unreal Specifiers

virtual const FText GetPaletteCategory()

 Gets the palette category of the widget Components/MultiLineEditableTextBox.h  

virtual void SynchronizeProperties()

 TODO UMG Add Set ReadOnlyForegroundColor TODO UMG Add Set BackgroundColor TODO UMG Add Set Font Components/MultiLineEditableTextBox.h  

Overridden from UVisual

Name Remarks Include Path Unreal Specifiers

virtual void ReleaseSlateResources ( bool bReleaseChildren
)

   Components/MultiLineEditableTextBox.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void Serialize ( FArchive& Ar
)

   Components/MultiLineEditableTextBox.h  

Protected

Name Remarks Include Path Unreal Specifiers

void HandleOnTextChanged ( const FText& Text
)

   Components/MultiLineEditableTextBox.h  

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

   Components/MultiLineEditableTextBox.h  

FText K2_Gate_HintText()

   Components/MultiLineEditableTextBox.h  

Overridden from UTextLayoutWidget

Name Remarks Include Path Unreal Specifiers

virtual void OnApplyLineHeightToBottomLineChanged ( bool InApplyLineHeightToBottomLine
)

   Components/MultiLineEditableTextBox.h  

virtual void OnAutoWrapTextChanged ( bool InAutoWrapText
)

   Components/MultiLineEditableTextBox.h  

virtual void OnJustificationChanged ( ETextJustify::Type InJustification
)

   Components/MultiLineEditableTextBox.h  

virtual void OnLineHeightPercentageChanged ( float InLineHeightPercentage
)

   Components/MultiLineEditableTextBox.h  

virtual void OnMarginChanged ( const FMargin& InMargin
)

   Components/MultiLineEditableTextBox.h  

virtual void OnShapedTextOptionsChanged ( FShapedTextOptions InShapedTextOptions
)

   Components/MultiLineEditableTextBox.h  

virtual void OnWrappingPolicyChanged ( ETextWrappingPolicy InWrappingPolicy
)

   Components/MultiLineEditableTextBox.h  

virtual void OnWrapTextAtChanged ( float InWrapTextAt
)

   Components/MultiLineEditableTextBox.h  

Overridden from UWidget

Name Remarks Include Path Unreal Specifiers

virtual TSharedRef< SWidget > RebuildWidget()

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

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
TextStyle_DEPRECATED FTextBlockStyle The text style Components/MultiLineEditableTextBox.h
  • Meta=(DisplayName="Text Style")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page