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 > Plugins > CommonUI > UCommonTextBlock

Light Theme

Dark Theme

UCommonTextBlock

Text block with automatic scrolling for FX / large texts, also supports a larger set of default styling, & custom mobile scaling.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UVisual

UWidget

UTextLayoutWidget

UTextBlock

UCommonTextBlock

	UCommonDateTimeTextBlock
	UCommonNumericTextBlock

References

Module	CommonUI
Header	/Engine/Plugins/Experimental/CommonUI/Source/CommonUI/Public/CommonTextBlock.h
Include	#include "CommonTextBlock.h"

Syntax

UCLASS(Config=CommonUI, defaultconfig, ClassGroup=UI,
Meta=(Category="Common UI", DisplayName="Common Text", prioritizeCategories="Content"))
class UCommonTextBlock : public UTextBlock

Remarks

Text block with automatic scrolling for FX / large texts, also supports a larger set of default styling, & custom mobile scaling.

Constructors

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

Functions

		Name	Description
	void	ResetScrollState()
	void	SetStyle ( TSubclassOf< UCommonTextStyle > InS... )
	void	SetTextCase ( bool bUseAllCaps )
	void	SetWrapTextWidth ( int32 InWrapTextAt )

Overridden from UTextBlock

		Name	Description
	void	SetText ( FText InText )	Directly sets the widget text.

Overridden from UWidget

	Name	Description
const FText	GetPaletteCategory()	Gets the palette category of the widget
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	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.