.NET Framework Class Library
StringFormat Method (String, Object)

Replaces the format item in a specified string with the string representation of a corresponding object in a specified array.

Namespace:   System
Assembly:  mscorlib (in mscorlib.dll)
Syntax
Public Shared Function Format ( _
	format As [%$TOPIC/b1csw23d_en-us_VS_110_1_0_0_0_0%], _
	ParamArray args As [%$TOPIC/b1csw23d_en-us_VS_110_1_0_0_0_1%]() _
) As [%$TOPIC/b1csw23d_en-us_VS_110_1_0_0_0_2%]
public static [%$TOPIC/b1csw23d_en-us_VS_110_1_0_1_0_0%] Format(
	[%$TOPIC/b1csw23d_en-us_VS_110_1_0_1_0_1%] format,
	params [%$TOPIC/b1csw23d_en-us_VS_110_1_0_1_0_2%][] args
)
public:
static [%$TOPIC/b1csw23d_en-us_VS_110_1_0_2_0_0%]^ Format(
	[%$TOPIC/b1csw23d_en-us_VS_110_1_0_2_0_1%]^ format, 
	... array<[%$TOPIC/b1csw23d_en-us_VS_110_1_0_2_0_2%]^>^ args
)
static member Format : 
        format:[%$TOPIC/b1csw23d_en-us_VS_110_1_0_3_0_0%] * 
        args:[%$TOPIC/b1csw23d_en-us_VS_110_1_0_3_0_1%][] -> [%$TOPIC/b1csw23d_en-us_VS_110_1_0_3_0_2%]

Parameters

format
Type: SystemString

A composite format string.

args
Type: SystemObject

An object array that contains zero or more objects to format.

Return Value

Type: SystemString
A copy of format in which the format items have been replaced by the string representation of the corresponding objects in args.
Exceptions
ExceptionCondition
ArgumentNullException

format or args is .

FormatException

format is invalid.

-or-

The index of a format item is less than zero, or greater than or equal to the length of the args array.

Remarks
NoteNote

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

Version Information

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone Silverlight 8.1, Windows Phone Silverlight 8
Platforms

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.