UCommonRichTextBlock | Unreal Engine 5.7 Documentation

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


Name	UCommonRichTextBlock
Type	class
Header File	/Engine/Plugins/Runtime/CommonUI/Source/CommonUI/Public/CommonRichTextBlock.h
Include Path	#include "CommonRichTextBlock.h"

Syntax

UCLASS (MinimalAPI)  
class UCommonRichTextBlock : public URichTextBlock

Name	Type	Remarks	Include Path	Unreal Specifiers
bTintInlineIcon	bool	Toggle it on if the text color should also tint the inline icons.	CommonRichTextBlock.h	EditAnywhere Category=InlineIcon
InlineIconDisplayMode	ERichTextInlineIconDisplayMode		CommonRichTextBlock.h	EditAnywhere Category=InlineIcon

Name	Type	Remarks	Include Path	Unreal Specifiers
bAutoCollapseWithEmptyText	bool	True to automatically collapse this rich text block when set to display an empty string.	CommonRichTextBlock.h	EditAnywhere BlueprintReadOnly Category=Appearance Meta=(AllowPrivateAccess=true)
bIsScrollingEnabled	bool	If scrolling is enabled/disabled initially, this can be updated in blueprint	CommonRichTextBlock.h	EditAnywhere BlueprintReadOnly Category=Appearance Meta=(ExposeOnSpawn=true, AllowPrivateAccess=true)
DefaultTextStyleOverrideClass	TSubclassOf< UCommonTextStyle >		CommonRichTextBlock.h	EditAnywhere Category=Appearance Meta=(EditCondition=bOverrideDefaultStyle)
MobileTextBlockScale	float	Mobile font size multiplier. Activated by default on mobile. See CVar Mobile_PreviewFontSize	CommonRichTextBlock.h	EditAnywhere Category="Mobile" Meta=(ClampMin="0.01", ClampMax="5")
MyTextScroller	TSharedPtr< STextScroller >		CommonRichTextBlock.h
ScrollOrientation	TEnumAsByte< EOrientation >	The orientation the text will scroll if out of bounds.	CommonRichTextBlock.h	EditAnywhere BlueprintReadOnly Category=Appearance Meta=(ExposeOnSpawn=true, AllowPrivateAccess=true)
ScrollStyle	TSubclassOf< UCommonTextScrollStyle >	References the scroll style asset to use, no reference disables scrolling	CommonRichTextBlock.h	EditAnywhere BlueprintReadOnly Category=Appearance Meta=(ExposeOnSpawn=true, AllowPrivateAccess=true)

Name	Include Path	Unreal Specifiers
TSubclassOf< UCommonTextStyle > GetDefaultTextStyleClass()	CommonRichTextBlock.h
float GetMobileTextBlockScale()	CommonRichTextBlock.h
ETextTransformPolicy GetTextTransformPolicy()	CommonRichTextBlock.h
void SetScrollingEnabled ( bool bInIsScrollingEnabled )	CommonRichTextBlock.h	BlueprintCallable Category="Common Rich Text\|Scroll Style"
void SetStyle ( const TSubclassOf< UCommonTextStyle >& InStyle )	CommonRichTextBlock.h	BlueprintCallable Category="Common Rich Text"

Name	Remarks	Include Path	Unreal Specifiers
virtual void SetText ( const FText& InText )		CommonRichTextBlock.h

Name	Remarks	Include Path	Unreal Specifiers
virtual const FText GetPaletteCategory()		CommonRichTextBlock.h
virtual void OnCreationFromPalette()		CommonRichTextBlock.h

Name	Remarks	Include Path	Unreal Specifiers
virtual void ReleaseSlateResources ( bool bReleaseChildren )		CommonRichTextBlock.h

Name	Remarks	Include Path	Unreal Specifiers
virtual bool CanEditChange ( const FProperty* InProperty ) const		CommonRichTextBlock.h
virtual void Serialize ( FArchive& Ar )		CommonRichTextBlock.h

Name	Remarks	Include Path	Unreal Specifiers
virtual void ApplyUpdatedDefaultTextStyle()		CommonRichTextBlock.h
virtual void CreateDecorators ( TArray< TSharedRef< ITextDecorator > >& OutDecorators )		CommonRichTextBlock.h

Name	Remarks	Include Path	Unreal Specifiers
virtual TSharedRef< SWidget > RebuildWidget()		CommonRichTextBlock.h
virtual void SynchronizeProperties()		CommonRichTextBlock.h

Name	Remarks	Include Path	Unreal Specifiers
static FString EscapeStringForRichText ( FString InString )		CommonRichTextBlock.h