MetalamaAPI documentationFlashtrace APIFlashtrace.​MessagesFormatted­Message­BuilderFormatted
Open sandboxFocus

FormattedMessageBuilder.Formatted Method

Formatted(String, Object[])

Creates a formatted string with an arbitrary number of parameters.

Declaration
public static FormattedMessageArray Formatted(string formattingString, object[] args)
Parameters
Type Name Description
String formattingString

The formatting string.

Object[] args
Returns
Type Description
FormattedMessageArray

Formatted(String)

Creates a text message with no formatting string parameter.

Declaration
public static FormattedMessage Formatted(string text)
Parameters
Type Name Description
String text
Returns
Type Description
FormattedMessage

Formatted<T1>(String, T1)

Creates a formatted string with 1 parameter.

Declaration
public static FormattedMessage<T1> Formatted<T1>(string formattingString, T1 arg1)
Parameters
Type Name Description
String formattingString

The text of the log record, including parameters (e.g. Opening {Path} file {ShareMode} sharing mode).

T1 arg1

Value of the first parameter.

Returns
Type Description
FormattedMessage<T1>
Type Parameters
Name Description
T1

Type of the first parameter.

Formatted<T1, T2>(String, T1, T2)

Creates a formatted string with 2 parameters.

Declaration
public static FormattedMessage<T1, T2> Formatted<T1, T2>(string formattingString, T1 arg1, T2 arg2)
Parameters
Type Name Description
String formattingString

The text of the log record, including parameters (e.g. Opening {Path} file {ShareMode} sharing mode).

T1 arg1

Value of the first parameter.

T2 arg2

Value of the second parameter.

Returns
Type Description
FormattedMessage<T1, T2>
Type Parameters
Name Description
T1

Type of the first parameter.

T2

Type of the second parameter.

Formatted<T1, T2, T3>(String, T1, T2, T3)

Creates a formatted string with 3 parameters.

Declaration
public static FormattedMessage<T1, T2, T3> Formatted<T1, T2, T3>(string formattingString, T1 arg1, T2 arg2, T3 arg3)
Parameters
Type Name Description
String formattingString

The text of the log record, including parameters (e.g. Opening {Path} file {ShareMode} sharing mode).

T1 arg1

Value of the first parameter.

T2 arg2

Value of the second parameter.

T3 arg3

Value of the third parameter.

Returns
Type Description
FormattedMessage<T1, T2, T3>
Type Parameters
Name Description
T1

Type of the first parameter.

T2

Type of the second parameter.

T3

Type of the third parameter.

Formatted<T1, T2, T3, T4>(String, T1, T2, T3, T4)

Creates a formatted string with 4 parameters.

Declaration
public static FormattedMessage<T1, T2, T3, T4> Formatted<T1, T2, T3, T4>(string formattingString, T1 arg1, T2 arg2, T3 arg3, T4 arg4)
Parameters
Type Name Description
String formattingString

The text of the log record, including parameters (e.g. Opening {Path} file {ShareMode} sharing mode).

T1 arg1

Value of the first parameter.

T2 arg2

Value of the second parameter.

T3 arg3

Value of the third parameter.

T4 arg4

Value of the 4-th parameter.

Returns
Type Description
FormattedMessage<T1, T2, T3, T4>
Type Parameters
Name Description
T1

Type of the first parameter.

T2

Type of the second parameter.

T3

Type of the third parameter.

T4

Type of the 4-th parameter.

Formatted<T1, T2, T3, T4, T5>(String, T1, T2, T3, T4, T5)

Creates a formatted string with 5 parameters.

Declaration
public static FormattedMessage<T1, T2, T3, T4, T5> Formatted<T1, T2, T3, T4, T5>(string formattingString, T1 arg1, T2 arg2, T3 arg3, T4 arg4, T5 arg5)
Parameters
Type Name Description
String formattingString

The text of the log record, including parameters (e.g. Opening {Path} file {ShareMode} sharing mode).

T1 arg1

Value of the first parameter.

T2 arg2

Value of the second parameter.

T3 arg3

Value of the third parameter.

T4 arg4

Value of the 4-th parameter.

T5 arg5

Value of the 5-th parameter.

Returns
Type Description
FormattedMessage<T1, T2, T3, T4, T5>
Type Parameters
Name Description
T1

Type of the first parameter.

T2

Type of the second parameter.

T3

Type of the third parameter.

T4

Type of the 4-th parameter.

T5

Type of the 5-th parameter.

Formatted<T1, T2, T3, T4, T5, T6>(String, T1, T2, T3, T4, T5, T6)

Creates a formatted string with 6 parameters.

Declaration
public static FormattedMessage<T1, T2, T3, T4, T5, T6> Formatted<T1, T2, T3, T4, T5, T6>(string formattingString, T1 arg1, T2 arg2, T3 arg3, T4 arg4, T5 arg5, T6 arg6)
Parameters
Type Name Description
String formattingString

The text of the log record, including parameters (e.g. Opening {Path} file {ShareMode} sharing mode).

T1 arg1

Value of the first parameter.

T2 arg2

Value of the second parameter.

T3 arg3

Value of the third parameter.

T4 arg4

Value of the 4-th parameter.

T5 arg5

Value of the 5-th parameter.

T6 arg6

Value of the 6-th parameter.

Returns
Type Description
FormattedMessage<T1, T2, T3, T4, T5, T6>
Type Parameters
Name Description
T1

Type of the first parameter.

T2

Type of the second parameter.

T3

Type of the third parameter.

T4

Type of the 4-th parameter.

T5

Type of the 5-th parameter.

T6

Type of the 6-th parameter.

Formatted<T1, T2, T3, T4, T5, T6, T7>(String, T1, T2, T3, T4, T5, T6, T7)

Creates a formatted string with 7 parameters.

Declaration
public static FormattedMessage<T1, T2, T3, T4, T5, T6, T7> Formatted<T1, T2, T3, T4, T5, T6, T7>(string formattingString, T1 arg1, T2 arg2, T3 arg3, T4 arg4, T5 arg5, T6 arg6, T7 arg7)
Parameters
Type Name Description
String formattingString

The text of the log record, including parameters (e.g. Opening {Path} file {ShareMode} sharing mode).

T1 arg1

Value of the first parameter.

T2 arg2

Value of the second parameter.

T3 arg3

Value of the third parameter.

T4 arg4

Value of the 4-th parameter.

T5 arg5

Value of the 5-th parameter.

T6 arg6

Value of the 6-th parameter.

T7 arg7

Value of the 7-th parameter.

Returns
Type Description
FormattedMessage<T1, T2, T3, T4, T5, T6, T7>
Type Parameters
Name Description
T1

Type of the first parameter.

T2

Type of the second parameter.

T3

Type of the third parameter.

T4

Type of the 4-th parameter.

T5

Type of the 5-th parameter.

T6

Type of the 6-th parameter.

T7

Type of the 7-th parameter.

Formatted<T1, T2, T3, T4, T5, T6, T7, T8>(String, T1, T2, T3, T4, T5, T6, T7, T8)

Creates a formatted string with 8 parameters.

Declaration
public static FormattedMessage<T1, T2, T3, T4, T5, T6, T7, T8> Formatted<T1, T2, T3, T4, T5, T6, T7, T8>(string formattingString, T1 arg1, T2 arg2, T3 arg3, T4 arg4, T5 arg5, T6 arg6, T7 arg7, T8 arg8)
Parameters
Type Name Description
String formattingString

The text of the log record, including parameters (e.g. Opening {Path} file {ShareMode} sharing mode).

T1 arg1

Value of the first parameter.

T2 arg2

Value of the second parameter.

T3 arg3

Value of the third parameter.

T4 arg4

Value of the 4-th parameter.

T5 arg5

Value of the 5-th parameter.

T6 arg6

Value of the 6-th parameter.

T7 arg7

Value of the 7-th parameter.

T8 arg8

Value of the 8-th parameter.

Returns
Type Description
FormattedMessage<T1, T2, T3, T4, T5, T6, T7, T8>
Type Parameters
Name Description
T1

Type of the first parameter.

T2

Type of the second parameter.

T3

Type of the third parameter.

T4

Type of the 4-th parameter.

T5

Type of the 5-th parameter.

T6

Type of the 6-th parameter.

T7

Type of the 7-th parameter.

T8

Type of the 8-th parameter.

Formatted<T1, T2, T3, T4, T5, T6, T7, T8, T9>(String, T1, T2, T3, T4, T5, T6, T7, T8, T9)

Creates a formatted string with 9 parameters.

Declaration
public static FormattedMessage<T1, T2, T3, T4, T5, T6, T7, T8, T9> Formatted<T1, T2, T3, T4, T5, T6, T7, T8, T9>(string formattingString, T1 arg1, T2 arg2, T3 arg3, T4 arg4, T5 arg5, T6 arg6, T7 arg7, T8 arg8, T9 arg9)
Parameters
Type Name Description
String formattingString

The text of the log record, including parameters (e.g. Opening {Path} file {ShareMode} sharing mode).

T1 arg1

Value of the first parameter.

T2 arg2

Value of the second parameter.

T3 arg3

Value of the third parameter.

T4 arg4

Value of the 4-th parameter.

T5 arg5

Value of the 5-th parameter.

T6 arg6

Value of the 6-th parameter.

T7 arg7

Value of the 7-th parameter.

T8 arg8

Value of the 8-th parameter.

T9 arg9

Value of the 9-th parameter.

Returns
Type Description
FormattedMessage<T1, T2, T3, T4, T5, T6, T7, T8, T9>
Type Parameters
Name Description
T1

Type of the first parameter.

T2

Type of the second parameter.

T3

Type of the third parameter.

T4

Type of the 4-th parameter.

T5

Type of the 5-th parameter.

T6

Type of the 6-th parameter.

T7

Type of the 7-th parameter.

T8

Type of the 8-th parameter.

T9

Type of the 9-th parameter.

Formatted<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10>(String, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10)

Creates a formatted string with 10 parameters.

Declaration
public static FormattedMessage<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10> Formatted<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10>(string formattingString, T1 arg1, T2 arg2, T3 arg3, T4 arg4, T5 arg5, T6 arg6, T7 arg7, T8 arg8, T9 arg9, T10 arg10)
Parameters
Type Name Description
String formattingString

The text of the log record, including parameters (e.g. Opening {Path} file {ShareMode} sharing mode).

T1 arg1

Value of the first parameter.

T2 arg2

Value of the second parameter.

T3 arg3

Value of the third parameter.

T4 arg4

Value of the 4-th parameter.

T5 arg5

Value of the 5-th parameter.

T6 arg6

Value of the 6-th parameter.

T7 arg7

Value of the 7-th parameter.

T8 arg8

Value of the 8-th parameter.

T9 arg9

Value of the 9-th parameter.

T10 arg10

Value of the 10-th parameter.

Returns
Type Description
FormattedMessage<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10>
Type Parameters
Name Description
T1

Type of the first parameter.

T2

Type of the second parameter.

T3

Type of the third parameter.

T4

Type of the 4-th parameter.

T5

Type of the 5-th parameter.

T6

Type of the 6-th parameter.

T7

Type of the 7-th parameter.

T8

Type of the 8-th parameter.

T9

Type of the 9-th parameter.

T10

Type of the 10-th parameter.