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

Inheritance Hierarchy

FSlateControlledConstruction

TSharedFromThis

SWidget

SLeafWidget

STextBlock

SVerticalTextBlock

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

Variables

		Name	Description
	uint16: 1	bIsAttributeBoundTextBound
	uint16: 1	bIsAttributeColorAndOpacitySet
	uint16: 1	bIsAttributeFontSet
	uint16: 1	bIsAttributeHighlightColorSet
	uint16: 1	bIsAttributeHighlightShapeSet
	uint16: 1	bIsAttributeShadowColorAndOpacitySet
	uint16: 1	bIsAttributeShadowOffsetSet
	uint16: 1	bIsAttributeStrikeBrushSet
	uint16: 1	bIsAttributeTransformPolicySet
	uint16: 1	bIsAttributeWrapTextAtSet
	uint16	Union_Flags

Constructors

	Name	Description
	STextBlock()	Constructor

Destructors

	Name	Description
	~STextBlock()	Destructor

Functions

	Name	Description
void	Construct ( const FArguments& InArgs )	Construct this widget
FSlateColor	GetColorAndOpacity()	Gets the current foreground color
const FSlate...	GetColorAndOpacityRef()	Gets the current foreground color as ref
FSlateFontIn...	GetFont()	Gets the current font
const FSlate...	GetFontRef()	Gets the current font as ref
FSlateColor	GetHighlightColor()	Gets the current highlight color
const FSlate...	GetHighlightShape()	Gets the current highlight shape
FMargin	GetMargin()	Gets the current margin
float	GetMinDesiredWidth()	Gets the current min desired width
FLinearColor	GetShadowColorAndOpacity()	Gets the current shadow color and opacity
const FLinea...	GetShadowColorAndOpacityRef()	Gets the current shadow color and opacity as ref
FVector2f	GetShadowOffset()	Gets the current shadow offset
const FSlate...	GetStrikeBrush()	Gets the current strike brush
const FText ...	GetText()	Gets the text assigned to this text block
ETextTransfo...	GetTransformPolicyImpl()	Get TransformPolicy attribute
void	SetAutoWrapText ( TAttribute< bool > InAutoWrapText )	See AutoWrapText attribute
void	SetColorAndOpacity ( TAttribute< FSlateColor > InColorAn... )	See ColorAndOpacity attribute
void	SetFont ( TAttribute< FSlateFontInfo > InFont )	Sets the font used to draw the text
void	SetHighlightColor ( TAttribute< FLinearColor > InHighli... )	See HighlightColor attribute
void	SetHighlightShape ( TAttribute< const FSlateBrush*... )	See HighlightShape attribute
void	SetHighlightText ( TAttribute< FText > InText )	Sets the highlight text for this text block
void	SetJustification ( TAttribute< ETextJustify::Type > In... )	See Justification attribute
void	SetLineHeightPercentage ( TAttribute< float > InLineHeightPer... )	See LineHeightPercentage attribute
void	SetMargin ( TAttribute< FMargin > InMargin )	See Margin attribute
void	SetMinDesiredWidth ( TAttribute< float > InMinDesiredWid... )	See MinDesiredWidth attribute
void	SetOverflowPolicy ( TOptional< ETextOverflowPolicy > In... )	Sets the overflow policy for this text block
void	SetShadowColorAndOpacity ( TAttribute< FLinearColor > InShadow... )	See ShadowColorAndOpacity attribute
void	SetShadowOffset ( TAttribute< FVector2D > InShadowOff... )	See ShadowOffset attribute
void	SetStrikeBrush ( TAttribute< const FSlateBrush*... )	Sets the brush used to strike through the text
void	SetText ( 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 ( TAttribute< ETextTransformPolicy > ... )	Set TransformPolicy attribute
void	SetWrappingPolicy ( TAttribute< ETextWrappingPolicy > I... )	Set WrappingPolicy attribute
void	SetWrapTextAt ( TAttribute< float > InWrapTextAt )	See WrapTextAt attribute
const FSlate...	StaticWidgetClass()

Overridden from SWidget

	Name	Description
FVector2D	ComputeDesiredSize ( float )	Overwritten from SWidget.
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.

Overridden from FSlateControlledConstruction

		Name	Description
	const FSlate...	GetWidgetClass()

Classes

	Name	Description
	FArguments

Typedefs

Name	Description
PrivateParentType
PrivateThisType
Super
ThisClass

Deprecated Functions

		Name	Description
	ETextTransfo...	GetTransformPolicy()	GetTransformPolicy is not accessible anymore since it's attribute value may not have been updated yet.

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

Take our survey

Cancel