1. Epic GamesDeveloper
  3. UMultiLineEditableText

UMultiLineEditableText

Editable text box widget

API > API/Runtime > API/Runtime/UMG

Editable text box widget

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

Syntax

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

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UMultiLineEditableText ( const FObjectInitializer& ObjectInitializer
)

   Components/MultiLineEditableText.h  

Classes

Name Remarks
FOnMultiLineEditableTextChangedEvent  
FOnMultiLineEditableTextCommittedEvent  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AllowContextMenu bool Whether the context menu can be opened Components/MultiLineEditableText.h
  • EditAnywhere
  • Category=Behavior
  • AdvancedDisplay
bIsReadOnly bool Sets the Text as Readonly to prevent it from being modified interactively by the user Components/MultiLineEditableText.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter=GetIsReadOnly
  • Setter=SetIsReadOnly
  • BlueprintSetter="SetIsReadOnly"
  • Category=Appearance
ClearKeyboardFocusOnCommit bool Whether to clear keyboard focus when pressing enter to commit changes Components/MultiLineEditableText.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • Category=Behavior
  • AdvancedDisplay
ClearTextSelectionOnFocusLoss bool Whether to clear text selection when focus is lost Components/MultiLineEditableText.h
  • EditAnywhere
  • Category=Behavior
  • AdvancedDisplay
HintText FText Hint text that appears when there is no text in the text box Components/MultiLineEditableText.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/MultiLineEditableText.h  
OnTextChanged FOnMultiLineEditableTextChangedEvent Called whenever the text is changed programmatically or interactively by the user Components/MultiLineEditableText.h
  • BlueprintAssignable
  • Category="Widget Event"
  • Meta=(DisplayName="OnTextChanged (Multi-Line Editable Text)")
OnTextCommitted FOnMultiLineEditableTextCommittedEvent Called whenever the text is committed. Components/MultiLineEditableText.h
  • BlueprintAssignable
  • Category="Widget Event"
  • Meta=(DisplayName="OnTextCommitted (Multi-Line Editable Text)")
RevertTextOnEscape bool Whether to allow the user to back out of changes when they press the escape key Components/MultiLineEditableText.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • Category=Behavior
  • AdvancedDisplay
SelectAllTextWhenFocused bool Whether to select all text when the user clicks to give focus on the widget Components/MultiLineEditableText.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • Category=Behavior
  • AdvancedDisplay
Text FText The text content for this editable text box widget Components/MultiLineEditableText.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/MultiLineEditableText.h
  • EditAnywhere
  • Category=Behavior
  • AdvancedDisplay
VirtualKeyboardOptions FVirtualKeyboardOptions Additional options for the virtual keyboard Components/MultiLineEditableText.h
  • EditAnywhere
  • Category=Behavior
  • AdvancedDisplay
WidgetStyle FTextBlockStyle The style Components/MultiLineEditableText.h
  • EditAnywhere
  • BlueprintReadWrite
  • BlueprintSetter=SetWidgetStyle
  • Category="Style"
  • Meta=(ShowOnlyInnerProperties)

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool GetClearKeyboardFocusOnCommit()

 Whether to clear keyboard focus when pressing enter to commit changes Components/MultiLineEditableText.h  

bool GetClearTextSelectionOnFocusLoss()

 Whether to clear text selection when focus is lost Components/MultiLineEditableText.h  

const FSlateFontInfo & GetFont()

   Components/MultiLineEditableText.h
  • BlueprintCallable
  • Category="Appearance"

FText GetHintText()

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

bool GetIsReadOnly()

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

bool GetRevertTextOnEscape()

 Whether to allow the user to back out of changes when they press the escape key Components/MultiLineEditableText.h  

bool GetSelectAllTextWhenFocused()

 Whether to select all text when the user clicks to give focus on the widget Components/MultiLineEditableText.h  

FText GetText()

 Gets the widget text Components/MultiLineEditableText.h
  • BlueprintCallable
  • Category="Widget"
  • Meta=(DisplayName="GetText (Multi-Line Editable Text)")

void SetClearKeyboardFocusOnCommit ( bool bClearKeyboardFocusOnCommit
)

 Set to true to clear keyboard focus when pressing enter to commit changes Components/MultiLineEditableText.h  

void SetClearTextSelectionOnFocusLoss ( bool bClearTextSelectionOnFocusLoss
)

 Set to true to clear text selection when focus is lost Components/MultiLineEditableText.h  

void SetFont ( FSlateFontInfo InFontInfo
)

   Components/MultiLineEditableText.h
  • BlueprintCallable
  • Category="Appearance"

void SetFontMaterial ( UMaterialInterface* InMaterial
)

   Components/MultiLineEditableText.h
  • BlueprintCallable
  • Category="Appearance"

void SetFontOutlineMaterial ( UMaterialInterface* InMaterial
)

   Components/MultiLineEditableText.h
  • BlueprintCallable
  • Category="Appearance"

void SetHintText ( FText InHintText
)

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

void SetIsReadOnly ( bool bReadOnly
)

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

void SetRevertTextOnEscape ( bool bRevertTextOnEscape
)

 Set to true to allow the user to back out of changes when they press the escape key Components/MultiLineEditableText.h  

void SetSelectAllTextWhenFocused ( bool bSelectAllTextWhenFocused
)

 Set to true to select all text when the user clicks to give focus on the widget Components/MultiLineEditableText.h  

void SetText ( FText InText
)

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

void SetWidgetStyle ( const FTextBlockStyle& InWidgetStyle
)

   Components/MultiLineEditableText.h
  • BlueprintSetter

Overridden from UWidget

Name Remarks Include Path Unreal Specifiers

virtual const FText GetPaletteCategory()

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

virtual void SynchronizeProperties ()

 Applies all properties to the native widget if possible. Components/MultiLineEditableText.h  

Overridden from UVisual

Name Remarks Include Path Unreal Specifiers

virtual void ReleaseSlateResources ( bool bReleaseChildren
)

   Components/MultiLineEditableText.h  

Protected

Name Remarks Include Path Unreal Specifiers

void HandleOnTextChanged ( const FText& Text
)

   Components/MultiLineEditableText.h  

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

   Components/MultiLineEditableText.h  

FText K2_Gate_HintText()

   Components/MultiLineEditableText.h  

Overridden from UTextLayoutWidget

Name Remarks Include Path Unreal Specifiers

virtual void OnApplyLineHeightToBottomLineChanged ( bool InApplyLineHeightToBottomLine
)

   Components/MultiLineEditableText.h  

virtual void OnAutoWrapTextChanged ( bool InAutoWrapText
)

   Components/MultiLineEditableText.h  

virtual void OnJustificationChanged ( ETextJustify::Type InJustification
)

   Components/MultiLineEditableText.h  

virtual void OnLineHeightPercentageChanged ( float InLineHeightPercentage
)

   Components/MultiLineEditableText.h  

virtual void OnMarginChanged ( const FMargin& InMargin
)

   Components/MultiLineEditableText.h  

virtual void OnShapedTextOptionsChanged ( FShapedTextOptions InShapedTextOptions
)

   Components/MultiLineEditableText.h  

virtual void OnWrappingPolicyChanged ( ETextWrappingPolicy InWrappingPolicy
)

   Components/MultiLineEditableText.h  

virtual void OnWrapTextAtChanged ( float InWrapTextAt
)

   Components/MultiLineEditableText.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/MultiLineEditableText.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page