FormattableString Class

Reference

Definition

Namespace:: System

Assemblies:: mscorlib.dll, System.Runtime.dll

Assembly:: System.Runtime.dll

Assembly:: mscorlib.dll

Assembly:: netstandard.dll

Source:: FormattableString.cs

Source:: FormattableString.cs

Source:: FormattableString.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public ref class FormattableString abstract : IFormattable

public abstract class FormattableString : IFormattable

type FormattableString = class
    interface IFormattable

Public MustInherit Class FormattableString
Implements IFormattable

Inheritance: Object
FormattableString

Implements: IFormattable

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

CurrentCulture(FormattableString)	Returns a result string in which arguments are formatted by using the conventions of the current culture.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetArgument(Int32)	Returns the argument at the specified index position.
GetArguments()	Returns an object array that contains one or more objects to format.
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
Invariant(FormattableString)	Returns a result string in which arguments are formatted by using the conventions of the invariant culture.
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
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.

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

Jaa