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 > URichTextBlock

Light Theme

Dark Theme

URichTextBlock

The rich text block Fancy Text No Children

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UVisual

UWidget

UTextLayoutWidget

URichTextBlock

UCommonRichTextBlock

References

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

Syntax

class URichTextBlock : public UTextLayoutWidget

Remarks

The rich text block

Fancy Text No Children

Variables

	Name	Description
bool	bOverrideDefaultStyle	True to specify the default text style for this rich text inline, overriding any default provided in the style set table
TArray< TSubcla...	DecoratorClasses
FTextBlockStyle	DefaultTextStyle
FTextBlockStyle	DefaultTextStyleOverride	Text style to apply by default to text in this block
TArray< TObject...	InstanceDecorators
float	MinDesiredWidth	The minimum desired size for the text
TSharedPtr< SRi...	MyRichTextBlock
TSharedPtr< cla...	StyleInstance
FText	Text	The text to display
ETextOverflowPo...	TextOverflowPolicy	Sets what happens to text that is clipped and doesn't fit within the clip rect for this widget
TObjectPtr< cla...	TextStyleSet
ETextTransformP...	TextTransformPolicy	The text transformation policy to apply to this text block

Constructors

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

Functions

	Name	Description
void	ApplyUpdatedDefaultTextStyle()
void	BeginDefaultStyleOverride()
void	ClearAllDefaultStyleOverrides()	Remove all overrides made to the default text style and return to the style specified in the style set data table
void	CreateDecorators ( TArray< TSharedRef< class ITextDeco... )
TSharedPtr< ...	CreateMarkupParser()
TSharedPtr< ...	CreateMarkupWriter()
const FTextB...	GetCurrentDefaultTextStyle()
URichTextBlo...	GetDecoratorByClass ( TSubclassOf< URichTextBlockDecorato... )
const FTextB...	GetDefaultTextStyle()
FText	GetText()	Returns widgets text.
void	RebuildStyleInstance()
void	RefreshTextLayout()	Causes the text to reflow it's layout and re-evaluate any decorators
void	SetAutoWrapText ( bool InAutoTextWrap )	Set the auto wrap for this rich text block
void	SetDefaultColorAndOpacity ( FSlateColor InColorAndOpacity )	Sets the color and opacity of the default text in this rich text block
void	SetDefaultFont ( FSlateFontInfo InFontInfo )	Dynamically set the default font info for this rich text block
void	SetDefaultShadowColorAndOpacity ( FLinearColor InShadowColorAndOpacit... )	Sets the color and opacity of the default text drop shadow
void	SetDefaultShadowOffset ( FVector2D InShadowOffset )	Sets the offset that the default text drop shadow should be drawn at
void	SetDefaultStrikeBrush ( FSlateBrush& InStrikeBrush )	Dynamically set the default strike brush for this rich text block
void	SetDefaultTextStyle ( const FTextBlockStyle& InDefaultTe... )	Wholesale override of the currently established default text style
void	SetMinDesiredWidth ( float InMinDesiredWidth )	Set the minimum desired width for this rich text block
void	SetText ( const FText& InText )	Directly sets the widget text.
void	SetTextOverflowPolicy ( ETextOverflowPolicy InOverflowPolic... )	Set the text overflow policy for this text block.
void	SetTextStyleSet ( UDataTable* NewTextStyleSet )
void	SetTextTransformPolicy ( ETextTransformPolicy InTransformPol... )	Set the text transformation policy for this text block.
void	UpdateStyleData()

Overridden from UTextLayoutWidget

		Name	Description
	void	SetJustification ( ETextJustify::Type InJustification )

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.
void	ValidateCompiledDefaults ( IWidgetCompilerLog& CompileLog )	Called at the end of Widget Blueprint compilation.

Overridden from UVisual

		Name	Description
	void	ReleaseSlateResources ( bool bReleaseChildren )