System.String.Format Method

Replaces the format items in a specified string with the string representation of two specified objects.

Syntax

public static string Format (string format, object arg0, object arg1)

Parameters

format
A composite format string.
arg0
The first object to format.
arg1
The second object to format.

Returns

A copy of format in which format items are replaced by the string representations of arg0 and arg1.

Exceptions

TypeReason
ArgumentNullException format is a null reference.
FormatException

format is invalid.

-or-

The number indicating an argument to be formatted is less than zero, or greater than or equal to the number of provided objects to be formatted (2).

Remarks

Note:

For examples and comprehensive usage information about this and other overloads of the Format method, see the erload:System.String.Format overload summary.

Example

The following example demonstrates the string.Format(string, object) method.

C# Example

using System;
public class StringFormat {
  public static void Main() {
  Console.WriteLine( String.Format("The temperature today oscillated between {0:####} and {1:####} degrees.", 78, 100) );
  Console.WriteLine( String.Format("The temperature today oscillated between {0:0000} and {1:0000} degrees.", 78, 100) );
  Console.WriteLine( "The temperature today oscillated between {0, -4} and {1, -4} degrees.", 78, 100 );
   }
}

The output is

Example

The temperature today oscillated between 78 and 100 degrees.
The temperature today oscillated between 0078 and 0100 degrees.
The temperature today oscillated between 78   and 100  degrees.

Requirements

Namespace: System
Assembly: mscorlib (in mscorlib.dll)
Assembly Versions: 1.0.5000.0, 2.0.0.0, 4.0.0.0