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 > Core > Internationalization > FTextFormat

Light Theme

Dark Theme

FTextFormat

Cached compiled expression used by the text formatter.

Choose your operating system:

Windows

macOS

Linux

References

Module	Core
Header	/Engine/Source/Runtime/Core/Public/Internationalization/Text.h
Include	#include "Internationalization/Text.h"

Syntax

class FTextFormat

Remarks

Cached compiled expression used by the text formatter. The compiled expression will automatically update if the display string is changed. See TextFormatter.cpp for the definition.

Constructors

	Name	Description
	FTextFormat()	Construct an instance using an empty FText.
	FTextFormat ( const FText& InText )	Construct an instance from an FText.
	FTextFormat ( const FText& InText, FTextFormatPatternDefinitionConstRe... )	Construct an instance from an FText and custom format pattern definition.

Functions

	Name	Description
FTextFormat	FromString ( const FString& InString )	Construct an instance from an FString.
FTextFormat	FromString ( FString&& InString )	Construct an instance from an FString.
FTextFormat	FromString ( const FString& InString, FTextFormatPatternDefinitionConstRe... )	Construct an instance from an FString and custom format pattern definition.
FTextFormat	FromString ( FString&& InString, FTextFormatPatternDefinitionConstRe... )	Construct an instance from an FString.
EExpressionT...	GetExpressionType()	Get the type of expression currently compiled.
void	GetFormatArgumentNames ( TArray< FString >& OutArgumentName... )	Append the names of any arguments to the given array.
FTextFormatP...	GetPatternDefinition()	Get the format pattern definition being used.
const FStrin...	GetSourceString()	Get the source string that we're holding.
FText	GetSourceText()	Get the source text that we're holding. If we're holding a string then we'll construct a new text.
bool	IdenticalTo ( const FTextFormat& Other, const ETextIdenticalModeFlags Compa... )	Check whether this instance is considered identical to the other instance, based on the comparison flags provided.
bool	IsValid()	Test to see whether this instance contains valid compiled data.
bool	ValidatePattern ( const FCulturePtr& InCulture, TArray< FString >& OutValidationEr... )	Validate the format pattern is valid based on the rules of the given culture (or null to use the current language).

Enums

	Name	Description
	EExpressionType