FTextFormat Class Reference

#include <Text.h>

Public Types
enum class	EExpressionType { Invalid , Simple , Complex }

Public Member Functions
CORE_API	FTextFormat ()
CORE_API	FTextFormat (const FText &InText, ETextFormatFlags InFormatFlags=ETextFormatFlags::Default)
CORE_API	FTextFormat (const FText &InText, FTextFormatPatternDefinitionConstRef InCustomPatternDef, ETextFormatFlags InFormatFlags=ETextFormatFlags::Default)
CORE_API bool	IsValid () const
CORE_API bool	IdenticalTo (const FTextFormat &Other, const ETextIdenticalModeFlags CompareModeFlags) const
CORE_API FText	GetSourceText () const
CORE_API const FString &	GetSourceString () const
CORE_API EExpressionType	GetExpressionType () const
CORE_API ETextFormatFlags	GetFormatFlags () const
CORE_API FTextFormatPatternDefinitionConstRef	GetPatternDefinition () const
CORE_API bool	ValidatePattern (const FCulturePtr &InCulture, TArray< FString > &OutValidationErrors) const
CORE_API void	GetFormatArgumentNames (TArray< FString > &OutArgumentNames) const

Static Public Member Functions
static CORE_API FTextFormat	FromString (const FString &InString, ETextFormatFlags InFormatFlags=ETextFormatFlags::Default)
static CORE_API FTextFormat	FromString (FString &&InString, ETextFormatFlags InFormatFlags=ETextFormatFlags::Default)
static CORE_API FTextFormat	FromString (const FString &InString, FTextFormatPatternDefinitionConstRef InCustomPatternDef, ETextFormatFlags InFormatFlags=ETextFormatFlags::Default)
static CORE_API FTextFormat	FromString (FString &&InString, FTextFormatPatternDefinitionConstRef InCustomPatternDef, ETextFormatFlags InFormatFlags=ETextFormatFlags::Default)

Friends
class	FTextFormatter

Detailed Description

Cached compiled expression used by the text formatter. The compiled expression will automatically update if the display string is changed, and is safe to be used as a function-level static. See TextFormatter.cpp for the definition.

Member Enumeration Documentation

EExpressionType

enum class FTextFormat::EExpressionType

strong

Enumerator
Invalid	Invalid expression
Simple	Simple expression, containing no arguments or argument modifiers
Complex	Complex expression, containing arguments or argument modifiers

Constructor & Destructor Documentation

FTextFormat() [1/3]

FTextFormat::FTextFormat

(

)

Construct an instance using an empty FText.

FTextFormat() [2/3]

FTextFormat::FTextFormat	(	const FText &	InText,
		ETextFormatFlags	InFormatFlags = ETextFormatFlags::Default
	)

Construct an instance from an FText. The text will be immediately compiled.

FTextFormat() [3/3]

FTextFormat::FTextFormat	(	const FText &	InText,
		FTextFormatPatternDefinitionConstRef	InCustomPatternDef,
		ETextFormatFlags	InFormatFlags = ETextFormatFlags::Default
	)

Construct an instance from an FText and custom format pattern definition. The text will be immediately compiled.

Member Function Documentation

FromString() [1/4]

FTextFormat FTextFormat::FromString ( const FString &  InString, ETextFormatFlags  InFormatFlags = ETextFormatFlags::Default  )

static

Construct an instance from an FString. The string will be immediately compiled.

FromString() [2/4]

FTextFormat FTextFormat::FromString ( const FString &  InString, FTextFormatPatternDefinitionConstRef  InCustomPatternDef, ETextFormatFlags  InFormatFlags = ETextFormatFlags::Default  )

static

Construct an instance from an FString and custom format pattern definition. The string will be immediately compiled.

FromString() [3/4]

FTextFormat FTextFormat::FromString ( FString &&  InString, ETextFormatFlags  InFormatFlags = ETextFormatFlags::Default  )

static

FromString() [4/4]

FTextFormat FTextFormat::FromString ( FString &&  InString, FTextFormatPatternDefinitionConstRef  InCustomPatternDef, ETextFormatFlags  InFormatFlags = ETextFormatFlags::Default  )

static

GetExpressionType()

FTextFormat::EExpressionType FTextFormat::GetExpressionType

(

)

const

Get the type of expression currently compiled.

GetFormatArgumentNames()

void FTextFormat::GetFormatArgumentNames

(

TArray< FString > &

OutArgumentNames

)

const

Append the names of any arguments to the given array.

GetFormatFlags()

ETextFormatFlags FTextFormat::GetFormatFlags

(

)

const

Get the format flags being used.

GetPatternDefinition()

FTextFormatPatternDefinitionConstRef FTextFormat::GetPatternDefinition

(

)

const

Get the format pattern definition being used.

GetSourceString()

const FString & FTextFormat::GetSourceString

(

)

const

Get the source string that we're holding. If we're holding a text then we'll return its internal string.

GetSourceText()

FText FTextFormat::GetSourceText

(

)

const

Get the source text that we're holding. If we're holding a string then we'll construct a new text.

IdenticalTo()

bool FTextFormat::IdenticalTo	(	const FTextFormat &	Other,
		const ETextIdenticalModeFlags	CompareModeFlags
	)		const

Check whether this instance is considered identical to the other instance, based on the comparison flags provided.

IsValid()

bool FTextFormat::IsValid

(

)

const

Test to see whether this instance contains valid compiled data.

ValidatePattern()

bool FTextFormat::ValidatePattern	(	const FCulturePtr &	InCulture,
		TArray< FString > &	OutValidationErrors
	)		const

Validate the format pattern is valid based on the rules of the given culture (or null to use the current language).

Returns

true if the pattern is valid, or false if not (false may also fill in OutValidationErrors).

Friends And Related Symbol Documentation

FTextFormatter

friend class FTextFormatter

friend

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/Core/Public/Internationalization/Text.h
• Engine/Source/Runtime/Core/Private/Internationalization/TextFormatter.cpp