1. Epic GamesDeveloper
  3. UMultiLineEditableTextBox

UMultiLineEditableTextBox

Allows a user to enter multiple lines of text

API > API/Runtime > API/Runtime/UMG > API/Runtime/UMG/Components

Inheritance Hierarchy

References

   
Module UMG
Header /Engine/Source/Runtime/UMG/Public/Components/MultiLineEditableTextBox.h
Include #include "Components/MultiLineEditableTextBox.h"

Syntax

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

Remarks

Allows a user to enter multiple lines of text

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, AdvancedDisplay bool AllowContextMenu Whether the context menu can be opened
Public variable UProperty Category, EditAnywhere BlueprintReadWrite getter, setter bool bIsReadOnly Sets the Text as Readonly to prevent it from being modified interactively by the user
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite blueprintgetter, blueprintsetter, getter, setter FText HintText Hint text that appears when there is no text in the text box
Public variable UProperty 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< SMultiLineEditableTextBox > MyEditableTextBlock  
Public variable UProperty Category, Meta BlueprintAssignable FOnMultiLineEditableTextBoxChangedEvent OnTextChanged Called whenever the text is changed programmatically or interactively by the user
Public variable UProperty Category, Meta BlueprintAssignable FOnMultiLineEditableTextBoxCommittedEvent OnTextCommitted Called whenever the text is committed.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite blueprintgetter, blueprintsetter, fieldnotify, getter, setter FText Text The text content for this editable text box widget
Public variable UProperty Category, EditAnywhere, AdvancedDisplay EVirtualKeyboardDismissAction VirtualKeyboardDismissAction What action should be taken when the virtual keyboard is dismissed?
Public variable UProperty Category, EditAnywhere, AdvancedDisplay FVirtualKeyboardOptions VirtualKeyboardOptions Additional options to be used by the virtual keyboard summoned from this widget
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FEditableTextBoxStyle WidgetStyle The style

Constructors

  Type Name Description
Public function  

UMultiLineEditableTextBox ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Const UFunction BlueprintCallable, Category, Meta FText Returns the Hint text that appears when there is no text in the text box
Public function Const bool Return true when this text cannot be modified interactively by the user
Public function Const UFunction BlueprintCallable, Category, Meta FText

GetText ()

 Provide a alternative mechanism for error reporting. Gets the widget text
Protected function void

HandleOnTextChanged ( const FText& Text
)

  
Protected function void

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

  
Protected function FText  
Public function Virtual void

Serialize ( FArchive& Ar
)

  
Public function UFunction BlueprintCallable, Category, Meta void

SetError ( FText InError
)

  
Public function UFunction BlueprintCallable, Category, Meta void

SetForegroundColor ( FLinearColor color
)

  
Public function UFunction BlueprintCallable, Category, Meta void

SetHintText ( FText InHintText
)

 Sets the Hint text that appears when there is no text in the text box
Public function UFunction BlueprintCallable, Category, Meta void

SetIsReadOnly ( UPARAM(DisplayName="ReadyOnly") bool bReadOnly
)

 Sets the Text as Readonly to prevent it from being modified interactively by the user
Public function UFunction BlueprintCallable, Category, Meta void

SetText ( FText InText
)

 Directly sets the widget text.
Public function UFunction BlueprintCallable, Category, Meta void

SetTextStyle ( const FTextBlockStyle& InTextStyle
)

  

Overridden from UTextLayoutWidget

  Type Name Description
Protected function Virtual void

OnApplyLineHeightToBottomLineChanged ( bool InApplyLineHeightToBottomLine
)

  
Protected function Virtual void

OnAutoWrapTextChanged ( bool InAutoWrapText
)

  
Protected function Virtual void

OnJustificationChanged ( ETextJustify::Type InJustification
)

  
Protected function Virtual void

OnLineHeightPercentageChanged ( float InLineHeightPercentage
)

  
Protected function Virtual void

OnMarginChanged ( const FMargin& InMargin
)

  
Protected function Virtual void  
Protected function Virtual void

OnWrappingPolicyChanged ( ETextWrappingPolicy InWrappingPolicy
)

  
Protected function Virtual void

OnWrapTextAtChanged ( float InWrapTextAt
)

  

Overridden from UWidget

  Type Name Description
Public function Virtual const FText Gets the palette category of the widget
Protected function Virtual TSharedRef< SWidget > Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.
Public function Virtual void TODO UMG Add Set ReadOnlyForegroundColor TODO UMG Add Set BackgroundColor TODO UMG Add Set Font

Overridden from UVisual

  Type Name Description
Public function Virtual void

ReleaseSlateResources ( bool bReleaseChildren
)

  

Classes

  Type Name Description
Public class FOnMultiLineEditableTextBoxChangedEvent    
Public class FOnMultiLineEditableTextBoxCommittedEvent    

Deprecated Variables

  Type Name Description
Public variable UProperty Meta FTextBlockStyle TextStyle_DEPRECATED The text style

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page