UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FTextBuilder Class Reference

#include <Text.h>

Public Member Functions

CORE_API void Indent ()
 
CORE_API void Unindent ()
 
CORE_API void AppendLine ()
 
CORE_API void AppendLine (const FText &Text)
 
CORE_API void AppendLine (const FString &String)
 
CORE_API void AppendLine (const FName &Name)
 
CORE_API void AppendLineFormat (const FTextFormat &Pattern, const FFormatNamedArguments &Arguments)
 
CORE_API void AppendLineFormat (const FTextFormat &Pattern, const FFormatOrderedArguments &Arguments)
 
template<typename... ArgTypes>
void AppendLineFormat (FTextFormat Pattern, ArgTypes... Args)
 
CORE_API void Clear ()
 
CORE_API bool IsEmpty () const
 
CORE_API int32 GetNumLines () const
 
CORE_API FText ToText () const
 

Member Function Documentation

◆ AppendLine() [1/4]

void FTextBuilder::AppendLine ( )

Append an empty line to the builder, indented by the running indentation of the builder.

◆ AppendLine() [2/4]

void FTextBuilder::AppendLine ( const FName Name)

Append the given name line to the builder, indented by the running indentation of the builder.

◆ AppendLine() [3/4]

void FTextBuilder::AppendLine ( const FString &  String)

Append the given string line to the builder, indented by the running indentation of the builder.

◆ AppendLine() [4/4]

void FTextBuilder::AppendLine ( const FText Text)

Append the given text line to the builder, indented by the running indentation of the builder.

◆ AppendLineFormat() [1/3]

void FTextBuilder::AppendLineFormat ( const FTextFormat Pattern,
const FFormatNamedArguments Arguments 
)

Append the given formatted text line to the builder, indented by the running indentation of the builder.

◆ AppendLineFormat() [2/3]

void FTextBuilder::AppendLineFormat ( const FTextFormat Pattern,
const FFormatOrderedArguments Arguments 
)

Append the given formatted text line to the builder, indented by the running indentation of the builder.

◆ AppendLineFormat() [3/3]

template<typename... ArgTypes>
void FTextBuilder::AppendLineFormat ( FTextFormat  Pattern,
ArgTypes...  Args 
)
inline

Append the given formatted text line to the builder, indented by the running indentation of the builder.

◆ Clear()

void FTextBuilder::Clear ( )

Clear the builder and reset it to its default state.

◆ GetNumLines()

int32 FTextBuilder::GetNumLines ( ) const

Returns the number of lines.

◆ Indent()

void FTextBuilder::Indent ( )

Increase the running indentation of the builder.

◆ IsEmpty()

bool FTextBuilder::IsEmpty ( ) const

Check to see if the builder has any data.

◆ ToText()

FText FTextBuilder::ToText ( ) const

Build the current set of input into a FText.

◆ Unindent()

void FTextBuilder::Unindent ( )

Decrease the running indentation of the builder.


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