FTextFormatter

A text formatter is responsible for formatting text patterns using a set of named or ordered arguments.

Windows
MacOS
Linux

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Internationalization/TextFormatter.h

Include

#include "Internationalization/TextFormatter.h"

Syntax

class FTextFormatter

Remarks

A text formatter is responsible for formatting text patterns using a set of named or ordered arguments.

Constructors

No constructors are accessible with public or protected access.

Functions

Name Description

Public function Static

void

 

ArgumentValueToFormattedString

(
    const FFormatArgumentValue& InValue,
    const FPrivateTextFormatArguments& InFormatArgs,
    FString& OutResult
)

Incredibly low-level version of FFormatArgumentValue::ToFormattedString.

Public function Const

FCompileTextArgumentModifierFuncPtr

 

FindTextArgumentModifier

(
    const FTextFormatString& InKeyword
)

Public function Static

FString

 

Format

(
    const FTextFormat& InFmt,
    const FPrivateTextFormatArguments& InFormatArgs
)

Incredibly low-level version of format.

Public function Static

FText

 

Format

(
    FTextFormat&& InFmt,
    FFormatNamedArguments&& InArguments,
    const bool bInRebuildText,
    const bool bInRebuildAsSource
)

Low-level versions of Format.

Public function Static

FText

 

Format

(
    FTextFormat&& InFmt,
    FFormatOrderedArguments&& InArguments,
    const bool bInRebuildText,
    const bool bInRebuildAsSource
)

Low-level versions of Format.

Public function Static

FText

 

Format

(
    FTextFormat&& InFmt,
    TArray< FFormatArgumentData >&& InArguments,
    const bool bInRebuildText,
    const bool bInRebuildAsSource
)

Low-level versions of Format.

Public function Static

FString

 

FormatStr

(
    const FTextFormat& InFmt,
    const FFormatNamedArguments& InArguments,
    const bool bInRebuildText,
    const bool bInRebuildAsSource
)

Low-level version of Format that returns a string.

Public function Static

FString

 

FormatStr

(
    const FTextFormat& InFmt,
    const FFormatOrderedArguments& InArguments,
    const bool bInRebuildText,
    const bool bInRebuildAsSource
)

Low-level version of Format that returns a string.

Public function Static

FString

 

FormatStr

(
    const FTextFormat& InFmt,
    const TArray< FFormatArgumentData >& InArguments,
    const bool bInRebuildText,
    const bool bInRebuildAsSource
)

Low-level version of Format that returns a string.

Public function Static

FTextFormatter &

 

Get()

Singleton access

Public function

void

 

RegisterTextArgumentModifier

(
    const FTextFormatString& InKeyword,
    FCompileTextArgumentModifierFuncPtr InCompileFunc
)

Public function

void

 

UnregisterTextArgumentModifier

(
    const FTextFormatString& InKeyword
)

Typedefs

Name

Description

FCompileTextArgumentModifierFuncPtr

Callback function used to compile an argument modifier.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback