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

Light Theme

Dark Theme

STextBlock

A simple static text widget

Windows

MacOS

Linux

Inheritance Hierarchy

FSlateControlledConstruction

TSharedFromThis

SWidget

SLeafWidget

STextBlock

References

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

Syntax

class STextBlock : public SLeafWidget

Remarks

A simple static text widget

Constructors

	Name	Description
	STextBlock()	Constructor

Destructors

	Name	Description
	~STextBlock()	Destructor

Functions

	Name	Description
void	Construct ( const FArguments& InArgs )	Construct this widget
const FText ...	GetText()	Gets the text assigned to this text block
void	SetAutoWrapText ( const TAttribute< bool >& InAutoWr... )	See AutoWrapText attribute
void	SetColorAndOpacity ( const TAttribute< FSlateColor >& I... )	See ColorAndOpacity attribute
void	SetFont ( const TAttribute< FSlateFontInfo > ... )	Sets the font used to draw the text
void	SetHighlightText ( TAttribute< FText > InText )	Sets the highlight text for this text block
void	SetJustification ( const TAttribute< ETextJustify::Typ... )	See Justification attribute
void	SetLineHeightPercentage ( const TAttribute< float >& InLineH... )	See LineHeightPercentage attribute
void	SetMargin ( const TAttribute< FMargin >& InMar... )	See Margin attribute
void	SetMinDesiredWidth ( const TAttribute< float >& InMinDe... )	See MinDesiredWidth attribute
void	SetShadowColorAndOpacity ( const TAttribute< FLinearColor >& ... )	See ShadowColorAndOpacity attribute
void	SetShadowOffset ( const TAttribute< FVector2D >& InS... )	See ShadowOffset attribute
void	SetStrikeBrush ( const TAttribute< const FSlateBrush... )	Sets the brush used to strike through the text
void	SetText ( const TAttribute< FText >& InText )	Sets the text for this text block
void	SetTextFlowDirection ( const TOptional< ETextFlowDirection... )	See TextFlowDirection attribute
void	SetTextShapingMethod ( const TOptional< ETextShapingMethod... )	See TextShapingMethod attribute
void	SetTextStyle ( const FTextBlockStyle* InTextS... )	See TextStyle argument
void	SetTransformPolicy ( const TAttribute< ETextTransformPol... )	Set TransformPolicy attribute
void	SetWrappingPolicy ( const TAttribute< ETextWrappingPoli... )	Set WrappingPolicy attribute
void	SetWrapTextAt ( const TAttribute< float >& InWrapT... )	See WrapTextAt attribute

Overridden from SWidget

	Name	Description
FVector2D	ComputeDesiredSize ( float )	Overwritten from SWidget.
bool	ComputeVolatility()	Recomputes the volatility of the widget.
TSharedRef< ...	CreateAccessibleWidget()
TOptional< F...	GetDefaultAccessibleText ( EAccessibleType AccessibleType )	Assign AccessibleText with a default value that can be used when AccessibleBehavior is set to Auto or Custom.
int32	OnPaint ( const FPaintArgs& Args, const FGeometry& AllottedGeometry, const FSlateRect& MyCullingRect, FSlateWindowElementList& OutDrawEl..., int32 LayerId, const FWidgetStyle& InWidgetStyle, bool bParentEnabled )	Overwritten from SWidget.

Classes

	Name	Description
	FArguments

Deprecated Functions

	Name	Description
void	SetText ( const TAttribute< FString >& InTex... )	SetText taking FString is deprecated. Use the FText version instead
void	SetText ( const FString& InText )	SetText taking FString is deprecated. Use the FText version instead
void	SetText ( const FText& InText )	SetText taking FString is deprecated. Use the FText version instead

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

Take our survey

Dismiss