Appends a formatted string and the default line terminator, which contains zero or more format specifications, to this instance. Each format specification is replaced by the string representation of a corresponding object argument.

Namespace: System.Extensions.Text
Assembly: System.Extensions (in System.Extensions.dll) Version: 0.0.0.5 (0.0.0.5)

Syntax

C#
public static StringBuilder AppendFormatLine(
	this StringBuilder builder,
	string format,
	params Object[] args
)
Visual Basic
<ExtensionAttribute> 
Public Shared Function AppendFormatLine ( 
	builder As StringBuilder,
	format As String,
	ParamArray args As Object()
) As StringBuilder
Visual C++
public:
[ExtensionAttribute]
static StringBuilder^ AppendFormatLine(
	StringBuilder^ builder, 
	String^ format, 
	... array<Object^>^ args
)
F#
static member AppendFormatLine : 
        builder : StringBuilder * 
        format : string * 
        args : Object[] -> StringBuilder 

Parameters

builder
Type: System.Text..::..StringBuilder
The StringBuilder instance to append text to.
format
Type: System..::..String
A string containing zero or more format specifications.
args
Type: array<System..::..Object>[]()[][]
An array of objects to format.

Return Value

Type: StringBuilder
A reference to this instance with format appended. Any format specifications in format is replaced by the string representation of the corresponding object argument.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type StringBuilder. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Exceptions

ExceptionCondition
System..::..ArgumentNullExceptionformat is null.
System..::..ArgumentOutOfRangeExceptionEnlarging the value of this instance would exceed MaxCapacity.
System..::..FormatExceptionformat is invalid.

See Also