Development · Native API migration preview · Coverage validation in progress Published release →

API Browser

Member group

Format

Declaring type: String
Module: System
Assembly: System.Runtime.dll
Source file: String.rvn

Overloads / Variants

Format

static func Format(culture: Culture, format: string, arg0: object?, arg1: object?, arg2: object?) -> string

Source file: String.rvn

Formats indexed arguments with escaped braces and optional grapheme alignment. culture: Supported culture supplied to every Formattable argument. format: Composite text using {index[,alignment][:format]}; {{ and }} escape braces. arg0: Values formatted through ToString; null produces empty text. arg1: Values formatted through ToString; null produces empty text. arg2: Values formatted through ToString; null produces empty text. Formatted UTF-8 text; unchanged literal-only input is reused. Development API. Type-specific specifiers dispatch through Formattable; other values use ToString. Formattable receives the supplied culture; no ambient culture is read. Custom providers are unsupported. Invalid syntax/indexes and output over 65536 bytes fault. Alignment counts graphemes, not terminal columns. Fixed-arity overloads avoid an argument array; value arguments may box.

Parameters

Name Type Description
culture Culture
format String
arg0 Object?
arg1 Object?
arg2 Object?

Return value

String

Format

static func Format(culture: Culture, format: string, arg0: object?, arg1: object?) -> string

Source file: String.rvn

Formats indexed arguments with escaped braces and optional grapheme alignment. culture: Supported culture supplied to every Formattable argument. format: Composite text using {index[,alignment][:format]}; {{ and }} escape braces. arg0: Values formatted through ToString; null produces empty text. arg1: Values formatted through ToString; null produces empty text. Formatted UTF-8 text; unchanged literal-only input is reused. Development API. Type-specific specifiers dispatch through Formattable; other values use ToString. Formattable receives the supplied culture; no ambient culture is read. Custom providers are unsupported. Invalid syntax/indexes and output over 65536 bytes fault. Alignment counts graphemes, not terminal columns. Fixed-arity overloads avoid an argument array; value arguments may box.

Parameters

Name Type Description
culture Culture
format String
arg0 Object?
arg1 Object?

Return value

String

Format

static func Format(culture: Culture, format: string, arg0: object?) -> string

Source file: String.rvn

Formats indexed arguments with escaped braces and optional grapheme alignment. culture: Supported culture supplied to every Formattable argument. format: Composite text using {index[,alignment][:format]}; {{ and }} escape braces. arg0: Values formatted through ToString; null produces empty text. Formatted UTF-8 text; unchanged literal-only input is reused. Development API. Type-specific specifiers dispatch through Formattable; other values use ToString. Formattable receives the supplied culture; no ambient culture is read. Custom providers are unsupported. Invalid syntax/indexes and output over 65536 bytes fault. Alignment counts graphemes, not terminal columns. Fixed-arity overloads avoid an argument array; value arguments may box.

Parameters

Name Type Description
culture Culture
format String
arg0 Object?

Return value

String

Format

static func Format(culture: Culture, format: string, params arguments: object?[]) -> string

Source file: String.rvn

Formats indexed arguments with escaped braces and optional grapheme alignment. culture: Supported culture supplied to every Formattable argument. format: Composite text using {index[,alignment][:format]}; {{ and }} escape braces. arguments: Values formatted through ToString; null produces empty text. Formatted UTF-8 text; unchanged literal-only input is reused. Development API. Type-specific specifiers dispatch through Formattable; other values use ToString. Formattable receives the supplied culture; no ambient culture is read. Custom providers are unsupported. Invalid syntax/indexes and output over 65536 bytes fault. Alignment counts graphemes, not terminal columns. Fixed-arity overloads avoid an argument array; value arguments may box.

Parameters

Name Type Description
culture Culture
format String
arguments Object?[]

Return value

String

Format

static func Format(format: string, arg0: object?, arg1: object?, arg2: object?) -> string

Source file: String.rvn

Formats indexed arguments with escaped braces and optional grapheme alignment.

Parameters

Name Type Description
format String Composite text using {index[,alignment][:format]}; {{ and }} escape braces.
arg0 Object? Values formatted through ToString; null produces empty text.
arg1 Object? Values formatted through ToString; null produces empty text.
arg2 Object? Values formatted through ToString; null produces empty text.

Return value

String

Formatted UTF-8 text; unchanged literal-only input is reused.

Remarks

Development API. Type-specific specifiers dispatch through Formattable; other values use ToString. Formattable receives one Culture.Current snapshot per call; explicit Culture overloads are available. Custom providers are unsupported. Invalid syntax/indexes and output over 65536 bytes fault. Alignment counts graphemes, not terminal columns. Fixed-arity overloads avoid an argument array; value arguments may box.

Format

static func Format(format: string, arg0: object?, arg1: object?) -> string

Source file: String.rvn

Formats indexed arguments with escaped braces and optional grapheme alignment.

Parameters

Name Type Description
format String Composite text using {index[,alignment][:format]}; {{ and }} escape braces.
arg0 Object? Values formatted through ToString; null produces empty text.
arg1 Object? Values formatted through ToString; null produces empty text.

Return value

String

Formatted UTF-8 text; unchanged literal-only input is reused.

Remarks

Development API. Type-specific specifiers dispatch through Formattable; other values use ToString. Formattable receives one Culture.Current snapshot per call; explicit Culture overloads are available. Custom providers are unsupported. Invalid syntax/indexes and output over 65536 bytes fault. Alignment counts graphemes, not terminal columns. Fixed-arity overloads avoid an argument array; value arguments may box.

Format

static func Format(format: string, arg0: object?) -> string

Source file: String.rvn

Formats indexed arguments with escaped braces and optional grapheme alignment.

Parameters

Name Type Description
format String Composite text using {index[,alignment][:format]}; {{ and }} escape braces.
arg0 Object? Values formatted through ToString; null produces empty text.

Return value

String

Formatted UTF-8 text; unchanged literal-only input is reused.

Remarks

Development API. Type-specific specifiers dispatch through Formattable; other values use ToString. Formattable receives one Culture.Current snapshot per call; explicit Culture overloads are available. Custom providers are unsupported. Invalid syntax/indexes and output over 65536 bytes fault. Alignment counts graphemes, not terminal columns. Fixed-arity overloads avoid an argument array; value arguments may box.

Format

static func Format(format: string, params arguments: object?[]) -> string

Source file: String.rvn

Formats indexed arguments with escaped braces and optional grapheme alignment.

Parameters

Name Type Description
format String Composite text using {index[,alignment][:format]}; {{ and }} escape braces.
arguments Object?[] Values formatted through ToString; null produces empty text.

Return value

String

Formatted UTF-8 text; unchanged literal-only input is reused.

Remarks

Development API. Type-specific specifiers dispatch through Formattable; other values use ToString. Formattable receives one Culture.Current snapshot per call; explicit Culture overloads are available. Custom providers are unsupported. Invalid syntax/indexes and output over 65536 bytes fault. Alignment counts graphemes, not terminal columns. Fixed-arity overloads avoid an argument array; value arguments may box.