System.IO.StringWriter Class

Summary

Writes information to a string. The information is stored in an underlying StringBuilder.

C# Syntax:

[Serializable] public class StringWriter : TextWriter

System.IO Namespace | StringBuilder | StringReader

System.IO.StringWriter Member List:

Public Constructors

ctor #1	Overloaded: .ctor() Default constructor. This constructor is called by derived class constructors to initialize state in this type. Initializes a new instance of the StringWriter class.
ctor #2	Overloaded: .ctor(IFormatProvider formatProvider) Initializes a new instance of the StringWriter class with the specified format control.
ctor #3	Overloaded: .ctor(StringBuilder sb) Initializes a new instance of the StringWriter class that writes to the specified StringBuilder.
ctor #4	Overloaded: .ctor(StringBuilder sb, IFormatProvider formatProvider) Initializes a new instance of the StringWriter class that writes to the specified StringBuilder and has the specified format provider.

Public Properties

Encoding	Read-only Overridden: Gets the Encoding in which the output is written.
FormatProvider (inherited from System.IO.TextWriter)	Read-only See base class member description: System.IO.TextWriter.FormatProvider Gets an object that controls formatting.
NewLine (inherited from System.IO.TextWriter)	Read-write See base class member description: System.IO.TextWriter.NewLine Gets or sets the line terminator string used by the current TextWriter.

Public Methods

Close	Overridden: Closes the current StringWriter and the underlying stream.
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 (inherited from System.IO.TextWriter)	See base class member description: System.IO.TextWriter.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.
GetStringBuilder	Returns the underlying StringBuilder.
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.
ToString	Overridden: Returns a string containing the characters written to the current StringWriter so far.
Write (inherited from System.IO.TextWriter)	Overloaded: Write(bool value) See base class member description: System.IO.TextWriter.Write Writes the text representation of a Boolean value to the text stream.
Write	Overloaded: Write(char value) Overridden: Writes a character to this instance of the StringWriter.
Write (inherited from System.IO.TextWriter)	Overloaded: Write(char[] buffer) See base class member description: System.IO.TextWriter.Write Writes a character array to the text stream.
Write (inherited from System.IO.TextWriter)	Overloaded: Write(decimal value) See base class member description: System.IO.TextWriter.Write Writes the text representation of a decimal value followed by a line terminator to the text stream.
Write (inherited from System.IO.TextWriter)	Overloaded: Write(double value) See base class member description: System.IO.TextWriter.Write Writes the text representation of an 8-byte floating-point value to the text stream.
Write (inherited from System.IO.TextWriter)	Overloaded: Write(int value) See base class member description: System.IO.TextWriter.Write Writes the text representation of a 4-byte signed integer to the text stream.
Write (inherited from System.IO.TextWriter)	Overloaded: Write(long value) See base class member description: System.IO.TextWriter.Write Writes the text representation of an 8-byte signed integer to the text stream.
Write (inherited from System.IO.TextWriter)	Overloaded: Write(object value) See base class member description: System.IO.TextWriter.Write Writes the text representation of an object to the text stream by calling ToString on that object.
Write (inherited from System.IO.TextWriter)	Overloaded: Write(float value) See base class member description: System.IO.TextWriter.Write Writes the text representation of a 4-byte floating-point value to the text stream.
Write	Overloaded: Write(string value) Overridden: Writes a string to this instance of the StringWriter.
Write (inherited from System.IO.TextWriter)	Overloaded: Write(uint value) See base class member description: System.IO.TextWriter.Write Writes the text representation of a 4-byte unsigned integer to the text stream.
Write (inherited from System.IO.TextWriter)	Overloaded: Write(ulong value) See base class member description: System.IO.TextWriter.Write Writes the text representation of an 8-byte unsigned integer to the text stream.
Write (inherited from System.IO.TextWriter)	Overloaded: Write(string format, object arg0) See base class member description: System.IO.TextWriter.Write Writes out a formatted string, using the same semantics as String.Format.
Write (inherited from System.IO.TextWriter)	Overloaded: Write(string format, params object[] arg) See base class member description: System.IO.TextWriter.Write Writes out a formatted string, using the same semantics as String.Format.
Write	Overloaded: Write(char[] buffer, int index, int count) Overridden: Writes the specified region of a character array to this instance of the StringWriter.
Write (inherited from System.IO.TextWriter)	Overloaded: Write(string format, object arg0, object arg1) See base class member description: System.IO.TextWriter.Write Writes out a formatted string, using the same semantics as String.Format.
Write (inherited from System.IO.TextWriter)	Overloaded: Write(string format, object arg0, object arg1, object arg2) See base class member description: System.IO.TextWriter.Write Writes out a formatted string, using the same semantics as String.Format.
WriteLine (inherited from System.IO.TextWriter)	Overloaded: WriteLine() See base class member description: System.IO.TextWriter.WriteLine Writes a line terminator to the text stream.
WriteLine (inherited from System.IO.TextWriter)	Overloaded: WriteLine(bool value) See base class member description: System.IO.TextWriter.WriteLine Writes the text representation of a Boolean followed by a line terminator to the text stream.
WriteLine (inherited from System.IO.TextWriter)	Overloaded: WriteLine(char value) See base class member description: System.IO.TextWriter.WriteLine Writes a character followed by a line terminator to the text stream.
WriteLine (inherited from System.IO.TextWriter)	Overloaded: WriteLine(char[] buffer) See base class member description: System.IO.TextWriter.WriteLine Writes an array of characters followed by a line terminator to the text stream.
WriteLine (inherited from System.IO.TextWriter)	Overloaded: WriteLine(decimal value) See base class member description: System.IO.TextWriter.WriteLine Writes the text representation of a decimal value followed by a line terminator to the text stream.
WriteLine (inherited from System.IO.TextWriter)	Overloaded: WriteLine(double value) See base class member description: System.IO.TextWriter.WriteLine Writes the text representation of a 8-byte floating-point value followed by a line terminator to the text stream.
WriteLine (inherited from System.IO.TextWriter)	Overloaded: WriteLine(int value) See base class member description: System.IO.TextWriter.WriteLine Writes the text representation of a 4-byte signed integer followed by a line terminator to the text stream.
WriteLine (inherited from System.IO.TextWriter)	Overloaded: WriteLine(long value) See base class member description: System.IO.TextWriter.WriteLine Writes the text representation of an 8-byte signed integer followed by a line terminator to the text stream.
WriteLine (inherited from System.IO.TextWriter)	Overloaded: WriteLine(object value) See base class member description: System.IO.TextWriter.WriteLine Writes the text representation of an object by calling ToString on this object, followed by a line terminator to the text stream.
WriteLine (inherited from System.IO.TextWriter)	Overloaded: WriteLine(float value) See base class member description: System.IO.TextWriter.WriteLine Writes the text representation of a 4-byte floating-point value followed by a line terminator to the text stream.
WriteLine (inherited from System.IO.TextWriter)	Overloaded: WriteLine(string value) See base class member description: System.IO.TextWriter.WriteLine Writes a string followed by a line terminator to the text stream.
WriteLine (inherited from System.IO.TextWriter)	Overloaded: WriteLine(uint value) See base class member description: System.IO.TextWriter.WriteLine Writes the text representation of a 4-byte unsigned integer followed by a line terminator to the text stream.
WriteLine (inherited from System.IO.TextWriter)	Overloaded: WriteLine(ulong value) See base class member description: System.IO.TextWriter.WriteLine Writes the text representation of an 8-byte unsigned integer followed by a line terminator to the text stream.
WriteLine (inherited from System.IO.TextWriter)	Overloaded: WriteLine(string format, object arg0) See base class member description: System.IO.TextWriter.WriteLine Writes out a formatted string and a new line, using the same semantics as String.Format.
WriteLine (inherited from System.IO.TextWriter)	Overloaded: WriteLine(string format, params object[] arg) See base class member description: System.IO.TextWriter.WriteLine Writes out a formatted string and a new line, using the same semantics as String.Format.
WriteLine (inherited from System.IO.TextWriter)	Overloaded: WriteLine(char[] buffer, int index, int count) See base class member description: System.IO.TextWriter.WriteLine Writes a subarray of characters followed by a line terminator to the text stream.
WriteLine (inherited from System.IO.TextWriter)	Overloaded: WriteLine(string format, object arg0, object arg1) See base class member description: System.IO.TextWriter.WriteLine Writes out a formatted string and a new line, using the same semantics as String.Format.
WriteLine (inherited from System.IO.TextWriter)	Overloaded: WriteLine(string format, object arg0, object arg1, object arg2) See base class member description: System.IO.TextWriter.WriteLine Writes out a formatted string and a new line, using the same semantics as String.Format.

Protected Fields

CoreNewLine (inherited from System.IO.TextWriter)

See base class member description: System.IO.TextWriter.CoreNewLine Stores the new line characters used for this TextWriter.

Protected Methods

Dispose	Overridden: Releases the unmanaged resources used by the StringWriter 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.Object
• System.MarshalByRefObject
• System.IO.TextWriter
• System.IO.StringWriter

System.IO.StringWriter Member Details

Summary

Initializes a new instance of the StringWriter class.

Default constructor. This constructor is called by derived class constructors to initialize state in this type.

C# Syntax:

public StringWriter();

A new StringBuilder is automatically created and associated with the new StringWriter.

Return to top

Summary

Initializes a new instance of the StringWriter class with the specified format control.

C# Syntax:

public StringWriter(    IFormatProvider formatProvider );

formatProvider

An IFormatProvider object that controls formatting.

Return to top

Summary

Initializes a new instance of the StringWriter class that writes to the specified StringBuilder.

C# Syntax:

public StringWriter(    StringBuilder sb );

sb

The StringBuilder to write to.

Exceptions

Exception Type	Condition
ArgumentNullException	sb is null.

Return to top

Summary

Initializes a new instance of the StringWriter class that writes to the specified StringBuilder and has the specified format provider.

C# Syntax:

public StringWriter(    StringBuilder sb,    IFormatProvider formatProvider );

sb

The StringBuilder to write to.

formatProvider

An IFormatProvider object that controls formatting.

Exceptions

Exception Type	Condition
ArgumentNullException	sb is null.

Return to top

Inherited
See base class member description: System.IO.TextWriter.CoreNewLine

Summary

Stores the new line characters used for this TextWriter.

C# Syntax:

protected char[] CoreNewLine;

Return to top

Summary

Gets the Encoding in which the output is written.

C# Syntax:

public override Encoding Encoding {get;}

This is necessary for some XML scenarios where a header must be written containing the encoding used by the StringWriter. This allows the XML code to consume an arbitrary StringWriter and generate the correct XML header.

Return to top

Inherited
See base class member description: System.IO.TextWriter.FormatProvider

Summary

Gets an object that controls formatting.

C# Syntax:

public virtual IFormatProvider FormatProvider {get;}

Return to top

Inherited
See base class member description: System.IO.TextWriter.NewLine

Summary

Gets or sets the line terminator string used by the current TextWriter.

C# Syntax:

public virtual string NewLine {get; set;}

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

Summary

Closes the current StringWriter and the underlying stream.

C# Syntax:

public override void Close();

This method overrides Stream.Close.

This implementation of Close calls the StringWriter.Dispose method passing a true value.

Flushing the stream will not flush its underlying encoder unless you explicitly call 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

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 );

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

Summary

Releases the unmanaged resources used by the StringWriter and optionally releases the managed resources.

C# Syntax:

protected override void Dispose(    bool disposing );

disposing

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

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

Notes to inheritors: StringWriter.Dispose may be called multiple times by other objects. When overriding StringWriter.Dispose, be careful not to reference objects that have been previously disposed in an earlier call to StringWriter.Dispose.

Return to top

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

Inherited
See base class member description: System.Object.Finalize

C# Syntax:

~StringWriter();

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

Return to top

Inherited
See base class member description: System.IO.TextWriter.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();

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

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

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.

For more information about lifetime services, see the LifetimeServices class.

Return to top

Summary

Returns the underlying StringBuilder.

C# Syntax:

public virtual StringBuilder GetStringBuilder();

Return Value:

The underlying StringBuilder.

This is either the StringBuilder that was passed to the constructor, or the StringBuilder that was automatically created.

Return to top

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

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.

For more information about lifetime services, see the LifetimeServices class.

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

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

Summary

Returns a string containing the characters written to the current StringWriter so far.

C# Syntax:

public override string ToString();

Return Value:

The string containing the characters written to the current StringWriter.

This method overrides Object.ToString.

Return to top

Inherited
See base class member description: System.IO.TextWriter.Write

Summary

Writes the text representation of a Boolean value to the text stream.

C# Syntax:

public virtual void Write(    bool value );

value

The Boolean to write.

Exceptions

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

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

Summary

Writes a character to this instance of the StringWriter.

C# Syntax:

public override void Write(    char value );

value

The character to write.

Exceptions

Exception Type	Condition
ObjectDisposedException	The writer is closed.

This method overrides TextWriter.Write.

Return to top

Inherited
See base class member description: System.IO.TextWriter.Write

Summary

Writes a character array to the text stream.

C# Syntax:

public virtual void Write(    char[] buffer );

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.

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

Inherited
See base class member description: System.IO.TextWriter.Write

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 );

value

The decimal value to write.

Exceptions

Exception Type	Condition
IOException	An I/O error occurs.

Return to top

Inherited
See base class member description: System.IO.TextWriter.Write

Summary

Writes the text representation of an 8-byte floating-point value to the text stream.

C# Syntax:

public virtual void Write(    double value );

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.

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

Return to top

Inherited
See base class member description: System.IO.TextWriter.Write

Summary

Writes the text representation of a 4-byte signed integer to the text stream.

C# Syntax:

public virtual void Write(    int value );

value

The 4-byte signed integer to write.

Exceptions

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

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

Return to top

Inherited
See base class member description: System.IO.TextWriter.Write

Summary

Writes the text representation of an 8-byte signed integer to the text stream.

C# Syntax:

public virtual void Write(    long value );

value

The 8-byte signed integer to write.

Exceptions

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

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

Return to top

Inherited
See base class member description: System.IO.TextWriter.Write

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 );

value

The object to write.

Exceptions

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

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

Inherited
See base class member description: System.IO.TextWriter.Write

Summary

Writes the text representation of a 4-byte floating-point value to the text stream.

C# Syntax:

public virtual void Write(    float value );

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.

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

Return to top

Summary

Writes a string to this instance of the StringWriter.

C# Syntax:

public override void Write(    string value );

value

The string to write.

Exceptions

Exception Type	Condition
ObjectDisposedException	The writer is closed.

This method overrides TextWriter.Write.

If the specified string is null, nothing is written.

Return to top

Inherited
See base class member description: System.IO.TextWriter.Write

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 );

value

The 4-byte unsigned integer to write.

Exceptions

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

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

Return to top

Inherited
See base class member description: System.IO.TextWriter.Write

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 );

value

The 8-byte unsigned integer to write.

Exceptions

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

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

Return to top

Inherited
See base class member description: System.IO.TextWriter.Write

Summary

Writes out a formatted string, using the same semantics as String.Format.

C# Syntax:

public virtual void Write(    string format,    object arg0 );

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 .

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

Inherited
See base class member description: System.IO.TextWriter.Write

Summary

Writes out a formatted string, using the same semantics as String.Format.

C# Syntax:

public virtual void Write(    string format,    params object[] arg );

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.

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

Summary

Writes the specified region of a character array to this instance of the StringWriter.

C# Syntax:

public override void Write(    char[] buffer,    int index,    int count );

buffer

The character array to read data from.

index

The index at which to begin reading from buffer.

count

The maximum number of characters to write.

Exceptions

Exception Type	Condition
ArgumentNullException	buffer is null.
ArgumentOutOfRangeException	index or count is negative.
ArgumentException	(index + count)> buffer.Length.
ObjectDisposedException	The writer is closed.

This method overrides TextWriter.Write.

This method writes count characters of data to this StringWriter from buffer, starting at position index.

Return to top

Inherited
See base class member description: System.IO.TextWriter.Write

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 );

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 .

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

Inherited
See base class member description: System.IO.TextWriter.Write

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 );

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 .

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

Inherited
See base class member description: System.IO.TextWriter.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

Inherited
See base class member description: System.IO.TextWriter.WriteLine

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 );

value

The Boolean to write.

Exceptions

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

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

Inherited
See base class member description: System.IO.TextWriter.WriteLine

Summary

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

C# Syntax:

public virtual void WriteLine(    char value );

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.

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

Return to top

Inherited
See base class member description: System.IO.TextWriter.WriteLine

Summary

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

C# Syntax:

public virtual void WriteLine(    char[] buffer );

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.

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

Inherited
See base class member description: System.IO.TextWriter.WriteLine

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 );

value

The decimal value to write.

Exceptions

Exception Type	Condition
IOException	An I/O error occurs.

Return to top

Inherited
See base class member description: System.IO.TextWriter.WriteLine

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 );

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

Inherited
See base class member description: System.IO.TextWriter.WriteLine

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 );

value

The 4-byte signed integer to write.

Exceptions

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

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

Return to top

Inherited
See base class member description: System.IO.TextWriter.WriteLine

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 );

value

The 8-byte signed integer to write.

Exceptions

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

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

Return to top

Inherited
See base class member description: System.IO.TextWriter.WriteLine

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 );

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.

This version of TextWriter.WriteLine is equivalent to (value.ToString ()).

Return to top

Inherited
See base class member description: System.IO.TextWriter.WriteLine

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 );

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

Inherited
See base class member description: System.IO.TextWriter.WriteLine

Summary

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

C# Syntax:

public virtual void WriteLine(    string value );

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.

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

Inherited
See base class member description: System.IO.TextWriter.WriteLine

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 );

value

The 4-byte unsigned integer to write.

Exceptions

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

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

Return to top

Inherited
See base class member description: System.IO.TextWriter.WriteLine

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 );

value

The 8-byte unsigned integer to write.

Exceptions

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

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

Return to top

Inherited
See base class member description: System.IO.TextWriter.WriteLine

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 );

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 .

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

Inherited
See base class member description: System.IO.TextWriter.WriteLine

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 );

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.

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

Inherited
See base class member description: System.IO.TextWriter.WriteLine

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 );

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.

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

Inherited
See base class member description: System.IO.TextWriter.WriteLine

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 );

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.

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

Inherited
See base class member description: System.IO.TextWriter.WriteLine

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 );

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.

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