ITextFormatArgumentModifier

Interface for a format argument modifier.

Windows
MacOS
Linux

References

Module

Core

Header

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

Include

#include "Internationalization/ITextFormatArgumentModifier.h"

Syntax

class ITextFormatArgumentModifier

Remarks

Interface for a format argument modifier.

Destructors

Name Description

Public function Virtual

~ITextFormatArgumentModifier()

Virtual destructor

Functions

Name Description

Public function Const

void

 

EstimateLength

(
    int32& OutLength,
    bool& OutUsesFormatArgs
)

Quickly estimate the length of text that this argument modifier will likely inject into the string when evaluated

Public function Const

void

 

Evaluate

(
    const FFormatArgumentValue& InValu...,
    const FPrivateTextFormatArguments&...,
    FString& OutResult
)

Given the argument, evaluate the result and append it to OutResult

Public function Const

void

 

GetFormatArgumentNames

(
    TArray< FString >& OutArgumentName...
)

Get any argument names that are used by this argument modifier (for cases where the modifier itself uses format strings)

Protected function Static

bool

 

ParseKeyValueArgs

(
    const FTextFormatString& InArgsStr...,
    TMap< FTextFormatString, FTextForma...,
    const TCHAR InValueSeparator,
    const TCHAR InArgSeparator
)

Utility helper to parse out a list of key->value pair arguments.

Protected function Static

bool

 

ParseValueArgs

(
    const FTextFormatString& InArgsStr...,
    TArray< FTextFormatString >& OutAr...,
    const TCHAR InArgSeparator
)

Utility helper to parse out a list of value arguments.

Public function Const

bool

 

Validate

(
    const FCultureRef& InCulture,
    TArray< FString >& OutValidationEr...
)

Validate the argument modifier is valid based on the rules of the given culture

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