NGWS SDK Documentation  

This is preliminary documentation and subject to change.
To comment on this topic, please send us email at ngwssdk@microsoft.com. Thanks!

String.Format (String, Object[], IServiceObjectProvider)

Replaces zero or more format specifications with the appropriately formatted value of an object.

[Visual Basic]
Overloads Public Shared Function Format( _
   ByVal format As String, _
   ByVal args() As Object, _
   ByVal sop As IServiceObjectProvider _
) As String
[C#]
public static string Format(
   string format,
   object[] args,
   IServiceObjectProvider sop
);
[C++]
public: static String* Format(
   String* format,
   Object* args[],
   IServiceObjectProvider* sop
);
[JScript]
public static function Format(
   format : String,
   args : Object[],
   sop : IServiceObjectProvider
) : String;

Parameters

format
A string containing zero or more format specifications.
args
An array of objects to be formatted.
sop
The IServiceObjectProvider interface used to change the way in which formatting codes are interpreted by a type.

Return Value

A copy of the string is returned after replacing any format specifications with the appropriately formatted value.

Exceptions

Exception Type Condition
ArgumentNullException If the string or objects are null.
FormatException If the string is invalid.

Remarks

The format specifications are embedded within a string and are of the form {N:FormatString}, where N is a zero-based number indicating the argument that is to be formatted and FormatString is a format string. If args[N] implements IFormattable then args[N].Format (format, null) provides the formatting; otherwise args[N].ToString() provides the formatting. If args[N] is null then an empty string is used in its place.

The so p parameter specifies the format provider from which the NumberFormatInfo instance will be obtained. NumberFormatInfo supplies information such as the characters to be used for decimal and group separators, and determines the spelling and placement of currency symbols in monetary values. If sop is null, the numeric format information is obtained from the current locale.

To Pad With Spaces: It is possible to define a region within the String argument in which the formatted value can be left or right justified. The format specification has an optional integer field: {N[,M]:FormatString}. The magnitude of M indicates the minimum number of spaces for the region and the sign of M indicates whether the value should be left (negative values) or right (positive values) justified within the region.

ToString() is Used if the Format String is Omitted: The format string within a format specification is optional: {N[,M][:FormatString]}. When FormatString is omitted, the ToString() method of the argument specified by N is used to replace the format specification. If M is given, then the result of ToString() is padded with spaces as described above.

Example

If the string assigned to format is "Thank you for your purchase of {0:####} copies of Better Basket Weaving." and arg[0] is an Integer2 with the value 123, then the return value will be:

"Thank you for your
purchase of 123 copies of Better Basket Weaving."
If the String
assigned to format is "Brad's dog has {0, -8:G}
fleas." and arg[0] is an Integer2 with the value
42, then the return value will be:
"Brad's dog has
42      fleas."

See Also

String Class | String Members | System Namespace | String.Format Overload List | Object | IFormattable | IServiceObjectProvider