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 > STextBlock > FArguments

Light Theme

Dark Theme

FArguments

Windows

MacOS

Linux

Inheritance Hierarchy

TSlateBaseNamedArgs

STextBlock::FArguments

References

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

Syntax

struct FArguments : public TSlateBaseNamedArgs< STextBlock >

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...	ColorAndOpacity ( const TAttribute< FSlateColor >& I... )	Text color and opacity
WidgetArgsTy...	Font ( const TAttribute< FSlateFontInfo > ... )	Sets the font used to draw the text
WidgetArgsTy...	HighlightColor ( const TAttribute< FLinearColor >& ... )	The color used to highlight the specified text
WidgetArgsTy...	HighlightShape ( const TAttribute< const FSlateBrush... )	The brush used to highlight the specified text
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...	LineBreakPolicy ( TSharedPtr< IBreakIterator > InArg )	The iterator to use to detect appropriate soft-wrapping points for lines (or null to use the default)
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...	MinDesiredWidth ( const TAttribute< float >& InAttri... )	Minimum width that a text block should be
WidgetArgsTy...	OnDoubleClicked ( const FPointerEventHandler& InDele... )	Called when this text is double clicked
WidgetArgsTy...	ShadowColorAndOpacity ( const TAttribute< FLinearColor >& ... )	Shadow color and opacity
WidgetArgsTy...	ShadowOffset ( const TAttribute< FVector2D >& InA... )	Drop shadow offset in pixels
WidgetArgsTy...	SimpleTextMode ( bool InArg )	If this is enabled, text shaping, wrapping, justification are disabled in favor of much faster text layout and measurement.
WidgetArgsTy...	StrikeBrush ( const TAttribute< const FSlateBrush... )	Sets the brush used to strike through the text
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 )	Pointer to a style of the text block, which dictates the font, color, and shadow options.
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.

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