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

Light Theme

Dark Theme

UCommonRichTextBlock

Text block that supports custom scaling for mobile platforms, with option to only show icons if space is sparse.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UVisual

UWidget

UTextLayoutWidget

URichTextBlock

UCommonRichTextBlock

References

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

Syntax

UCLASS()
class UCommonRichTextBlock : public URichTextBlock

Remarks

Text block that supports custom scaling for mobile platforms, with option to only show icons if space is sparse.

Variables

		Name	Description
	bool	bTintInlineIcon	Toggle it on if the text color should also tint the inline icons.
	ERichTextInline...	InlineIconDisplayMode

Functions

		Name	Description
	void	CreateDecorators ( TArray< TSharedRef< ITextDecorator ... )
	FString	EscapeStringForRichText ( FString InString )
	TSubclassOf<...	GetDefaultTextStyleClass()
	float	GetMobileTextBlockScale()
	ETextTransfo...	GetTextTransformPolicy()

Overridden from URichTextBlock

		Name	Description
	void	ApplyUpdatedDefaultTextStyle()
	void	SetText ( const 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	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.