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 > Slate > Widgets > Text > SRichTextBlock > FArguments

Light Theme

Dark Theme

FArguments

Windows

MacOS

Linux

Inheritance Hierarchy

FSlateBaseNamedArgs

TSlateBaseNamedArgs

SRichTextBlock::FArguments

References

Module	Slate
Header	/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
Include	#include "Widgets/Text/SRichTextBlock.h"

Syntax

struct FArguments : public TSlateBaseNamedArgs< SRichTextBlock >

Variables

		Name	Description
	TArray< TShared...	InlineDecorators	Additional decorators can be append to the widget inline.

Constructors

	Name	Description
	FArguments()

Functions

	Name	Description
WidgetArgsTy...	AutoWrapText ( const TAttribute< bool >& InAttrib... )	Whether to wrap text automatically based on the widget's computed horizontal space.
WidgetArgsTy...	CreateSlateTextLayout ( const FCreateSlateTextLayout& InDe... )	Delegate used to create text layouts for this widget.
WidgetArgsTy...	Decorators ( TArray< TSharedRef< class ITextDeco... )	Any decorators that should be used while parsing the text.
WidgetArgsTy...	DecoratorStyleSet ( const ISlateStyle* InArg )	The style set used for looking up styles used by decorators
WidgetArgsTy...	HighlightText ( const TAttribute< FText >& InAttri... )	Highlight this text in the text block
WidgetArgsTy...	Justification ( const TAttribute< ETextJustify::Typ... )	How the text should be aligned with the margin.
WidgetArgsTy...	LineHeightPercentage ( const TAttribute< float >& InAttri... )	The amount to scale each lines height by.
WidgetArgsTy...	Margin ( const TAttribute< FMargin >& InAtt... )	The amount of blank space left around the edges of text area.
WidgetArgsTy...	Marshaller ( TSharedPtr< class FRichTextLayoutMa... )	The marshaller used to get/set the raw text to/from the text layout.
WidgetArgsTy...	MinDesiredWidth ( const TAttribute< float >& InAttri... )	Minimum width that this text block should be
WidgetArgsTy...	Parser ( TSharedPtr< class IRichTextMarkupPa... )	The parser used to resolve any markup used in the provided string.
WidgetArgsTy...	Text ( const TAttribute< FText >& InAttri... )	The text displayed in this text block
WidgetArgsTy...	TextFlowDirection ( TOptional< ETextFlowDirection > InA... )	Which text flow direction should we use? (unset to use the default returned by GetDefaultTextFlowDirection)
WidgetArgsTy...	TextShapingMethod ( TOptional< ETextShapingMethod > InA... )	Which text shaping method should we use? (unset to use the default returned by GetDefaultTextShapingMethod)
WidgetArgsTy...	TextStyle ( const FTextBlockStyle* InArg )	The style of the text block, which dictates the default font, color, and shadow options.
WidgetArgsTy...	TransformPolicy ( const TAttribute< ETextTransformPol... )	The transform policy to use
WidgetArgsTy...	WrappingPolicy ( const TAttribute< ETextWrappingPoli... )	The wrapping policy to use
WidgetArgsTy...	WrapTextAt ( const TAttribute< float >& InAttri... )	Whether text wraps onto a new line when it's length exceeds this width; if this value is zero or negative, no wrapping occurs.

Operators

		Name	Description
	SRichTextBlo...	operator+ ( const TSharedRef< ITextDecorator > ... )

Typedefs

Name	Description
WidgetArgsType

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

Take our survey

Dismiss