StringBuilder: AppendFormatEx

AppendFormatEx

Appends the string returned by processing a composite format string, which contains zero or more format items, to this instance. Each format item is replaced by the string representation of a single argument.

 Public Function AppendFormatEx(
	  ByRef Provider As IFormatProvider,
	  ByRef Format As String,
	  ParamArray Args ( ) As Variant ) As StringBuilder

Parameters

Provider: [ByRef] IFormatProvider. A custom formatting object that formats the arguments.
Format: [ByRef] String. The composite format string containing formatting information.
Args: [ByRef] Variant. The arguments to be formatted into the string.

Return Values

StringBuilder - This instance of StringBuilder.

Remarks

This method uses the composite formatting feature of VBCorLib to convert the value of an object to its text representation and embed that representation in the current StringBuilder object.

The Format parameter consists of zero or more runs of text intermixed with zero or more indexed placeholders, called format items, that correspond to values in the parameter list of this method. The formatting process replaces each format item with the string representation of the corresponding value.

The syntax of a format item is as follows:

{index[,length][:formatString]}

Elements in square brackets are optional. The following table describes each element.

Element	Description
index	The zero-based position in the parameter list of the object to be formatted. If the object specified by index is Nothing, the format item is replaced by an empty string. If there is no parameter in the index position, a FormatException is thrown.
,length	The minimum number of characters in the string representation of the parameter. If positive, the parameter is right-aligned; if negative, it is left-aligned.
:formatString	A standard or custom format string that is supported by the parameter.

The provider parameter specifies an IFormatProvider implementation that can provide formatting information for the objects in args. provider can be any of the following:

A CultureInfo object that provides culture-specific formatting information.
A NumberFormatInfo object that provides culture-specific formatting information for numeric values in Args.
A DateTimeFormatInfo object that provides culture-specific formatting information for date and time values in Args.
A custom IFormatProvider implementation that provides formatting information for one or more of the objects in Args. Typically, such an implementation also implements the ICustomFormatter interface.

If the Provider parameter is Nothing, format provider information is obtained from the current culture.

Args represents the objects to be formatted. Each format item in Format is replaced with the string representation of the corresponding object in args. If the format item includes formatString and the corresponding object in Args implements the IFormattable interface, then Args(index).ToString(formatString, provider) defines the formatting. Otherwise, Object.ToString(Args(index)) defines the formatting.

AppendFormatEx

Parameters

Return Values

Remarks

See Also