System.IO.TextWriter Class

Assembly: Mscorlib.dll
Namespace: System.IO
Summary
Represents a writer that can write a sequential series of characters. This class is abstract.
C# Syntax:
[Serializable]
public abstract class TextWriter : MarshalByRefObject, IDisposable
Remarks
TextWriter is designed for character output, whereas the Stream class is designed for byte input and output and the BinaryWriter class is designed for writing primitive types in binary rather than text. All the Write methods of TextWriter having primitive data types as parameters write out the values as strings.

By default, a TextWriter is not thread safe. See TextWriter.Synchronized for a thread-safe wrapper.

A derived class must minimally implement the Write (Char) method in order to make a useful instance of TextWriter.

See also:
System.IO Namespace

System.IO.TextWriter Member List:

Public Fields
Null
Public Properties
Encoding Read-only

When overridden in a derived class, returns the Encoding in which the output is written.
FormatProvider Read-only

Gets an object that controls formatting.
NewLine Read-write

Gets or sets the line terminator string used by the current TextWriter.
Public Methods
Close Closes the current writer and releases any system resources associated with the writer.
CreateObjRef
(inherited from System.MarshalByRefObject)		 See base class member description: System.MarshalByRefObject.CreateObjRef


Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
Equals
(inherited from System.Object)		 See base class member description: System.Object.Equals

Derived from System.Object, the primary base class for all objects.
Flush Clears all buffers for the current writer and causes any buffered data to be written to the underlying device.
GetHashCode
(inherited from System.Object)		 See base class member description: System.Object.GetHashCode

Derived from System.Object, the primary base class for all objects.
GetLifetimeService
(inherited from System.MarshalByRefObject)		 See base class member description: System.MarshalByRefObject.GetLifetimeService


Retrieves the current lifetime service object that controls the lifetime policy for this instance.
GetType
(inherited from System.Object)		 See base class member description: System.Object.GetType

Derived from System.Object, the primary base class for all objects.
InitializeLifetimeService
(inherited from System.MarshalByRefObject)		 See base class member description: System.MarshalByRefObject.InitializeLifetimeService


Obtains a lifetime service object to control the lifetime policy for this instance.
Synchronized Creates a thread-safe wrapper around the specified TextWriter.
ToString
(inherited from System.Object)		 See base class member description: System.Object.ToString

Derived from System.Object, the primary base class for all objects.
Write Overloaded:
Write(bool value)

 Writes the text representation of a Boolean value to the text stream.
Write Overloaded:
Write(char value)

 Writes a character to the text stream.
Write Overloaded:
Write(char[] buffer)

 Writes a character array to the text stream.
Write Overloaded:
Write(decimal value)

 Writes the text representation of a decimal value followed by a line terminator to the text stream.
Write Overloaded:
Write(double value)

 Writes the text representation of an 8-byte floating-point value to the text stream.
Write Overloaded:
Write(int value)

 Writes the text representation of a 4-byte signed integer to the text stream.
Write Overloaded:
Write(long value)

 Writes the text representation of an 8-byte signed integer to the text stream.
Write Overloaded:
Write(object value)

 Writes the text representation of an object to the text stream by calling ToString on that object.
Write Overloaded:
Write(float value)

 Writes the text representation of a 4-byte floating-point value to the text stream.
Write Overloaded:
Write(string value)

 Writes a string to the text stream.
Write Overloaded:
Write(uint value)

 Writes the text representation of a 4-byte unsigned integer to the text stream.
Write Overloaded:
Write(ulong value)

 Writes the text representation of an 8-byte unsigned integer to the text stream.
Write Overloaded:
Write(string format, object arg0)

 Writes out a formatted string, using the same semantics as String.Format.
Write Overloaded:
Write(string format, params object[] arg)

 Writes out a formatted string, using the same semantics as String.Format.
Write Overloaded:
Write(char[] buffer, int index, int count)

 Writes a subarray of characters to the text stream.
Write Overloaded:
Write(string format, object arg0, object arg1)

 Writes out a formatted string, using the same semantics as String.Format.
Write Overloaded:
Write(string format, object arg0, object arg1, object arg2)

 Writes out a formatted string, using the same semantics as String.Format.
WriteLine Overloaded:
WriteLine()

 Writes a line terminator to the text stream.
WriteLine Overloaded:
WriteLine(bool value)

 Writes the text representation of a Boolean followed by a line terminator to the text stream.
WriteLine Overloaded:
WriteLine(char value)

 Writes a character followed by a line terminator to the text stream.
WriteLine Overloaded:
WriteLine(char[] buffer)

 Writes an array of characters followed by a line terminator to the text stream.
WriteLine Overloaded:
WriteLine(decimal value)

 Writes the text representation of a decimal value followed by a line terminator to the text stream.
WriteLine Overloaded:
WriteLine(double value)

 Writes the text representation of a 8-byte floating-point value followed by a line terminator to the text stream.
WriteLine Overloaded:
WriteLine(int value)

 Writes the text representation of a 4-byte signed integer followed by a line terminator to the text stream.
WriteLine Overloaded:
WriteLine(long value)

 Writes the text representation of an 8-byte signed integer followed by a line terminator to the text stream.
WriteLine Overloaded:
WriteLine(object value)

 Writes the text representation of an object by calling ToString on this object, followed by a line terminator to the text stream.
WriteLine Overloaded:
WriteLine(float value)

 Writes the text representation of a 4-byte floating-point value followed by a line terminator to the text stream.
WriteLine Overloaded:
WriteLine(string value)

 Writes a string followed by a line terminator to the text stream.
WriteLine Overloaded:
WriteLine(uint value)

 Writes the text representation of a 4-byte unsigned integer followed by a line terminator to the text stream.
WriteLine Overloaded:
WriteLine(ulong value)

 Writes the text representation of an 8-byte unsigned integer followed by a line terminator to the text stream.
WriteLine Overloaded:
WriteLine(string format, object arg0)

 Writes out a formatted string and a new line, using the same semantics as String.Format.
WriteLine Overloaded:
WriteLine(string format, params object[] arg)

 Writes out a formatted string and a new line, using the same semantics as String.Format.
WriteLine Overloaded:
WriteLine(char[] buffer, int index, int count)

 Writes a subarray of characters followed by a line terminator to the text stream.
WriteLine Overloaded:
WriteLine(string format, object arg0, object arg1)

 Writes out a formatted string and a new line, using the same semantics as String.Format.
WriteLine Overloaded:
WriteLine(string format, object arg0, object arg1, object arg2)

 Writes out a formatted string and a new line, using the same semantics as String.Format.
Protected Constructors
ctor #1 Overloaded:
.ctor()

Default constructor. This constructor is called by derived class constructors to initialize state in this type.
ctor #2 Overloaded:
.ctor(IFormatProvider formatProvider)

 Initializes a new instance of the TextWriter class with the specified format provider.
Protected Fields
CoreNewLine Stores the new line characters used for this TextWriter.
Protected Methods
Dispose Releases the unmanaged resources used by the TextWriter and optionally releases the managed resources.
Finalize
(inherited from System.Object)		 See base class member description: System.Object.Finalize

Derived from System.Object, the primary base class for all objects.
MemberwiseClone
(inherited from System.Object)		 See base class member description: System.Object.MemberwiseClone

Derived from System.Object, the primary base class for all objects.

Hierarchy:

System.IO.TextWriter Member Details

Overloaded ctor #1
Summary
Initializes a new instance of the TextWriter class.

Default constructor. This constructor is called by derived class constructors to initialize state in this type.
C# Syntax:
protected TextWriter();
Remarks
Use this constructor for derived classes.

Return to top

Overloaded ctor #2
Summary
Initializes a new instance of the TextWriter class with the specified format provider.
C# Syntax:
protected TextWriter(
   IFormatProvider formatProvider
);
Parameters:

formatProvider

An IFormatProvider object that controls formatting.

Return to top

Field: CoreNewLine
Summary
Stores the new line characters used for this TextWriter.
C# Syntax:
protected char[] CoreNewLine;

Return to top

Field: Null
Summary
Provides a TextWriter with no backing store that can be written to, but not read from.
C# Syntax:
public static readonly TextWriter Null;
Remarks
Use Null to redirect output to a stream that will not consume any operating system resources.

When the TextWriter.Write methods are invoked on Null, the call simply returns, and no data is actually written to any backing store.

Return to top

Property: Encoding (read-only)
Summary
When overridden in a derived class, returns the Encoding in which the output is written.
C# Syntax:
public abstract Encoding Encoding {get;}
Remarks
This is necessary for some XML scenarios where a header must be written containing the encoding used by the TextWriter. This allows the XML code to consume an arbitrary TextWriter and generate the correct XML header.

Return to top

Property: FormatProvider (read-only)
Summary
Gets an object that controls formatting.
C# Syntax:
public virtual IFormatProvider FormatProvider {get;}

Return to top

Property: NewLine (read-write)
Summary
Gets or sets the line terminator string used by the current TextWriter.
C# Syntax:
public virtual string NewLine {get; set;}
Remarks
The default line terminator string is a carriage return followed by a line feed ("\r\n").

The line terminator string is written to the text stream whenever one of the WriteLine methods is called. In order for text written by the TextWriter to be readable by a TextReader, only "\n" or "\r\n" should be used as terminator strings. If NewLine is set to null, the default newline character is used instead.

Return to top

Method: Close()
Summary
Closes the current writer and releases any system resources associated with the writer.
C# Syntax:
public virtual void Close();
Remarks
This implementation of Close calls the TextWriter.Dispose method passing a true value.

Flushing the stream will not flush its underlying encoder unless you explicitly call TextWriter.Flush or Close. Setting StreamWriter.AutoFlush to true means that data will be flushed from the buffer to the stream, but the encoder state will not be flushed. This allows the encoder to keep its state (partial characters) so that it can encode the next block of characters correctly. This scenario affects UTF8 and UTF7 where certain characters can only be encoded after the encoder receives the adjacent character or characters.

Following a call to Close, any operations on the writer might raise exceptions. This default method does nothing, but derived classes can override the method to provide the appropriate functionality.

Return to top

Method: CreateObjRef(
   Type requestedType
)
Inherited
See base class member description: System.MarshalByRefObject.CreateObjRef

Summary
Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
C# Syntax:
public virtual ObjRef CreateObjRef(
   Type requestedType
);
Parameters:

requestedType

The Type of the object that the new ObjRef will reference.

Return Value:
Information required to generate a proxy.
Exceptions
Exception Type Condition
RemotingException This instance is not a valid remoting object.

Return to top

Method: Dispose(
   bool disposing
)
Summary
Releases the unmanaged resources used by the TextWriter and optionally releases the managed resources.
C# Syntax:
protected virtual void Dispose(
   bool disposing
);
Parameters:

disposing

true to release both managed and unmanaged resources; false to release only unmanaged resources.

Remarks
This method is called by the public Dispose() method and the Object.Finalize method.Dispose() invokes the protected Dispose(Boolean) method with the disposing parameter set to true. Object.Finalize invokes Dispose with disposing set to false.

When the disposing parameter is true, this method releases all resources held by any managed objects that this TextWriter references. This method invokes the Dispose() method of each referenced object.



Notes to inheritors: Dispose can be called multiple times by other objects. When overriding Dispose(Boolean), be careful not to reference objects that have been previously disposed of in an earlier call to Dispose. For more information about how to implement Dispose(Boolean), see the conceptual topic at MSDN: implementingdisposemethod.

For more information about Dispose and Object.Finalize, see the conceptual topic at MSDN: cleaningupunmanagedresources and the conceptual topic at MSDN: overridingfinalizemethod.

Return to top

Method: Equals(
   object obj
)
Inherited
See base class member description: System.Object.Equals
C# Syntax:
public virtual bool Equals(
   object obj
);

For more information on members inherited from System.Object click on the link above.

Return to top

Method: Finalize()
Inherited
See base class member description: System.Object.Finalize
C# Syntax:
~TextWriter();

For more information on members inherited from System.Object click on the link above.

Return to top

Method: Flush()
Summary
Clears all buffers for the current writer and causes any buffered data to be written to the underlying device.
C# Syntax:
public virtual void Flush();
Remarks
This default method does nothing, but derived classes can override the method to provide the appropriate functionality.

Flushing the stream will not flush its underlying encoder unless you explicitly call Flush or TextWriter.Close. Setting StreamWriter.AutoFlush to true means that data will be flushed from the buffer to the stream, but the encoder state will not be flushed. This allows the encoder to keep its state (partial characters) so that it can encode the next block of characters correctly. This scenario affects UTF8 and UTF7 where certain characters can only be encoded after the encoder receives the adjacent character or characters.

Return to top

Method: GetHashCode()
Inherited
See base class member description: System.Object.GetHashCode
C# Syntax:
public virtual int GetHashCode();

For more information on members inherited from System.Object click on the link above.

Return to top

Method: GetLifetimeService()
Inherited
See base class member description: System.MarshalByRefObject.GetLifetimeService

Summary
Retrieves the current lifetime service object that controls the lifetime policy for this instance.
C# Syntax:
public object GetLifetimeService();
Return Value:
An object of type ILease used to control the lifetime policy for this instance.
Remarks
For more information about lifetime services, see the LifetimeServices class.

Return to top

Method: GetType()
Inherited
See base class member description: System.Object.GetType
C# Syntax:
public Type GetType();

For more information on members inherited from System.Object click on the link above.

Return to top

Method: InitializeLifetimeService()
Inherited
See base class member description: System.MarshalByRefObject.InitializeLifetimeService

Summary
Obtains a lifetime service object to control the lifetime policy for this instance.
C# Syntax:
public virtual object InitializeLifetimeService();
Return Value:
An object of type ILease used to control the lifetime policy for this instance. This is the current lifetime service object for this instance if one exists; otherwise, a new lifetime service object initialized to the value of the LifetimeServices.LeaseManagerPollTime property.
Remarks
For more information about lifetime services, see the LifetimeServices class.
Example
The following code example demonstrates creating a lease.
 public class MyClass : MarshalByRefObject
 {
   public override Object InitializeLifetimeService()
   {
     ILease lease = (ILease)base.InitializeLifetimeService();
     if (lease.CurrentState == LeaseState.Initial)
     {
          lease.InitialLeaseTime = TimeSpan.FromMinutes(1);
          lease.SponsorshipTimeout = TimeSpan.FromMinutes(2);
           lease.RenewOnCallTime = TimeSpan.FromSeconds(2);
     }
       return lease;
   }
 }

Return to top

Method: MemberwiseClone()
Inherited
See base class member description: System.Object.MemberwiseClone
C# Syntax:
protected object MemberwiseClone();

For more information on members inherited from System.Object click on the link above.

Return to top

Method: Synchronized(
   TextWriter writer
)
Summary
Creates a thread-safe wrapper around the specified TextWriter.
C# Syntax:
public static TextWriter Synchronized(
   TextWriter writer
);
Parameters:

writer

The TextWriter to synchronize.

Return Value:
A thread-safe wrapper.
Exceptions
Exception Type Condition
ArgumentNullException writer is null.
Remarks
All writes to the returned wrapper will be thread safe.

Return to top

Method: ToString()
Inherited
See base class member description: System.Object.ToString
C# Syntax:
public virtual string ToString();

For more information on members inherited from System.Object click on the link above.

Return to top

Overloaded Method: Write(
   bool value
)
Summary
Writes the text representation of a Boolean value to the text stream.
C# Syntax:
public virtual void Write(
   bool value
);
Parameters:

value

The Boolean to write.

Exceptions
Exception Type Condition
IOException An I/O error occurs, such as the stream being closed.
Remarks
The text representation of the specified value is produced by calling Boolean.ToString.

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

Return to top

Overloaded Method: Write(
   char value
)
Summary
Writes a character to the text stream.
C# Syntax:
public virtual void Write(
   char value
);
Parameters:

value

The character to write to the text stream.

Exceptions
Exception Type Condition
IOException An I/O error occurs, such as the stream being closed.
Remarks
This default method does nothing, but derived classes can override the method to provide the appropriate functionality.

Return to top

Overloaded Method: Write(
   char[] buffer
)
Summary
Writes a character array to the text stream.
C# Syntax:
public virtual void Write(
   char[] buffer
);
Parameters:

buffer

The character array to write to the text stream.

Exceptions
Exception Type Condition
IOException An I/O error occurs, such as the stream being closed.
Remarks
This method does not search the specified String for individual newline characters(hexadecimal 0x000a) and replace them with TextWriter.NewLine.

This default method calls Write (char[], int, int) and passes the entire character array. If the character array is null, nothing is written.

Return to top

Overloaded Method: Write(
   decimal value
)
Summary
Writes the text representation of a decimal value followed by a line terminator to the text stream.
C# Syntax:
public virtual void Write(
   decimal value
);
Parameters:

value

The decimal value to write.

Exceptions
Exception Type Condition
IOException An I/O error occurs.

Return to top

Overloaded Method: Write(
   double value
)
Summary
Writes the text representation of an 8-byte floating-point value to the text stream.
C# Syntax:
public virtual void Write(
   double value
);
Parameters:

value

The 8-byte floating-point value to write.

Exceptions
Exception Type Condition
IOException An I/O error occurs, such as the stream being closed.
Remarks
The text representation of the specified value is produced by calling Double.ToString.

Return to top

Overloaded Method: Write(
   int value
)
Summary
Writes the text representation of a 4-byte signed integer to the text stream.
C# Syntax:
public virtual void Write(
   int value
);
Parameters:

value

The 4-byte signed integer to write.

Exceptions
Exception Type Condition
IOException An I/O error occurs, such as the stream being closed.
Remarks
The text representation of the specified value is produced by calling Int32.ToString.

Return to top

Overloaded Method: Write(
   long value
)
Summary
Writes the text representation of an 8-byte signed integer to the text stream.
C# Syntax:
public virtual void Write(
   long value
);
Parameters:

value

The 8-byte signed integer to write.

Exceptions
Exception Type Condition
IOException An I/O error occurs, such as the stream being closed.
Remarks
The text representation of the specified value is produced by calling Int64.ToString.

Return to top

Overloaded Method: Write(
   object value
)
Summary
Writes the text representation of an object to the text stream by calling ToString on that object.
C# Syntax:
public virtual void Write(
   object value
);
Parameters:

value

The object to write.

Exceptions
Exception Type Condition
IOException An I/O error occurs, such as the stream being closed.
Remarks
This version of TextWriter.Write is equivalent to (value.ToString ()).

If the specified object is null, no action is taken and no exception is thrown. Otherwise, the object's ToString method is called to produce the string representation, and the resulting string is then written to the output stream.

Return to top

Overloaded Method: Write(
   float value
)
Summary
Writes the text representation of a 4-byte floating-point value to the text stream.
C# Syntax:
public virtual void Write(
   float value
);
Parameters:

value

The 4-byte floating-point value to write.

Exceptions
Exception Type Condition
IOException An I/O error occurs, such as the stream being closed.
Remarks
The text representation of the specified value is produced by calling Single.ToString.

Return to top

Overloaded Method: Write(
   string value
)
Summary
Writes a string to the text stream.
C# Syntax:
public virtual void Write(
   string value
);
Parameters:

value

The string to write.

Exceptions
Exception Type Condition
IOException An I/O error occurs, such as the stream being closed.
Remarks
This version of TextWriter.Write is equivalent to (value.ToByteArray ()).

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

If value is null, nothing is written to the text stream.

Return to top

Overloaded Method: Write(
   uint value
)
Summary
Writes the text representation of a 4-byte unsigned integer to the text stream.
This member is not CLS Compliant

C# Syntax:
[CLSCompliant(false)]
public virtual void Write(
   uint value
);
Parameters:

value

The 4-byte unsigned integer to write.

Exceptions
Exception Type Condition
IOException An I/O error occurs, such as the stream being closed.
Remarks
The text representation of the specified value is produced by calling UInt32.ToString.

Return to top

Overloaded Method: Write(
   ulong value
)
Summary
Writes the text representation of an 8-byte unsigned integer to the text stream.
This member is not CLS Compliant

C# Syntax:
[CLSCompliant(false)]
public virtual void Write(
   ulong value
);
Parameters:

value

The 8-byte unsigned integer to write.

Exceptions
Exception Type Condition
IOException An I/O error occurs, such as the stream being closed.
Remarks
The text representation of the specified value is produced by calling UInt64.ToString.

Return to top

Overloaded Method: Write(
   string format,
   object arg0
)
Summary
Writes out a formatted string, using the same semantics as String.Format.
C# Syntax:
public virtual void Write(
   string format,
   object arg0
);
Parameters:

format

The formatting string.

arg0

An object to write into the formatted string.

Exceptions
Exception Type Condition
ArgumentNullException format or arg0 is null.

-or-

An object referenced in the format string is null.
IOException An I/O error occurs, such as the stream being closed.
FormatException The format specification in format is invalid.

-or-

The number indicating an argument to be formatted is less than zero, or larger than or equal to the number of provided objects to be formatted .
Remarks
This version of TextWriter.Write is equivalent to ( (format, arg0, arg1)).

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

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

Return to top

Overloaded Method: Write(
   string format,
   params object[] arg
)
Summary
Writes out a formatted string, using the same semantics as String.Format.
C# Syntax:
public virtual void Write(
   string format,
   params object[] arg
);
Parameters:

format

The formatting string.

arg

The object array to write into the formatted string.

Exceptions
Exception Type Condition
ArgumentNullException format or arg is null.
IOException An I/O error occurs, such as the stream being closed.
FormatException The format specification in format is invalid.

-or-

The number indicating an argument to be formatted is less than zero, or larger than or equal to arg.Length.
Remarks
This version of TextWriter.Write is equivalent to ( (format, arg)).

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

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

Return to top

Overloaded Method: Write(
   char[] buffer,
   int index,
   int count
)
Summary
Writes a subarray of characters to the text stream.
C# Syntax:
public virtual void Write(
   char[] buffer,
   int index,
   int count
);
Parameters:

buffer

The character array to write data from.

index

Starting index in the buffer.

count

The number of characters to write.

Exceptions
Exception Type Condition
ArgumentException The buffer length minus index is less than count.
ArgumentNullException The buffer parameter is Null.
ArgumentOutOfRangeException index or count is negative.
IOException An I/O error occurs, such as the stream being closed.
Remarks
This method will write count characters of data into this TextWriter from the buffer character array starting at position index.

This version of TextWriter.Write is equivalent to (buffer[i]) for each character in buffer between index and (index + count).

Return to top

Overloaded Method: Write(
   string format,
   object arg0,
   object arg1
)
Summary
Writes out a formatted string, using the same semantics as String.Format.
C# Syntax:
public virtual void Write(
   string format,
   object arg0,
   object arg1
);
Parameters:

format

The formatting string.

arg0

An object to write into the formatted string.

arg1

An object to write into the formatted string.

Exceptions
Exception Type Condition
ArgumentNullException format or any of the arg parameters is null.

-or-

An object referenced in the format string is null.
IOException An I/O error occurs, such as the stream being closed.
FormatException The format specification in format is invalid.

-or-

The number indicating an argument to be formatted is less than zero, or larger than or equal to the number of provided objects to be formatted .
Remarks
This version of TextWriter.Write is equivalent to ( (format, arg0, arg1)).

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

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

Return to top

Overloaded Method: Write(
   string format,
   object arg0,
   object arg1,
   object arg2
)
Summary
Writes out a formatted string, using the same semantics as String.Format.
C# Syntax:
public virtual void Write(
   string format,
   object arg0,
   object arg1,
   object arg2
);
Parameters:

format

The formatting string.

arg0

An object to write into the formatted string.

arg1

An object to write into the formatted string.

arg2

An object to write into the formatted string.

Exceptions
Exception Type Condition
ArgumentNullException format or any of the arg parameters is null.

-or-

An object referenced in the format string is null.
IOException An I/O error occurs, such as the stream being closed.
FormatException The format specification in format is invalid.

-or-

The number indicating an argument to be formatted is less than zero, or larger than or equal to the number of provided objects to be formatted .
Remarks
This version of TextWriter.Write is equivalent to ( (format, arg0, arg1, arg2)).

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

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

Return to top

Overloaded Method: WriteLine()
Summary
Writes a line terminator to the text stream.
C# Syntax:
public virtual void WriteLine();
Return Value:
The default line terminator is a carriage return followed by a line feed ("\r\n"), but this value can be changed using the TextWriter.NewLine property.
Exceptions
Exception Type Condition
IOException An I/O error occurs, such as the stream being closed.

Return to top

Overloaded Method: WriteLine(
   bool value
)
Summary
Writes the text representation of a Boolean followed by a line terminator to the text stream.
C# Syntax:
public virtual void WriteLine(
   bool value
);
Parameters:

value

The Boolean to write.

Exceptions
Exception Type Condition
IOException An I/O error occurs, such as the stream being closed.
Remarks
The text representation of the specified value is produced by calling Boolean.ToString.

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

Return to top

Overloaded Method: WriteLine(
   char value
)
Summary
Writes a character followed by a line terminator to the text stream.
C# Syntax:
public virtual void WriteLine(
   char value
);
Parameters:

value

The character to write to the text stream.

Exceptions
Exception Type Condition
IOException An I/O error occurs, such as the stream being closed.
Remarks
This version of TextWriter.WriteLine is equivalent to (buffer) followed by ().

Return to top

Overloaded Method: WriteLine(
   char[] buffer
)
Summary
Writes an array of characters followed by a line terminator to the text stream.
C# Syntax:
public virtual void WriteLine(
   char[] buffer
);
Parameters:

buffer

The character array from which data is read.

Exceptions
Exception Type Condition
IOException An I/O error occurs, such as the stream being closed.
Remarks
All the characters in buffer are written to the underlying stream. If the character array is null, nothing is written.

This version of TextWriter.WriteLine is equivalent to (buffer) followed by ().

Return to top

Overloaded Method: WriteLine(
   decimal value
)
Summary
Writes the text representation of a decimal value followed by a line terminator to the text stream.
C# Syntax:
public virtual void WriteLine(
   decimal value
);
Parameters:

value

The decimal value to write.

Exceptions
Exception Type Condition
IOException An I/O error occurs.

Return to top

Overloaded Method: WriteLine(
   double value
)
Summary
Writes the text representation of a 8-byte floating-point value followed by a line terminator to the text stream.
C# Syntax:
public virtual void WriteLine(
   double value
);
Parameters:

value

The 8-byte floating-point value to write.

Exceptions
Exception Type Condition
IOException An I/O error occurs, such as the stream being closed.

Return to top

Overloaded Method: WriteLine(
   int value
)
Summary
Writes the text representation of a 4-byte signed integer followed by a line terminator to the text stream.
C# Syntax:
public virtual void WriteLine(
   int value
);
Parameters:

value

The 4-byte signed integer to write.

Exceptions
Exception Type Condition
IOException An I/O error occurs, such as the stream being closed.
Remarks
The text representation of the specified value is produced by calling Int32.ToString.

Return to top

Overloaded Method: WriteLine(
   long value
)
Summary
Writes the text representation of an 8-byte signed integer followed by a line terminator to the text stream.
C# Syntax:
public virtual void WriteLine(
   long value
);
Parameters:

value

The 8-byte signed integer to write.

Exceptions
Exception Type Condition
IOException An I/O error occurs, such as the stream being closed.
Remarks
The text representation of the specified value is produced by calling Int64.ToString.

Return to top

Overloaded Method: WriteLine(
   object value
)
Summary
Writes the text representation of an object by calling ToString on this object, followed by a line terminator to the text stream.
C# Syntax:
public virtual void WriteLine(
   object value
);
Parameters:

value

The object to write. If value is null, only the line termination characters are written.

Exceptions
Exception Type Condition
IOException An I/O error occurs, such as the stream being closed.
Remarks
This version of TextWriter.WriteLine is equivalent to (value.ToString ()).

Return to top

Overloaded Method: WriteLine(
   float value
)
Summary
Writes the text representation of a 4-byte floating-point value followed by a line terminator to the text stream.
C# Syntax:
public virtual void WriteLine(
   float value
);
Parameters:

value

The 4-byte floating-point value to write.

Exceptions
Exception Type Condition
IOException An I/O error occurs, such as the stream being closed.

Return to top

Overloaded Method: WriteLine(
   string value
)
Summary
Writes a string followed by a line terminator to the text stream.
C# Syntax:
public virtual void WriteLine(
   string value
);
Parameters:

value

The string to write. If value is null, only the line termination characters are written.

Exceptions
Exception Type Condition
IOException An I/O error occurs, such as the stream being closed.
Remarks
This version of TextWriter.WriteLine is equivalent to (value.ToByteArray ()).

The line terminator string is defined by the TextWriter.NewLine property.

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

Return to top

Overloaded Method: WriteLine(
   uint value
)
Summary
Writes the text representation of a 4-byte unsigned integer followed by a line terminator to the text stream.
This member is not CLS Compliant

C# Syntax:
[CLSCompliant(false)]
public virtual void WriteLine(
   uint value
);
Parameters:

value

The 4-byte unsigned integer to write.

Exceptions
Exception Type Condition
IOException An I/O error occurs, such as the stream being closed.
Remarks
The text representation of the specified value is produced by calling UInt32.ToString.

Return to top

Overloaded Method: WriteLine(
   ulong value
)
Summary
Writes the text representation of an 8-byte unsigned integer followed by a line terminator to the text stream.
This member is not CLS Compliant

C# Syntax:
[CLSCompliant(false)]
public virtual void WriteLine(
   ulong value
);
Parameters:

value

The 8-byte unsigned integer to write.

Exceptions
Exception Type Condition
IOException An I/O error occurs, such as the stream being closed.
Remarks
The text representation of the specified value is produced by calling UInt64.ToString.

Return to top

Overloaded Method: WriteLine(
   string format,
   object arg0
)
Summary
Writes out a formatted string and a new line, using the same semantics as String.Format.
C# Syntax:
public virtual void WriteLine(
   string format,
   object arg0
);
Parameters:

format

The formatted string.

arg0

The object to write into the formatted string.

Exceptions
Exception Type Condition
ArgumentNullException A string or object is passed in as null.

-or-

An object referenced in the format string is null.
IOException An I/O error occurs, such as the stream being closed.
FormatException The format specification in format is invalid.

-or-

The number indicating an argument to be formatted is less than zero, or larger than or equal to the number of provided objects to be formatted .
Remarks
This version of TextWriter.WriteLine is equivalent to ( (format, arg0, arg1)).

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

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

Return to top

Overloaded Method: WriteLine(
   string format,
   params object[] arg
)
Summary
Writes out a formatted string and a new line, using the same semantics as String.Format.
C# Syntax:
public virtual void WriteLine(
   string format,
   params object[] arg
);
Parameters:

format

The formatting string.

arg

The object array to write into format string.

Exceptions
Exception Type Condition
ArgumentNullException A string or object is passed in as null.
IOException An I/O error occurs, such as the stream being closed.
FormatException The format specification in format is invalid.

-or-

The number indicating an argument to be formatted is less than zero, or larger than or equal to arg.Length.
Remarks
This version of TextWriter.WriteLine is equivalent to ( (format, arg)).

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

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

Return to top

Overloaded Method: WriteLine(
   char[] buffer,
   int index,
   int count
)
Summary
Writes a subarray of characters followed by a line terminator to the text stream.
C# Syntax:
public virtual void WriteLine(
   char[] buffer,
   int index,
   int count
);
Parameters:

buffer

The character array from which data is read.

index

The index into buffer at which to begin reading.

count

The maximum number of characters to write.

Return Value:
Characters are read from buffer beginning at index and ending at index + count.
Exceptions
Exception Type Condition
ArgumentException The buffer length minus index is less than count.
ArgumentNullException The buffer parameter is Null.
ArgumentOutOfRangeException index or count is negative.
IOException An I/O error occurs, such as the stream being closed.
Remarks
This method will write count characters of data into this TextWriter from the buffer character array starting at position index.

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

This version of TextWriter.WriteLine is equivalent to (buffer[i]) for each character in buffer between index and (index + count) followed by ().

Return to top

Overloaded Method: WriteLine(
   string format,
   object arg0,
   object arg1
)
Summary
Writes out a formatted string and a new line, using the same semantics as String.Format.
C# Syntax:
public virtual void WriteLine(
   string format,
   object arg0,
   object arg1
);
Parameters:

format

The formatting string.

arg0

The object to write into format string.

arg1

The object to write into the formatted string.

Exceptions
Exception Type Condition
ArgumentNullException A string or object is passed in as null.

-or-

An object referenced in the format string is null.
IOException An I/O error occurs, such as the stream being closed.
FormatException The format specification in format is invalid.

-or-

The number indicating an argument to be formatted is less than zero, or larger than or equal to the number of provided objects to be formatted.
Remarks
This version of TextWriter.WriteLine is equivalent to ( (format, arg0, arg1)).

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

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

Return to top

Overloaded Method: WriteLine(
   string format,
   object arg0,
   object arg1,
   object arg2
)
Summary
Writes out a formatted string and a new line, using the same semantics as String.Format.
C# Syntax:
public virtual void WriteLine(
   string format,
   object arg0,
   object arg1,
   object arg2
);
Parameters:

format

The formatting string.

arg0

The object to write into format string.

arg1

The object to write into format string.

arg2

The object to write into format string.

Exceptions
Exception Type Condition
ArgumentNullException A string or object is passed in as null.

-or-

An object referenced in the format string is null.
IOException An I/O error occurs, such as the stream being closed.
FormatException The format specification in format is invalid.

-or-

The number indicating an argument to be formatted is less than zero, or larger than or equal to the number of provided objects to be formatted.
Remarks
This version of TextWriter.WriteLine is equivalent to ( (format, arg0, arg1, arg2)).

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

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

Return to top

Top of page

Copyright (c) 2002 Microsoft Corporation. All rights reserved.