Early Preview
This is currently very much a preview. Please feel free to try things out,
but don't be upset if anything is not yet working. Feedback is welcome over on our
GitHub Dicussions page.
class System.IO.TextWriter
Assembly: System.Runtime
Inheritance: object → MarshalByRefObject → TextWriter
Represents a writer that can write a sequential series of characters. This class is abstract.
Fields and Constants
protected
char[]
CoreNewLine
Stores the newline characters used for this <see langword="TextWriter" /> .
public static readonly
TextWriter
Null
Provides a <see langword="TextWriter" /> with no backing store that can be written to, but not read from.
Properties
public
Text.Encoding
Encoding
When overridden in a derived class, returns the character encoding in which the output is written.
public
IFormatProvider
FormatProvider
Gets an object that controls formatting.
public
string
NewLine
Gets or sets the line terminator string used by the current <see langword="TextWriter" /> .
Methods
public
void
Close()
Closes the current writer and releases any system resources associated with the writer.
public
void
Dispose()
Releases all resources used by the <see cref="T:System.IO.TextWriter" /> object.
protected
void
Dispose(bool disposing)
disposing
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.
Releases the unmanaged resources used by the <see cref="T:System.IO.TextWriter" /> and optionally releases the managed resources.
public
Threading.Tasks.ValueTask
DisposeAsync() Returns A task that represents the asynchronous dispose operation.
Asynchronously releases all resources used by the <see cref="T:System.IO.TextWriter" /> object.
public
void
Flush()
Clears all buffers for the current writer and causes any buffered data to be written to the underlying device.
public
Threading.Tasks.Task
FlushAsync() Returns A task that represents the asynchronous flush operation.
Asynchronously clears all buffers for the current writer and causes any buffered data to be written to the underlying device.
public
Threading.Tasks.Task
FlushAsync(Threading.CancellationToken cancellationToken)
cancellationToken
The <see cref="T:System.Threading.CancellationToken" /> to monitor for cancellation requests.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous flush operation.
Asynchronously clears all buffers for the current writer and causes any buffered data to be written to the underlying device.
public
void
Write(bool value)
value
The <see langword="Boolean" /> value to write.
Writes the text representation of a <see langword="Boolean" /> value to the text stream.
public
void
Write(char value)
value
The character to write to the text stream.
Writes a character to the text stream.
public
void
Write(char[] buffer)
buffer
The character array to write to the text stream.
Writes a character array to the text stream.
public
void
Write(char[] buffer,
int index,
int count)
buffer
The character array to write data from.
index
The character position in the buffer at which to start retrieving data.
count
The number of characters to write.
Writes a subarray of characters to the text stream.
public
void
Write(decimal value)
value
The decimal value to write.
Writes the text representation of a decimal value to the text stream.
public
void
Write(double value)
value
The 8-byte floating-point value to write.
Writes the text representation of an 8-byte floating-point value to the text stream.
public
void
Write(int value)
value
The 4-byte signed integer to write.
Writes the text representation of a 4-byte signed integer to the text stream.
public
void
Write(long value)
value
The 8-byte signed integer to write.
Writes the text representation of an 8-byte signed integer to the text stream.
public
void
Write(object value)
value
The object to write.
Writes the text representation of an object to the text stream by calling the <see langword="ToString" /> method on that object.
Writes the text representation of a 4-byte floating-point value to the text stream.
public
void
Write(string value)
value
The string to write.
Writes a string to the text stream.
public
void
Write(string format,
object arg0)
format
A composite format string.
arg0
The object to format and write.
Writes a formatted string to the text stream, using the same semantics as the <see cref="M:System.String.Format(System.String,System.Object)" /> method.
public
void
Write(string format,
object arg0,
object arg1)
format
A composite format string.
arg0
The first object to format and write.
arg1
The second object to format and write.
Writes a formatted string to the text stream using the same semantics as the <see cref="M:System.String.Format(System.String,System.Object,System.Object)" /> method.
public
void
Write(string format,
object arg0,
object arg1,
object arg2)
format
A composite format string.
arg0
The first object to format and write.
arg1
The second object to format and write.
arg2
The third object to format and write.
Writes a formatted string to the text stream, using the same semantics as the <see cref="M:System.String.Format(System.String,System.Object,System.Object,System.Object)" /> method.
public
void
Write(string format,
object[] arg)
format
A composite format string.
arg
An object array that contains zero or more objects to format and write.
Writes a formatted string to the text stream, using the same semantics as the <see cref="M:System.String.Format(System.String,System.Object[])" /> method.
public
void
Write(Text.StringBuilder value)
value
The string, as a string builder, to write to the text stream.
Writes a string builder to the text stream.
public
void
Write(uint value)
value
The 4-byte unsigned integer to write.
Writes the text representation of a 4-byte unsigned integer to the text stream.
public
void
Write(ulong value)
value
The 8-byte unsigned integer to write.
Writes the text representation of an 8-byte unsigned integer to the text stream.
public
Threading.Tasks.Task
WriteAsync(char value)
value
The character to write to the text stream.
Returns A task that represents the asynchronous write operation.
Writes a character to the text stream asynchronously.
public
Threading.Tasks.Task
WriteAsync(char[] buffer)
buffer
The character array to write to the text stream. If <paramref name="buffer" /> is <see langword="null" /> , nothing is written.
Returns A task that represents the asynchronous write operation.
Writes a character array to the text stream asynchronously.
public
Threading.Tasks.Task
WriteAsync(char[] buffer,
int index,
int count)
buffer
The character array to write data from.
index
The character position in the buffer at which to start retrieving data.
count
The number of characters to write.
Returns A task that represents the asynchronous write operation.
Writes a subarray of characters to the text stream asynchronously.
public
Threading.Tasks.Task
WriteAsync(ReadOnlyMemory`1 buffer,
Threading.CancellationToken cancellationToken = null)
public
Threading.Tasks.Task
WriteAsync(string value)
value
The string to write. If <paramref name="value" /> is <see langword="null" /> , nothing is written to the text stream.
Returns A task that represents the asynchronous write operation.
Writes a string to the text stream asynchronously.
public
Threading.Tasks.Task
WriteAsync(Text.StringBuilder value,
Threading.CancellationToken cancellationToken = null)
value
The string, as a string builder, to write to the text stream.
cancellationToken
The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Returns A task that represents the asynchronous write operation.
Asynchronously writes a string builder to the text stream.
public
void
WriteLine()
Writes a line terminator to the text stream.
public
void
WriteLine(bool value)
value
The <see langword="Boolean" /> value to write.
Writes the text representation of a <see langword="Boolean" /> value to the text stream, followed by a line terminator.
public
void
WriteLine(char value)
value
The character to write to the text stream.
Writes a character to the text stream, followed by a line terminator.
public
void
WriteLine(char[] buffer)
buffer
The character array from which data is read.
Writes an array of characters to the text stream, followed by a line terminator.
public
void
WriteLine(char[] buffer,
int index,
int count)
buffer
The character array from which data is read.
index
The character position in <paramref name="buffer" /> at which to start reading data.
count
The maximum number of characters to write.
Writes a subarray of characters to the text stream, followed by a line terminator.
public
void
WriteLine(decimal value)
value
The decimal value to write.
Writes the text representation of a decimal value to the text stream, followed by a line terminator.
public
void
WriteLine(double value)
value
The 8-byte floating-point value to write.
Writes the text representation of a 8-byte floating-point value to the text stream, followed by a line terminator.
public
void
WriteLine(int value)
value
The 4-byte signed integer to write.
Writes the text representation of a 4-byte signed integer to the text stream, followed by a line terminator.
public
void
WriteLine(long value)
value
The 8-byte signed integer to write.
Writes the text representation of an 8-byte signed integer to the text stream, followed by a line terminator.
public
void
WriteLine(object value)
value
The object to write. If <paramref name="value" /> is <see langword="null" /> , only the line terminator is written.
Writes the text representation of an object to the text stream, by calling the <see langword="ToString" /> method on that object, followed by a line terminator.
Writes the text representation of a 4-byte floating-point value to the text stream, followed by a line terminator.
public
void
WriteLine(string value)
value
The string to write. If <paramref name="value" /> is <see langword="null" /> , only the line terminator is written.
Writes a string to the text stream, followed by a line terminator.
public
void
WriteLine(string format,
object arg0)
format
A composite format string.
arg0
The object to format and write.
Writes a formatted string and a new line to the text stream, using the same semantics as the <see cref="M:System.String.Format(System.String,System.Object)" /> method.
public
void
WriteLine(string format,
object arg0,
object arg1)
format
A composite format string.
arg0
The first object to format and write.
arg1
The second object to format and write.
Writes a formatted string and a new line to the text stream, using the same semantics as the <see cref="M:System.String.Format(System.String,System.Object,System.Object)" /> method.
public
void
WriteLine(string format,
object arg0,
object arg1,
object arg2)
format
A composite format string.
arg0
The first object to format and write.
arg1
The second object to format and write.
arg2
The third object to format and write.
Writes out a formatted string and a new line to the text stream, using the same semantics as <see cref="M:System.String.Format(System.String,System.Object)" /> .
public
void
WriteLine(string format,
object[] arg)
format
A composite format string.
arg
An object array that contains zero or more objects to format and write.
Writes out a formatted string and a new line to the text stream, using the same semantics as <see cref="M:System.String.Format(System.String,System.Object)" /> .
public
void
WriteLine(Text.StringBuilder value)
value
The string, as a string builder, to write to the text stream.
Writes the text representation of a string builder to the text stream, followed by a line terminator.
public
void
WriteLine(uint value)
value
The 4-byte unsigned integer to write.
Writes the text representation of a 4-byte unsigned integer to the text stream, followed by a line terminator.
public
void
WriteLine(ulong value)
value
The 8-byte unsigned integer to write.
Writes the text representation of an 8-byte unsigned integer to the text stream, followed by a line terminator.
public
Threading.Tasks.Task
WriteLineAsync() Returns A task that represents the asynchronous write operation.
Asynchronously writes a line terminator to the text stream.
public
Threading.Tasks.Task
WriteLineAsync(char value)
value
The character to write to the text stream.
Returns A task that represents the asynchronous write operation.
Asynchronously writes a character to the text stream, followed by a line terminator.
public
Threading.Tasks.Task
WriteLineAsync(char[] buffer)
buffer
The character array to write to the text stream. If the character array is <see langword="null" /> , only the line terminator is written.
Returns A task that represents the asynchronous write operation.
Asynchronously writes an array of characters to the text stream, followed by a line terminator.
public
Threading.Tasks.Task
WriteLineAsync(char[] buffer,
int index,
int count)
buffer
The character array to write data from.
index
The character position in the buffer at which to start retrieving data.
count
The number of characters to write.
Returns A task that represents the asynchronous write operation.
Asynchronously writes a subarray of characters to the text stream, followed by a line terminator.
public
Threading.Tasks.Task
WriteLineAsync(ReadOnlyMemory`1 buffer,
Threading.CancellationToken cancellationToken = null)
public
Threading.Tasks.Task
WriteLineAsync(string value)
value
The string to write. If the value is <see langword="null" /> , only a line terminator is written.
Returns A task that represents the asynchronous write operation.
Asynchronously writes a string to the text stream, followed by a line terminator.
public
Threading.Tasks.Task
WriteLineAsync(Text.StringBuilder value,
Threading.CancellationToken cancellationToken = null)
value
The string, as a string builder, to write to the text stream.
cancellationToken
The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Returns A task that represents the asynchronous write operation.
Asynchronously writes the text representation of a string builder to the text stream, followed by a line terminator.
public
object
GetLifetimeService()
Inherited from MarshalByRefObject
Returns An object of type <see cref="T:System.Runtime.Remoting.Lifetime.ILease" /> used to control the lifetime policy for this instance.
Retrieves the current lifetime service object that controls the lifetime policy for this instance.
public
object
InitializeLifetimeService()
Inherited from MarshalByRefObject
Returns An object of type <see cref="T:System.Runtime.Remoting.Lifetime.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 <see cref="P:System.Runtime.Remoting.Lifetime.LifetimeServices.LeaseManagerPollTime" /> property.
Obtains a lifetime service object to control the lifetime policy for this instance.
protected
MarshalByRefObject
MemberwiseClone(bool cloneIdentity)
Inherited from MarshalByRefObject
cloneIdentity
<see langword="false" /> to delete the current <see cref="T:System.MarshalByRefObject" /> object's identity, which will cause the object to be assigned a new identity when it is marshaled across a remoting boundary. A value of <see langword="false" /> is usually appropriate. <see langword="true" /> to copy the current <see cref="T:System.MarshalByRefObject" /> object's identity to its clone, which will cause remoting client calls to be routed to the remote server object.
Returns A shallow copy of the current <see cref="T:System.MarshalByRefObject" /> object.
Creates a shallow copy of the current <see cref="T:System.MarshalByRefObject" /> object.
public
bool
Equals(object obj)
Inherited from object
obj
The object to compare with the current object.
Returns <see langword="true" /> if the specified object is equal to the current object; otherwise, <see langword="false" /> .
Determines whether the specified object is equal to the current object.
protected
void
Finalize()
Inherited from object
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
public
int
GetHashCode()
Inherited from object
Returns A hash code for the current object.
Serves as the default hash function.
public
Type
GetType()
Inherited from object
Returns The exact runtime type of the current instance.
Gets the <see cref="T:System.Type" /> of the current instance.
protected
object
MemberwiseClone()
Inherited from object
Returns A shallow copy of the current <see cref="T:System.Object" /> .
Creates a shallow copy of the current <see cref="T:System.Object" /> .
public
string
ToString()
Inherited from object
Returns A string that represents the current object.
Returns a string that represents the current object.