FText

Syntax

class FText

Constructors

Name Description

Public function

FText()

Public function

FText

(
    const FText & Source
)

Public function

FText

(
    FText && Source
)

Functions

Name Description

Public function Static

FText

 

AsCultureInvariant

(
    FText Text
)

Generate a culture invariant FText representing the passed in FText

Public function Static

FText

 

AsCultureInvariant

(
    FString && String
)

Public function Static

FText

 

AsCultureInvariant

(
    const FString & String
)

Generate a culture invariant FText representing the passed in string

Public function Static

FText

 

AsCurrency

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

Public function Static

FText

 

AsCurrency

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

Public function Static

FText

 

AsCurrency

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

Public function Static

FText

 

AsCurrency

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

Public function Static

FText

 

AsCurrency

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

Public function Static

FText

 

AsCurrency

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

Public function Static

FText

 

AsCurrency

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

Public function Static

FText

 

AsCurrency

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

Public function Static

FText

 

AsCurrency

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

Public function Static

FText

 

AsCurrency

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

Public function Static

FText

 

AsCurrency

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

Public function Static

FText

 

AsCurrencyBase

(
    int64 BaseVal,
    const FString & CurrencyCode,
    const FCulturePtr& TargetCulture
)

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 DateStyl...,
    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 EDateTimeStyle::Type DateStyl...,
    const EDateTimeStyle::Type TimeStyl...,
    const FString & TimeZone,
    const FCulturePtr& TargetCulture
)

Public function Static

FText

 

AsMemory

(
    uint64 NumBytes,
    const FNumberFormattingOptions *...,
    const FCulturePtr& TargetCulture
)

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 FCulturePtr& TargetCulture
)

Generate an FText that represents the passed number in the current culture

Public function Static

FText

 

AsNumber

(
    double Val,
    const FNumberFormattingOptions *...,
    const FCulturePtr& TargetCulture
)

Public function Static

FText

 

AsNumber

(
    int8 Val,
    const FNumberFormattingOptions *...,
    const FCulturePtr& TargetCulture
)

Public function Static

FText

 

AsNumber

(
    int16 Val,
    const FNumberFormattingOptions *...,
    const FCulturePtr& TargetCulture
)

Public function Static

FText

 

AsNumber

(
    int64 Val,
    const FNumberFormattingOptions *...,
    const FCulturePtr& TargetCulture
)

Public function Static

FText

 

AsNumber

(
    uint8 Val,
    const FNumberFormattingOptions *...,
    const FCulturePtr& TargetCulture
)

Public function Static

FText

 

AsNumber

(
    uint16 Val,
    const FNumberFormattingOptions *...,
    const FCulturePtr& TargetCulture
)

Public function Static

FText

 

AsNumber

(
    uint32 Val,
    const FNumberFormattingOptions *...,
    const FCulturePtr& TargetCulture
)

Public function Static

FText

 

AsNumber

(
    int32 Val,
    const FNumberFormattingOptions *...,
    const FCulturePtr& TargetCulture
)

Public function Static

FText

 

AsNumber

(
    long Val,
    const FNumberFormattingOptions *...,
    const FCulturePtr& TargetCulture
)

Public function Static

FText

 

AsNumber

(
    uint64 Val,
    const FNumberFormattingOptions *...,
    const FCulturePtr& TargetCulture
)

Public function Static

FText

 

AsPercent

(
    float Val,
    const FNumberFormattingOptions *...,
    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 FCulturePtr& TargetCulture
)

Public function Static

FText

 

AsTime

(
    const FDateTime & DateTime,
    const EDateTimeStyle::Type TimeStyl...,
    const FString & TimeZone,
    const FCulturePtr& TargetCulture
)

Public function Static

FText

 

AsTimespan

(
    const FTimespan & Timespan,
    const FCulturePtr& TargetCulture
)

Public function

FString

 

BuildSourceString()

Deep build of the source string for this FText , climbing the history hierarchy

Public function Static

FText

 

ChangeKey

(
    const FString & Namespace,
    const FString & Key,
    const FText & Text
)

Constructs a new FText with the SourceString of the specified text but with the specified namespace and key

Public function

int32

 

CompareTo

(
    const FText & Other,
    const ETextComparisonLevel::Type Co...
)

Public function

int32

 

CompareToCaseIgnored

(
    const FText & Other
)

Public function

bool

 

EqualTo

(
    const FText & Other,
    const ETextComparisonLevel::Type Co...
)

Public function

bool

 

EqualToCaseIgnored

(
    const FText & Other
)

Public function Static

bool

 

FindText

(
    const FString & Namespace,
    const FString & Key,
    FText & OutText,
    const FString *const SourceStri...
)

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,
    FFormatArgumentValue v1
)

Public function Static

FText

 

Format

(
    FTextFormat Fmt,
    FFormatArgumentValue v1,
    FFormatArgumentValue v2
)

Public function Static

FText

 

Format

(
    FTextFormat Fmt,
    FFormatArgumentValue v1,
    FFormatArgumentValue v2,
    FFormatArgumentValue v3
)

Public function Static

FText

 

Format

(
    FTextFormat Fmt,
    FFormatOrderedArguments InArguments
)

Public function Static

FText

 

Format

(
    FTextFormat Fmt,
    FFormatArgumentValue v1,
    FFormatArgumentValue v2,
    FFormatArgumentValue v3,
    FFormatArgumentValue v4
)

Public function Static

FText

 

Format

(
    FTextFormat Fmt,
    FFormatNamedArguments InArguments
)

Public function Static

FText

 

Format

(
    FTextFormat Fmt,
    TArray < struct FFormatArgumentData ...
)

Public function Static

FText

 

FormatNamed

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

Namespace TextFormatUtil

Public function Static

FText

 

FormatOrdered

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

FormatOrdered allows you to pass a variadic list of types to use for formatting in order desired

Public function Static

FText

 

FromName

(
    const FName & Val
)

Generate an FText representing the pass name

Public function Static

FText

 

FromString

(
    FString && String
)

Public function Static

FText

 

FromString

(
    const FString & String
)

Generate an FText representing the passed in string

Public function Static

const FText ...

 

GetEmpty()

Public function Static

bool

 

GetEnableErrorCheckingResults()

Public function Static

void

 

GetFormatPatternParameters

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

Public function Static

FString

 

GetInvariantTimeZone()

Gets the time zone string that represents a non-specific, zero offset, culture invariant time zone.

Public function

void

 

GetSourceTextsFromFormatHistory

(
    TArray < FText >& OutSourceTexts
)

Trace the history of this Text until we find the base Texts it was comprised from

Public function Static

bool

 

GetSuppressWarnings()

Public function

bool

 

IdenticalTo

(
    const FText & Other
)

Check to see if this FText is identical to the other FText

Public function

bool

 

IsCultureInvariant()

Public function

bool

 

IsEmpty()

Public function

bool

 

IsEmptyOrWhitespace()

Public function

bool

 

IsNumeric()

Public function

bool

 

IsTransient()

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

void

 

SetEnableErrorCheckingResults

(
    bool bEnable
)

Public function Static

void

 

SetSuppressWarnings

(
    bool bSuppress
)

Public function

bool

 

ShouldGatherForLocalization()

Public function

const FStrin ...

 

ToString()

Public function Static

FText

 

TrimPreceding

(
    const FText &
)

Removes whitespace characters from the front of the string.

Public function Static

FText

 

TrimPrecedingAndTrailing

(
    const FText &
)

Does both of the above without needing to create an additional FText in the interim.

Public function Static

FText

 

TrimTrailing

(
    const FText &
)

Removes trailing whitespace characters

Operators

Name Description

Public function

FText &

 

operator=

(
    FText && Source
)

Public function

FText &

 

operator=

(
    const FText & Source
)

Classes

Name

Description

Public class

FSortPredicate

Enums

Name

Description

Private enum

EInitToEmptyString

Special constructor used to create StaticEmptyText without also allocating a history object

Constants

References

Module

Core

Header

Runtime/Core/Public/Internationalization/Text.h