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

FRichTextLayoutMarshaller

Get/set the raw text to/from a text layout as rich text

Windows

MacOS

Linux

Inheritance Hierarchy

ITextLayoutMarshaller

FBaseTextLayoutMarshaller

FRichTextLayoutMarshaller

References

Module	Slate
Header	/Engine/Source/Runtime/Slate/Public/Framework/Text/RichTextLayoutMarshaller.h
Include	#include "Framework/Text/RichTextLayoutMarshaller.h"

Syntax

class FRichTextLayoutMarshaller : public FBaseTextLayoutMarshaller

Remarks

Get/set the raw text to/from a text layout as rich text

Variables

	Name	Description
TArray< TShared...	Decorators	Any decorators that should be used while parsing the text.
const ISlateSty...	DecoratorStyleSet	The style set used for looking up styles used by decorators
float	FontSizeMultiplier	Multiplier applied on font
TArray< TShared...	InlineDecorators	Additional decorators can be appended inline.
TSharedPtr< IRi...	Parser	The parser used to resolve any markup used in the provided string.
TSharedPtr< IRi...	Writer	The writer used to recreate any markup needed to preserve the styled runs.

Constructors

	Name	Description
	FRichTextLayoutMarshaller ( TArray< TSharedRef< ITextDecorator ..., const ISlateStyle*const InDeco... )
	FRichTextLayoutMarshaller ( TSharedPtr< IRichTextMarkupParser >..., TSharedPtr< IRichTextMarkupWriter >..., TArray< TSharedRef< ITextDecorator ..., const ISlateStyle*const InDeco... )

Destructors

	Name	Description
	~FRichTextLayoutMarshaller()

Functions

	Name	Description
FRichTextLay...	AppendInlineDecorator ( const TSharedRef< ITextDecorator > ... )	Append an inline decorator to this marshaller
void	AppendRunsForText ( const int32 LineIndex, const FTextRunParseResults& TextRu..., const FString& ProcessedString, const FTextBlockStyle& DefaultText..., const TSharedRef< FString >& InOut..., FTextLayout& TargetTextLayout, TArray< TSharedRef< IRun >>& Runs, TArray< FTextLineHighlight >& Line..., TMap< const FTextBlockStyle, ..., TMap< const FTextBlockStyle, ... )
TSharedRef< ...	Create ( TArray< TSharedRef< ITextDecorator ..., const ISlateStyle*const InDeco... )
TSharedRef< ...	Create ( TSharedPtr< IRichTextMarkupParser >..., TSharedPtr< IRichTextMarkupWriter >..., TArray< TSharedRef< ITextDecorator ..., const ISlateStyle*const InDeco... )
void	SetDecoratorStyleSet ( const ISlateStyle* InStyleSet )
void	SetFontSizeMultiplier ( const float NewFontSizeMultiplier )	Set the Multiplier applied on the font size of the text
TSharedPtr< ...	TryGetDecorator ( const FString& Line, const FTextRunParseResults& TextRu... )

Overridden from ITextLayoutMarshaller

		Name	Description
	void	GetText ( FString& TargetString, const FTextLayout& SourceTextLayou... )	Populate the string from the text layout
	void	SetText ( const FString& SourceString, FTextLayout& TargetTextLayout )	ITextLayoutMarshaller.

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

Take our survey

Dismiss