1. Epic GamesDeveloper
  3. FText

FText

Unreal Engine C++ API Reference > Runtime > Core > Internationalization

References

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

Syntax

class FText

Constructors

  Type Name Description
Public function  

FText ()

  
Public function  

FText ( const FText&
)

  
Public function  

FText ( FText&&
)

  

Functions

  Type Name Description
Public function Static FText Generate a culture invariant FText representing the passed in FText
Public function Static FText Generate a culture invariant FText representing the passed in string
Public function Static FText

AsCultureInvariant ( const FString& String
)

 Generate a culture invariant FText representing the passed in string
Public function Static FText

AsCurrency ( int16 Val,
const FString& CurrencyCode,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture
)

 A dynamically sizeable string.
Public function Static FText

AsCurrency ( long Val,
const FString& CurrencyCode,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture
)

 A dynamically sizeable string.
Public function Static FText

AsCurrency ( uint64 Val,
const FString& CurrencyCode,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture
)

 A dynamically sizeable string.
Public function Static FText

AsCurrency ( uint32 Val,
const FString& CurrencyCode,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture
)

 A dynamically sizeable string.
Public function Static FText

AsCurrency ( uint16 Val,
const FString& CurrencyCode,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture
)

 A dynamically sizeable string.
Public function Static FText

AsCurrency ( uint8 Val,
const FString& CurrencyCode,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture
)

 A dynamically sizeable string.
Public function Static FText

AsCurrency ( int64 Val,
const FString& CurrencyCode,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture
)

 A dynamically sizeable string.
Public function Static FText

AsCurrency ( int32 Val,
const FString& CurrencyCode,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture
)

 A dynamically sizeable string.
Public function Static FText

AsCurrency ( int8 Val,
const FString& CurrencyCode,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture
)

 A dynamically sizeable string.
Public function Static FText

AsCurrency ( double Val,
const FString& CurrencyCode,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture
)

 A dynamically sizeable string.
Public function Static FText

AsCurrency ( float Val,
const FString& CurrencyCode,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture
)

  
Public function Static FText

AsCurrencyBase ( int64 BaseVal,
const FString& CurrencyCode,
const FCulturePtr& TargetCulture,
int32 ForceDecimalPlaces
)

 Generate an FText that represents the passed number as currency in the current culture.
Public function Static FText

AsDate ( const FDateTime& DateTime,
const EDateTimeStyle::Type DateStyle,
const FString& TimeZone,
const FCulturePtr& TargetCulture
)

 Generate an FText that represents the passed number as a date and/or time in the current culture
Public function Static FText

AsDateTime ( const FDateTime& DateTime,
const FString& CustomPattern,
const FString& TimeZone,
const FCulturePtr& TargetCulture
)

 A dynamically sizeable string.
Public function Static FText

AsDateTime ( const FDateTime& DateTime,
const EDateTimeStyle::Type DateStyle,
const EDateTimeStyle::Type TimeStyle,
const FString& TimeZone,
const FCulturePtr& TargetCulture
)

 A dynamically sizeable string.
Public function Static FText

AsMemory ( uint64 NumBytes,
EMemoryUnitStandard UnitStandard
)

 Generate an FText that represents the passed number as a memory size in the current culture
Public function Static FText

AsMemory ( uint64 NumBytes,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture,
EMemoryUnitStandard UnitStandard
)

 Generate an FText that represents the passed number as a memory size in the current culture
Public function Static FText

AsNumber ( float Val,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture
)

 Generate an FText that represents the passed number in the current culture
Public function Static FText

AsNumber ( double Val,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture
)

 Generate an FText that represents the passed number in the current culture
Public function Static FText

AsNumber ( int16 Val,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture
)

 Generate an FText that represents the passed number in the current culture
Public function Static FText

AsNumber ( int32 Val,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture
)

 Generate an FText that represents the passed number in the current culture
Public function Static FText

AsNumber ( int64 Val,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture
)

 Generate an FText that represents the passed number in the current culture
Public function Static FText

AsNumber ( uint8 Val,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture
)

 Generate an FText that represents the passed number in the current culture
Public function Static FText

AsNumber ( uint16 Val,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture
)

 Generate an FText that represents the passed number in the current culture
Public function Static FText

AsNumber ( int8 Val,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture
)

 Generate an FText that represents the passed number in the current culture
Public function Static FText

AsNumber ( uint64 Val,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture
)

 Generate an FText that represents the passed number in the current culture
Public function Static FText

AsNumber ( long Val,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture
)

 Generate an FText that represents the passed number in the current culture
Public function Static FText

AsNumber ( uint32 Val,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture
)

 Generate an FText that represents the passed number in the current culture
Public function Static FText

AsPercent ( float Val,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture
)

 Generate an FText that represents the passed number as a percentage in the current culture
Public function Static FText

AsPercent ( double Val,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture
)

 Generate an FText that represents the passed number as a percentage in the current culture
Public function Static FText

AsTime ( const FDateTime& DateTime,
const EDateTimeStyle::Type TimeStyle,
const FString& TimeZone,
const FCulturePtr& TargetCulture
)

 A dynamically sizeable string.
Public function Static FText

AsTimespan ( const FTimespan& Timespan,
const FCulturePtr& TargetCulture
)

  
Public function Const FString Deep build of the source string for this FText, climbing the history hierarchy
Public function Static FText

ChangeKey ( const FTextKey& Namespace,
const FTextKey& Key,
const FText& Text
)

 Constructs a new FText with the SourceString of the specified text but with the specified namespace and key
Public function Const int32

CompareTo ( const FText& Other,
const ETextComparisonLevel::Type ComparisonLevel
)

  
Public function Const int32

CompareToCaseIgnored ( const FText& Other
)

  
Public function Const bool

EqualTo ( const FText& Other,
const ETextComparisonLevel::Type ComparisonLevel
)

  
Public function Const bool

EqualToCaseIgnored ( const FText& Other
)

  
Public function Static FCreateTextGeneratorDelegate Returns the text generator factory function registered under the specified name, if any.
Public function Static bool

FindText ( const FTextKey& Namespace,
const FTextKey& Key,
FText& OutText,
const FString*const SourceString
)

 Attempts to find an existing FText using the representation found in the loc tables for the specified namespace and key
Public function Static FText

Format ( FTextFormat Fmt,
FFormatOrderedArguments&& InArguments
)

 Format the given map of key->value pairs as named arguments within the given format pattern
Public function Static FText

Format ( FTextFormat Fmt,
const FFormatOrderedArguments& InArguments
)

 Format the given list values as ordered arguments within the given format pattern
Public function Static FText

Format ( FTextFormat Fmt,
FFormatNamedArguments&& InArguments
)

 Format the given map of key->value pairs as named arguments within the given format pattern
Public function Static FText

Format ( FTextFormat Fmt,
const FFormatNamedArguments& InArguments
)

 Format the given map of key->value pairs as named arguments within the given format pattern
Public function Static FText

Format ( FTextFormat Fmt,
ArgTypes... Args
)

 Format the given list of variadic values as ordered arguments within the given format pattern
Public function Static FText

FormatNamed ( FTextFormat Fmt,
TArguments&&... Args
)

 Format the given list of variadic key->value pairs as named arguments within the given format pattern
Public function Static FText

FormatOrdered ( FTextFormat Fmt,
TArguments&&... Args
)

 Format the given list of variadic values as ordered arguments within the given format pattern
Public function Static FText

FromName ( const FName& Val
)

 Generate an FText representing the pass name
Public function Static FText

FromString ( const FString& String
)

 Generate an FText representing the passed in string
Public function Static FText

FromString ( FString&& String
)

 Generate an FText representing the passed in string
Public function Static FText

FromStringTable ( const FName InTableId,
const FString& InKey,
const EStringTableLoadingPolicy InLoadingPolicy
)

 Attempts to create an FText instance from a string table ID and key (this is the same as the LOCTABLE macro, except this can also work with non-literal string values).
Public function Static FText

FromStringView ( FStringView InString
)

 Generate a FText representing the passed string view
Public function Static FText

FromTextGenerator ( const TSharedRef< ITextGenerator >& TextGenerator
)

 Produces a custom-generated FText.
Public function Static const FText &  
Public function Static void

GetFormatPatternParameters ( const FTextFormat& Fmt,
TArray< FString >& ParameterNames
)

  
Public function Static FString Gets the time zone string that represents a non-specific, zero offset, culture invariant time zone.
Public function Const bool

IdenticalTo ( const FText& Other,
const ETextIdenticalModeFlags CompareModeFlags
)

 Check to see if this FText is identical to the other FText
Public function Const bool  
Public function Const bool

IsEmpty ()

  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Static bool

IsWhitespace ( const TCHAR Char
)

 Check to see if the given character is considered whitespace by the current culture
Public function Static FText

Join ( const FText& Delimiter,
ArgTypes... Args
)

 Join an arbitrary list of formattable items together, separated by the given delimiter
Public function Static FText

Join ( const FText& Delimiter,
const TArray< FText >& Args
)

 Join an arbitrary list of formattable values together, separated by the given delimiter
Public function Static FText

Join ( const FText& Delimiter,
const FFormatOrderedArguments& Args
)

 Join an arbitrary list of formattable values together, separated by the given delimiter
Public function Static void Registers a standard text generator factory function.
Public function Static void Registers a factory function to be used with serialization of text generators within FText.
Public function Static void Registers a standard text generator factory function.
Public function Const bool  
Public function Const FText

ToLower ()

 Transforms the text to lowercase in a culture correct way.
Public function Const const FString &  
Public function Const FText

ToUpper ()

 Transforms the text to uppercase in a culture correct way.
Public function Static FText

TrimPreceding ( const FText&
)

 Removes any whitespace characters from the start of the text.
Public function Static FText Removes any whitespace characters from the start and end of the text.
Public function Static FText

TrimTrailing ( const FText&
)

 Removes any whitespace characters from the end of the text.
Public function Static void Unregisters a standard text generator factory function.
Public function Static void Unregisters a factory function to be used with serialization of text generators within FText.

Operators

  Type Name Description
Public function FText &  
Public function FText &

operator= ( const FText&
)

  

Classes

  Type Name Description
Public class FSortPredicate    

Enums

  Type Name Description
Private enum EInitToEmptyString Special constructor used to create StaticEmptyText without also allocating a history object  

Typedefs

Name Description
FCreateTextGeneratorDelegate  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page