FormattableString Class

Definition

Represents a composite format string, along with the arguments to be formatted.

public abstract class FormattableString : IFormattable
Inheritance
FormattableString
Implements

Remarks

A composite format string consists of fixed text intermixed with indexed placeholders, called format items, that correspond to the objects in the list. The formatting operation yields a result string that consists of the original fixed text intermixed with the string representation of the objects in the list. Composite formatting is supported by methods such as String.Format, Console.WriteLine, and StringBuilder.AppendFormat. For more information on composite formatting, see Composite Formatting.

A FormattableString instance may result from an interpolated string in C# or Visual Basic.

Constructors

FormattableString()

Instantiates a new instance of the FormattableString class.

Properties

ArgumentCount

Gets the number of arguments to be formatted.

Format

Returns the composite format string.

Methods

GetArgument(Int32)

Returns the argument at the specified index position.

GetArguments()

Returns an object array that contains one or more objects to format.

Invariant(FormattableString)

Returns a result string in which arguments are formatted by using the conventions of the invariant culture.

ToString()

Returns the string that results from formatting the composite format string along with its arguments by using the formatting conventions of the current culture.

ToString(IFormatProvider)

Returns the string that results from formatting the composite format string along with its arguments by using the formatting conventions of a specified culture.

Equals(Object) Inherited from Object
Equals(Object, Object) Inherited from Object
GetHashCode() Inherited from Object
GetType() Inherited from Object
MemberwiseClone() Inherited from Object
ReferenceEquals(Object, Object) Inherited from Object

Explicit Interface Implementations

IFormattable.ToString(String, IFormatProvider)

Returns the string that results from formatting the format string along with its arguments by using the formatting conventions of a specified culture.

Applies to