TextWriter.WriteLine Method

Definition

Writes data to the text stream, followed by a line terminator.

Overloads

WriteLine(String, Object, Object)

Writes a formatted string and a new line to the text stream, using the same semantics as the Format(String, Object, Object) method.

WriteLine(Char[], Int32, Int32)

Writes a subarray of characters to the text stream, followed by a line terminator.

WriteLine(String, Object[])

Writes out a formatted string and a new line to the text stream, using the same semantics as Format(String, Object).

WriteLine(String, Object)

Writes a formatted string and a new line to the text stream, using the same semantics as the Format(String, Object) method.

WriteLine(UInt64)

Writes the text representation of an 8-byte unsigned integer to the text stream, followed by a line terminator.

WriteLine(UInt32)

Writes the text representation of a 4-byte unsigned integer to the text stream, followed by a line terminator.

WriteLine(String, Object, Object, Object)

Writes out a formatted string and a new line to the text stream, using the same semantics as Format(String, Object).

WriteLine(StringBuilder)

Writes the text representation of a string builder to the text stream, followed by a line terminator.

WriteLine(String)

Writes a string to the text stream, followed by a line terminator.

WriteLine(Single)

Writes the text representation of a 4-byte floating-point value to the text stream, followed by a line terminator.

WriteLine(Double)

Writes the text representation of a 8-byte floating-point value to the text stream, followed by a line terminator.

WriteLine(Object)

Writes the text representation of an object to the text stream, by calling the ToString method on that object, followed by a line terminator.

WriteLine(Int64)

Writes the text representation of an 8-byte signed integer to the text stream, followed by a line terminator.

WriteLine(Int32)

Writes the text representation of a 4-byte signed integer to the text stream, followed by a line terminator.

WriteLine(Decimal)

Writes the text representation of a decimal value to the text stream, followed by a line terminator.

WriteLine(Char[])

Writes an array of characters to the text stream, followed by a line terminator.

WriteLine(Char)

Writes a character to the text stream, followed by a line terminator.

WriteLine(Boolean)

Writes the text representation of a Boolean value to the text stream, followed by a line terminator.

WriteLine()

Writes a line terminator to the text stream.

WriteLine(ReadOnlySpan<Char>)

Writes the text representation of a character span to the text stream, followed by a line terminator.

WriteLine(String, Object, Object)

Writes a formatted string and a new line to the text stream, using the same semantics as the Format(String, Object, Object) method.

public:
 virtual void WriteLine(System::String ^ format, System::Object ^ arg0, System::Object ^ arg1);
public virtual void WriteLine (string format, object arg0, object arg1);
abstract member WriteLine : string * obj * obj -> unit
override this.WriteLine : string * obj * obj -> unit
Public Overridable Sub WriteLine (format As String, arg0 As Object, arg1 As Object)

Parameters

format
String

A composite format string.

arg0
Object

The first object to format and write.

arg1
Object

The second object to format and write.

Exceptions

format is null.

An I/O error occurs.

format is not a valid composite format string.

-or-

The index of a format item is less than 0 (zero), or greater than or equal to the number of objects to be formatted (which, for this method overload, is two).

Remarks

This method uses composite formatting to convert the value of an object to its string representation and to embed that representation in a string. .NET provides extensive formatting support, which is described in greater detail in the following formatting topics:

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

The syntax of a format item is as follows:

{index[,length][:formatString]}

Elements in square brackets are optional. The following table describes each element. For more information about the composite formatting feature, including the syntax of a format item, see Composite Formatting.

Element Description
index The zero-based position in the parameter list of the object to be formatted. If the object specified by index is null, the format item is replaced by String.Empty. Because this overload has two objects in its parameter list, the value of index must always be 0 or 1. 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 object to be formatted. Possible values for formatString are the same as the values supported by the object's ToString(string format) method. If formatString is not specified and the object to be formatted implements the IFormattable interface, null is passed as the value of the format parameter that is used as the IFormattable.ToString format string.

The leading and trailing brace characters, "{" and "}", are required. To specify a single literal brace character in format, specify two leading or trailing brace characters; that is, "{{" or "}}".

This method does not search the specified string for individual newline characters (hexadecimal 0x000a) and replace them with NewLine.

If a specified object is not referenced in the format string, it is ignored.

The line terminator is defined by the CoreNewLine field.

For a list of common I/O tasks, see Common I/O Tasks.

See also

WriteLine(Char[], Int32, Int32)

Writes a subarray of characters to the text stream, followed by a line terminator.

public:
 virtual void WriteLine(cli::array <char> ^ buffer, int index, int count);
public virtual void WriteLine (char[] buffer, int index, int count);
abstract member WriteLine : char[] * int * int -> unit
override this.WriteLine : char[] * int * int -> unit
Public Overridable Sub WriteLine (buffer As Char(), index As Integer, count As Integer)

Parameters

buffer
Char[]

The character array from which data is read.

index
Int32

The character position in buffer at which to start reading data.

count
Int32

The maximum number of characters to write.

Exceptions

The buffer length minus index is less than count.

The buffer parameter is null.

index or count is negative.

An I/O error occurs.

Remarks

This method will write count characters of data into this TextWriter from the buffer character array starting at position index.

This overload is equivalent to calling the Write(Char[]) method followed by WriteLine for each character in buffer between index and (index + count).

The line terminator is defined by the CoreNewLine field.

For a list of common I/O tasks, see Common I/O Tasks.

See also

WriteLine(String, Object[])

Writes out a formatted string and a new line to the text stream, using the same semantics as Format(String, Object).

public:
 virtual void WriteLine(System::String ^ format, ... cli::array <System::Object ^> ^ arg);
public virtual void WriteLine (string format, params object[] arg);
abstract member WriteLine : string * obj[] -> unit
override this.WriteLine : string * obj[] -> unit
Public Overridable Sub WriteLine (format As String, ParamArray arg As Object())

Parameters

format
String

A composite format string.

arg
Object[]

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

Exceptions

A string or object is passed in as null.

An I/O error occurs.

format is not a valid composite format string.

-or-

The index of a format item is less than 0 (zero), or greater than or equal to the length of the arg array.

Remarks

This method uses composite formatting to convert the value of an object to its string representation and to embed that representation in a string. .NET provides extensive formatting support, which is described in greater detail in the following formatting topics:

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

The syntax of a format item is as follows:

{index[,length][:formatString]}

Elements in square brackets are optional. The following table describes each element. For more information about the composite formatting feature, including the syntax of a format item, see Composite Formatting.

Element Description
index The zero-based position in the parameter list of the object to be formatted. If the object specified by index is null, the format item is replaced by String.Empty. Because this overload has an array in its parameter list, the value of index must always be less than the length of the array. 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 object to be formatted. Possible values for formatString are the same as the values supported by the object's ToString(string format) method. If formatString is not specified and the object to be formatted implements the IFormattable interface, null is passed as the value of the format parameter that is used as the IFormattable.ToString format string.

The leading and trailing brace characters, "{" and "}", are required. To specify a single literal brace character in format, specify two leading or trailing brace characters; that is, "{{" or "}}".

This method does not search the specified string for individual newline characters (hexadecimal 0x000a) and replace them with NewLine.

If a specified object is not referenced in the format string, it is ignored.

The line terminator is defined by the CoreNewLine field.

For a list of common I/O tasks, see Common I/O Tasks.

See also

WriteLine(String, Object)

Writes a formatted string and a new line to the text stream, using the same semantics as the Format(String, Object) method.

public:
 virtual void WriteLine(System::String ^ format, System::Object ^ arg0);
public virtual void WriteLine (string format, object arg0);
abstract member WriteLine : string * obj -> unit
override this.WriteLine : string * obj -> unit
Public Overridable Sub WriteLine (format As String, arg0 As Object)

Parameters

format
String

A composite format string.

arg0
Object

The object to format and write.

Exceptions

format is null.

An I/O error occurs.

format is not a valid composite format string.

-or-

The index of a format item is less than 0 (zero), or greater than or equal to the number of objects to be formatted (which, for this method overload, is one).

Remarks

This method uses composite formatting to convert the value of an object to its string representation and to embed that representation in a string. .NET provides extensive formatting support, which is described in greater detail in the following formatting topics:

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

The syntax of a format item is as follows:

{index[,length][:formatString]}

Elements in square brackets are optional. The following table describes each element. For more information about the composite formatting feature, including the syntax of a format item, see Composite Formatting.

Element Description
index The zero-based position in the parameter list of the object to be formatted. If the object specified by index is null, the format item is replaced by String.Empty. Because this overload has only a single object in its parameter list, the value of index must always be 0. 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 object to be formatted. Possible values for formatString are the same as the values supported by the object's ToString(string format) method. If formatString is not specified and the object to be formatted implements the IFormattable interface, null is passed as the value of the format parameter that is used as the IFormattable.ToString format string.

The leading and trailing brace characters, "{" and "}", are required. To specify a single literal brace character in format, specify two leading or trailing brace characters; that is, "{{" or "}}".

This method does not search the specified string for individual newline characters (hexadecimal 0x000a) and replace them with NewLine.

If a specified object is not referenced in the format string, it is ignored.

The line terminator is defined by the CoreNewLine field.

For a list of common I/O tasks, see Common I/O Tasks.

See also

WriteLine(UInt64)

Important

This API is not CLS-compliant.

Writes the text representation of an 8-byte unsigned integer to the text stream, followed by a line terminator.

public:
 virtual void WriteLine(System::UInt64 value);
[System.CLSCompliant(false)]
public virtual void WriteLine (ulong value);
abstract member WriteLine : uint64 -> unit
override this.WriteLine : uint64 -> unit
Public Overridable Sub WriteLine (value As ULong)

Parameters

value
UInt64

The 8-byte unsigned integer to write.

Attributes

Exceptions

An I/O error occurs.

Remarks

The text representation of the specified value is produced by calling the UInt64.ToString method. The FormatProvider property, if not null, specifies the culture-specific formatting.

The line terminator is defined by the CoreNewLine field.

For a list of common I/O tasks, see Common I/O Tasks.

See also

WriteLine(UInt32)

Important

This API is not CLS-compliant.

Writes the text representation of a 4-byte unsigned integer to the text stream, followed by a line terminator.

public:
 virtual void WriteLine(System::UInt32 value);
[System.CLSCompliant(false)]
public virtual void WriteLine (uint value);
abstract member WriteLine : uint32 -> unit
override this.WriteLine : uint32 -> unit
Public Overridable Sub WriteLine (value As UInteger)

Parameters

value
UInt32

The 4-byte unsigned integer to write.

Attributes

Exceptions

An I/O error occurs.

Remarks

The text representation of the specified value is produced by calling the UInt32.ToString method. The FormatProvider property, if not null, specifies the culture-specific formatting.

The line terminator is defined by the CoreNewLine field.

For a list of common I/O tasks, see Common I/O Tasks.

See also

WriteLine(String, Object, Object, Object)

Writes out a formatted string and a new line to the text stream, using the same semantics as Format(String, Object).

public:
 virtual void WriteLine(System::String ^ format, System::Object ^ arg0, System::Object ^ arg1, System::Object ^ arg2);
public virtual void WriteLine (string format, object arg0, object arg1, object arg2);
abstract member WriteLine : string * obj * obj * obj -> unit
override this.WriteLine : string * obj * obj * obj -> unit
Public Overridable Sub WriteLine (format As String, arg0 As Object, arg1 As Object, arg2 As Object)

Parameters

format
String

A composite format string.

arg0
Object

The first object to format and write.

arg1
Object

The second object to format and write.

arg2
Object

The third object to format and write.

Exceptions

format is null.

An I/O error occurs.

format is not a valid composite format string.

-or-

The index of a format item is less than 0 (zero), or greater than or equal to the number of objects to be formatted (which, for this method overload, is three).

Remarks

This method uses composite formatting to convert the value of an object to its string representation and to embed that representation in a string. .NET provides extensive formatting support, which is described in greater detail in the following formatting topics:

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

The syntax of a format item is as follows:

{index[,length][:formatString]}

Elements in square brackets are optional. The following table describes each element. For more information about the composite formatting feature, including the syntax of a format item, see Composite Formatting.

Element Description
index The zero-based position in the parameter list of the object to be formatted. If the object specified by index is null, the format item is replaced by String.Empty. Because this overload has three objects in its parameter list, the value of index must always be 0, 1, or 2. 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 object to be formatted. Possible values for formatString are the same as the values supported by the object's ToString(string format) method. If formatString is not specified and the object to be formatted implements the IFormattable interface, null is passed as the value of the format parameter that is used as the IFormattable.ToString format string.

The leading and trailing brace characters, "{" and "}", are required. To specify a single literal brace character in format, specify two leading or trailing brace characters; that is, "{{" or "}}".

This method does not search the specified string for individual newline characters (hexadecimal 0x000a) and replace them with NewLine.

If a specified object is not referenced in the format string, it is ignored.

The line terminator is defined by the CoreNewLine field.

For a list of common I/O tasks, see Common I/O Tasks.

See also

WriteLine(StringBuilder)

Writes the text representation of a string builder to the text stream, followed by a line terminator.

public:
 virtual void WriteLine(System::Text::StringBuilder ^ value);
public virtual void WriteLine (System.Text.StringBuilder value);
abstract member WriteLine : System.Text.StringBuilder -> unit
override this.WriteLine : System.Text.StringBuilder -> unit
Public Overridable Sub WriteLine (value As StringBuilder)

Parameters

value
StringBuilder

The string, as a string builder, to write to the text stream.

Remarks

The text representation of the specified value is produced by calling the StringBuilder.ToString method.

The line terminator is defined by the CoreNewLine field.

For a list of common I/O tasks, see Common I/O Tasks.

WriteLine(String)

Writes a string to the text stream, followed by a line terminator.

public:
 virtual void WriteLine(System::String ^ value);
public virtual void WriteLine (string value);
abstract member WriteLine : string -> unit
override this.WriteLine : string -> unit
Public Overridable Sub WriteLine (value As String)

Parameters

value
String

The string to write. If value is null, only the line terminator is written.

Exceptions

An I/O error occurs.

Remarks

This overload is equivalent to the Write(Char[]) overload.

The line terminator is defined by the CoreNewLine field.

This method does not search the specified string for individual newline characters (hexadecimal 0x000a) and replace them with NewLine.

For a list of common I/O tasks, see Common I/O Tasks.

See also

WriteLine(Single)

Writes the text representation of a 4-byte floating-point value to the text stream, followed by a line terminator.

public:
 virtual void WriteLine(float value);
public virtual void WriteLine (float value);
abstract member WriteLine : single -> unit
override this.WriteLine : single -> unit
Public Overridable Sub WriteLine (value As Single)

Parameters

value
Single

The 4-byte floating-point value to write.

Exceptions

An I/O error occurs.

Remarks

The FormatProvider property, if not null, specifies the culture-specific formatting. For a list of common I/O tasks, see Common I/O Tasks.

The line terminator is defined by the CoreNewLine field.

See also

WriteLine(Double)

Writes the text representation of a 8-byte floating-point value to the text stream, followed by a line terminator.

public:
 virtual void WriteLine(double value);
public virtual void WriteLine (double value);
abstract member WriteLine : double -> unit
override this.WriteLine : double -> unit
Public Overridable Sub WriteLine (value As Double)

Parameters

value
Double

The 8-byte floating-point value to write.

Exceptions

An I/O error occurs.

Remarks

The FormatProvider property, if not null, specifies the culture-specific formatting. For a list of common I/O tasks, see Common I/O Tasks.

The line terminator is defined by the CoreNewLine field.

See also

WriteLine(Object)

Writes the text representation of an object to the text stream, by calling the ToString method on that object, followed by a line terminator.

public:
 virtual void WriteLine(System::Object ^ value);
public virtual void WriteLine (object value);
abstract member WriteLine : obj -> unit
override this.WriteLine : obj -> unit
Public Overridable Sub WriteLine (value As Object)

Parameters

value
Object

The object to write. If value is null, only the line terminator is written.

Exceptions

An I/O error occurs.

Remarks

This overload is equivalent to the Write(String, Object) overload. The FormatProvider property, if not null, specifies the culture-specific formatting.

The line terminator is defined by the CoreNewLine field.

For a list of common I/O tasks, see Common I/O Tasks.

See also

WriteLine(Int64)

Writes the text representation of an 8-byte signed integer to the text stream, followed by a line terminator.

public:
 virtual void WriteLine(long value);
public virtual void WriteLine (long value);
abstract member WriteLine : int64 -> unit
override this.WriteLine : int64 -> unit
Public Overridable Sub WriteLine (value As Long)

Parameters

value
Int64

The 8-byte signed integer to write.

Exceptions

An I/O error occurs.

Remarks

The text representation of the specified value is produced by calling the Int64.ToString method. The TextWriter.FormatProvider property, if not null, specifies the culture-specific formatting.

The line terminator is defined by the CoreNewLine field.

For a list of common I/O tasks, see Common I/O Tasks.

See also

WriteLine(Int32)

Writes the text representation of a 4-byte signed integer to the text stream, followed by a line terminator.

public:
 virtual void WriteLine(int value);
public virtual void WriteLine (int value);
abstract member WriteLine : int -> unit
override this.WriteLine : int -> unit
Public Overridable Sub WriteLine (value As Integer)

Parameters

value
Int32

The 4-byte signed integer to write.

Exceptions

An I/O error occurs.

Remarks

The text representation of the specified value is produced by calling the Int32.ToString method. The TextWriter.FormatProvider property, if not null, specifies the culture-specific formatting.

The line terminator is defined by the CoreNewLine field.

For a list of common I/O tasks, see Common I/O Tasks.

See also

WriteLine(Decimal)

Writes the text representation of a decimal value to the text stream, followed by a line terminator.

public:
 virtual void WriteLine(System::Decimal value);
public virtual void WriteLine (decimal value);
abstract member WriteLine : decimal -> unit
override this.WriteLine : decimal -> unit
Public Overridable Sub WriteLine (value As Decimal)

Parameters

value
Decimal

The decimal value to write.

Exceptions

An I/O error occurs.

Remarks

The FormatProvider property, if not null, specifies the culture-specific formatting. For a list of common I/O tasks, see Common I/O Tasks.

The line terminator is defined by the CoreNewLine field.

See also

WriteLine(Char[])

Writes an array of characters to the text stream, followed by a line terminator.

public:
 virtual void WriteLine(cli::array <char> ^ buffer);
public virtual void WriteLine (char[] buffer);
abstract member WriteLine : char[] -> unit
override this.WriteLine : char[] -> unit
Public Overridable Sub WriteLine (buffer As Char())

Parameters

buffer
Char[]

The character array from which data is read.

Exceptions

An I/O error occurs.

Remarks

All the characters in buffer are written to the underlying stream. If the character array is null, only the line terminator is written.

This overload is equivalent to Write(Char[]) followed by WriteLine() .

The line terminator is defined by the CoreNewLine field.

For a list of common I/O tasks, see Common I/O Tasks.

See also

WriteLine(Char)

Writes a character to the text stream, followed by a line terminator.

public:
 virtual void WriteLine(char value);
public virtual void WriteLine (char value);
abstract member WriteLine : char -> unit
override this.WriteLine : char -> unit
Public Overridable Sub WriteLine (value As Char)

Parameters

value
Char

The character to write to the text stream.

Exceptions

An I/O error occurs.

Remarks

This overload is equivalent to Write(Char) followed by WriteLine() .

The line terminator is defined by the CoreNewLine field.

For a list of common I/O tasks, see Common I/O Tasks.

See also

WriteLine(Boolean)

Writes the text representation of a Boolean value to the text stream, followed by a line terminator.

public:
 virtual void WriteLine(bool value);
public virtual void WriteLine (bool value);
abstract member WriteLine : bool -> unit
override this.WriteLine : bool -> unit
Public Overridable Sub WriteLine (value As Boolean)

Parameters

value
Boolean

The Boolean value to write.

Exceptions

An I/O error occurs.

Remarks

The text representation of the specified value is produced by calling the Boolean.ToString method.

This method outputs either Boolean.TrueString or Boolean.FalseString.

The line terminator is defined by the CoreNewLine field.

For a list of common I/O tasks, see Common I/O Tasks.

See also

WriteLine()

Writes a line terminator to the text stream.

public:
 virtual void WriteLine();
public virtual void WriteLine ();
abstract member WriteLine : unit -> unit
override this.WriteLine : unit -> unit
Public Overridable Sub WriteLine ()

Exceptions

An I/O error occurs.

Remarks

The line terminator is defined by the CoreNewLine field.

For a list of common I/O tasks, see Common I/O Tasks.

See also

WriteLine(ReadOnlySpan<Char>)

Writes the text representation of a character span to the text stream, followed by a line terminator.

public:
 virtual void WriteLine(ReadOnlySpan<char> buffer);
public virtual void WriteLine (ReadOnlySpan<char> buffer);
abstract member WriteLine : ReadOnlySpan<char> -> unit
override this.WriteLine : ReadOnlySpan<char> -> unit
Public Overridable Sub WriteLine (buffer As ReadOnlySpan(Of Char))

Parameters

buffer
ReadOnlySpan<Char>

The char span value to write to the text stream.

Remarks

The text representation of the specified value is produced by calling the ReadOnlySpan.ToString method.

The line terminator is defined by the CoreNewLine field.

For a list of common I/O tasks, see Common I/O Tasks.

Applies to