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

> Unreal Engine API Reference > Runtime > UMG > Components > UTextBlock

Light Theme

Dark Theme

UTextBlock

A simple static text widget. No Children Text

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UVisual

UWidget

UTextLayoutWidget

UTextBlock

UCommonTextBlock

	UCommonDateTimeTextBlock
	UCommonNumericTextBlock

References

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

Syntax

class UTextBlock : public UTextLayoutWidget

Remarks

A simple static text widget.

No Children Text

Variables

	Name	Description
bool	bSimpleTextMode	If this is enabled, text shaping, wrapping, justification are disabled in favor of much faster text layout and measurement.
bool	bWrapWithInvalidationPanel	If true, it will automatically wrap this text widget with an invalidation panel
FSlateColor	ColorAndOpacity	The color of the text
FGetSlateColor	ColorAndOpacityDelegate	A bindable delegate for the ColorAndOpacity.
FSlateFontInfo	Font	The font to render the text with
FSlateColor	K2_Cache_ColorAndOpacity
FLinearColor	K2_Cache_ShadowColorAndOpacity
FText	K2_Cache_Text
float	MinDesiredWidth	The minimum desired size for the text
TSharedPtr< STe...	MyTextBlock
FLinearColor	ShadowColorAndOpacity	The color of the shadow
FGetLinearColor	ShadowColorAndOpacityDelegate	A bindable delegate for the ShadowColorAndOpacity.
FVector2D	ShadowOffset	The direction the shadow is cast
FSlateBrush	StrikeBrush	The brush to strike through text with
FText	Text	The text to display
FGetText	TextDelegate	A bindable delegate to allow logic to drive the text of the widget
ETextTransformP...	TextTransformPolicy	The text transformation policy to apply to this text block

Constructors

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

Functions

	Name	Description
TAttribute< ...	GetDisplayText()	Get the text that should be displayed in the internal Slate widget (allows flags to mutate the display text without modifying the persistent designer property data)
UMaterialIns...	GetDynamicFontMaterial()
UMaterialIns...	GetDynamicOutlineMaterial()
FText	GetText()	Gets the widget text
EVisibility	GetTextWarningImageVisibility()
void	HandleTextCommitted ( const FText& InText, ETextCommit::Type CommitteType )
FSlateColor	K2_Gate_ColorAndOpacity()
FLinearColor	K2_Gate_ShadowColorAndOpacity()
FText	K2_Gate_Text()
void	SetAutoWrapText ( bool InAutoTextWrap )	Set the auto wrap for this text block.
void	SetColorAndOpacity ( FSlateColor InColorAndOpacity )	Sets the color and opacity of the text in this text block
void	SetFont ( FSlateFontInfo InFontInfo )	Dynamically set the font info for this text block
void	SetMinDesiredWidth ( float InMinDesiredWidth )	Set the minimum desired width for this text block
void	SetOpacity ( float InOpacity )	Sets the opacity of the text in this text block
void	SetShadowColorAndOpacity ( FLinearColor InShadowColorAndOpacit... )	Sets the color and opacity of the text drop shadow if opacity is zero no shadow will be drawn
void	SetShadowOffset ( FVector2D InShadowOffset )	Sets the offset that the text drop shadow should be drawn at
void	SetStrikeBrush ( FSlateBrush InStrikeBrush )	Dynamically set the strike brush for this text block
void	SetText ( FText InText )	Directly sets the widget text.
void	SetTextTransformPolicy ( ETextTransformPolicy InTransformPol... )	Set the text transformation policy for this text block.

Overridden from UTextLayoutWidget

		Name	Description
	void	SetJustification ( ETextJustify::Type InJustification )

Overridden from UWidget

	Name	Description
TSharedPtr< ...	GetAccessibleWidget()	Gets the widget that accessibility properties should synchronize to.
FString	GetLabelMetadata()	Get Label Metadata, which may be as simple as a bit of string data to help identify an anonymous text block.
const FText	GetPaletteCategory()	Gets the palette category of the widget
void	OnBindingChanged ( const FName& Property )
void	OnCreationFromPalette()	Called by the palette after constructing a new widget, allows the widget to perform interesting default setup that we don't want to be UObject Defaults.
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
	bool	CanEditChange ( const FProperty* InProperty )	Called by the editor to query whether a property of this object is allowed to be modified.
	void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.

Deprecated Variables

		Name	Description
	bool	bAutoWrapText_DEPRECATED	Whether the text should automatically wrap

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

Take our survey

Dismiss