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.CodeDom.Compiler.IndentedTextWriter
Assembly: System.Runtime
Inheritance: object → MarshalByRefObject → IO.TextWriter → IndentedTextWriter
Provides a text writer that can indent new lines by a tab string token.
Fields and Constants
public const
string
DefaultTabString
Specifies the default tab string. This field is constant.
protected
char[]
CoreNewLine
Stores the newline characters used for this <see langword="TextWriter" /> .
Properties
public
Text.Encoding
Encoding
Gets the encoding for the text writer to use.
public
int
Indent
Gets or sets the number of spaces to indent.
public
IO.TextWriter
InnerWriter
Gets the <see cref="T:System.IO.TextWriter" /> to use.
public
string
NewLine
Gets or sets the new line character to use.
public
IFormatProvider
FormatProvider
Gets an object that controls formatting.
Methods
public
void
Close()
Closes the document being written to.
public
Threading.Tasks.ValueTask
DisposeAsync() Returns A <see cref="T:System.Threading.Tasks.ValueTask" /> representing the asynchronous dispose operation.
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources asynchronously.
public
void
Flush()
Flushes the stream.
public
Threading.Tasks.Task
FlushAsync() Returns A <see cref="T:System.Threading.Tasks.Task" /> representing the asynchronous flush operation.
Clears all buffers for this <see cref="T:System.CodeDom.Compiler.IndentedTextWriter" /> asynchronously 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" /> representing the asynchronous flush operation.
Clears all buffers for this <see cref="T:System.CodeDom.Compiler.IndentedTextWriter" /> asynchronously and causes any buffered data to be written to the underlying device.
protected
void
OutputTabs()
Outputs the tab string once for each level of indentation according to the <see cref="P:System.CodeDom.Compiler.IndentedTextWriter.Indent" /> property.
protected
Threading.Tasks.Task
OutputTabsAsync() Returns A <see cref="T:System.Threading.Tasks.Task" /> representing the asynchronous operation.
Asynchronously outputs tabs to the underlying <see cref="T:System.IO.TextWriter" /> based on the current <see cref="P:System.CodeDom.Compiler.IndentedTextWriter.Indent" /> .
public
void
Write(bool value)
value
The Boolean value to write.
Writes the text representation of a Boolean value to the text stream.
public
void
Write(char value)
value
The character to write.
Writes a character to the text stream.
public
void
Write(char[] buffer)
buffer
The character array to write.
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
Starting index in the buffer.
count
The number of characters to write.
Writes a subarray of characters to the text stream.
public
void
Write(double value)
value
The <see langword="double" /> to write.
Writes the text representation of a Double to the text stream.
public
void
Write(int value)
value
The integer to write.
Writes the text representation of an integer to the text stream.
public
void
Write(long value)
value
The 8-byte integer to write.
Writes the text representation of an 8-byte 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.
Writes the text representation of a Single to the text stream.
public
void
Write(string s)
s
The string to write.
Writes the specified string to the text stream.
public
void
Write(string format,
object arg0)
format
The formatting string.
arg0
The object to write into the formatted string.
Writes out a formatted string, using the same semantics as specified.
public
void
Write(string format,
object arg0,
object arg1)
format
The formatting string to use.
arg0
The first object to write into the formatted string.
arg1
The second object to write into the formatted string.
Writes out a formatted string, using the same semantics as specified.
public
void
Write(string format,
object[] arg)
format
The formatting string to use.
arg
The argument array to output.
Writes out a formatted string, using the same semantics as specified.
public
Threading.Tasks.Task
WriteAsync(char value)
value
The <see cref="T:System.Char" /> to write.
Returns A <see cref="T:System.Threading.Tasks.Task" /> representing the asynchronous operation.
Asynchronously writes the specified <see cref="T:System.Char" /> to the underlying <see cref="T:System.IO.TextWriter" /> , inserting tabs at the start of every line.
public
Threading.Tasks.Task
WriteAsync(char[] buffer,
int index,
int count)
buffer
The array to write from.
index
Index in the array to stort writing at.
count
The number of characters to write.
Returns A <see cref="T:System.Threading.Tasks.Task" /> representing the asynchronous operation.
Asynchronously writes the specified number of <see cref="T:System.Char" /> s from the specified buffer to the underlying <see cref="T:System.IO.TextWriter" /> , starting at the specified index, and outputting tabs at the start of every new line.
public
Threading.Tasks.Task
WriteAsync(ReadOnlyMemory`1 buffer,
Threading.CancellationToken cancellationToken = null)
public
Threading.Tasks.Task
WriteAsync(string value)
value
The string to write.
Returns A <see cref="T:System.Threading.Tasks.Task" /> representing the asynchronous operation.
Asynchronously writes the specified string to the underlying <see cref="T:System.IO.TextWriter" /> , inserting tabs at the start of every line.
public
Threading.Tasks.Task
WriteAsync(Text.StringBuilder value,
Threading.CancellationToken cancellationToken = null)
value
The text to write.
cancellationToken
Token for canceling the operation.
Returns A <see cref="T:System.Threading.Tasks.Task" /> representing the asynchronous operation.
Asynchronously writes the contents of the specified <see cref="T:System.Text.StringBuilder" /> to the underlying <see cref="T:System.IO.TextWriter" /> , inserting tabs at the start of every line.
public
void
WriteLine()
Writes a line terminator.
public
void
WriteLine(bool value)
value
The Boolean to write.
Writes the text representation of a Boolean, followed by a line terminator, to the text stream.
public
void
WriteLine(char value)
value
The character to write.
Writes a character, followed by a line terminator, to the text stream.
public
void
WriteLine(char[] buffer)
buffer
The character array to write.
Writes a character array, followed by a line terminator, to the text stream.
public
void
WriteLine(char[] buffer,
int index,
int count)
buffer
The character array to write data from.
index
Starting index in the buffer.
count
The number of characters to write.
Writes a subarray of characters, followed by a line terminator, to the text stream.
public
void
WriteLine(double value)
value
The <see langword="double" /> to write.
Writes the text representation of a Double, followed by a line terminator, to the text stream.
public
void
WriteLine(int value)
value
The integer to write.
Writes the text representation of an integer, followed by a line terminator, to the text stream.
public
void
WriteLine(long value)
value
The 8-byte integer to write.
Writes the text representation of an 8-byte integer, followed by a line terminator, to the text stream.
public
void
WriteLine(object value)
value
The object to write.
Writes the text representation of an object, followed by a line terminator, to the text stream.
Writes the text representation of a Single, followed by a line terminator, to the text stream.
public
void
WriteLine(string s)
s
The string to write.
Writes the specified string, followed by a line terminator, to the text stream.
public
void
WriteLine(string format,
object arg0)
format
The formatting string.
arg0
The object to write into the formatted string.
Writes out a formatted string, followed by a line terminator, using the same semantics as specified.
public
void
WriteLine(string format,
object arg0,
object arg1)
format
The formatting string to use.
arg0
The first object to write into the formatted string.
arg1
The second object to write into the formatted string.
Writes out a formatted string, followed by a line terminator, using the same semantics as specified.
public
void
WriteLine(string format,
object[] arg)
format
The formatting string to use.
arg
The argument array to output.
Writes out a formatted string, followed by a line terminator, using the same semantics as specified.
public
void
WriteLine(uint value)
value
A UInt32 to output.
Writes the text representation of a UInt32, followed by a line terminator, to the text stream.
public
Threading.Tasks.Task
WriteLineAsync() Returns A <see cref="T:System.Threading.Tasks.Task" /> representing the asynchronous line writing operation.
Asynchronously writes the line terminator to the underlying <see cref="T:System.IO.TextWriter" /> .
public
Threading.Tasks.Task
WriteLineAsync(char value)
value
The character to write.
Returns A <see cref="T:System.Threading.Tasks.Task" /> representing the asynchronous operation.
Asynchronously writes the specified <see cref="T:System.Char" /> to the underlying <see cref="T:System.IO.TextWriter" /> followed by a line terminator, inserting tabs at the start of every line.
public
Threading.Tasks.Task
WriteLineAsync(char[] buffer,
int index,
int count)
buffer
The buffer containing characters to write.
index
The index within the buffer to start writing at.
count
The number of characters to write.
Returns A <see cref="T:System.Threading.Tasks.Task" /> representing the asynchronous operation.
Asynchronously writes the specified number of characters from the specified buffer followed by a line terminator, to the underlying <see cref="T:System.IO.TextWriter" /> , starting at the specified index within the buffer, inserting tabs at the start of every line.
public
Threading.Tasks.Task
WriteLineAsync(ReadOnlyMemory`1 buffer,
Threading.CancellationToken cancellationToken = null)
public
Threading.Tasks.Task
WriteLineAsync(string value)
value
The string to write.
Returns A <see cref="T:System.Threading.Tasks.Task" /> representing the asynchronous operation.
Asynchronously writes the specified string followed by a line terminator to the underlying <see cref="T:System.IO.TextWriter" /> , inserting tabs at the start of every line.
public
Threading.Tasks.Task
WriteLineAsync(Text.StringBuilder value,
Threading.CancellationToken cancellationToken = null)
value
The text to write.
cancellationToken
Token for canceling the operation.
Returns A <see cref="T:System.Threading.Tasks.Task" /> representing the asynchronous operation.
Asynchronously writes the contents of the specified <see cref="T:System.Text.StringBuilder" /> followed by a line terminator to the underlying <see cref="T:System.IO.TextWriter" /> , inserting tabs at the start of every line.
public
void
WriteLineNoTabs(string s)
s
The string to write.
Writes the specified string to a line without tabs.
public
Threading.Tasks.Task
WriteLineNoTabsAsync(string s)
s
The string to write.
Returns A <see cref="T:System.Threading.Tasks.Task" /> representing the asynchronous operation.
Asynchronously writes the specified string to the underlying <see cref="T:System.IO.TextWriter" /> without inserting tabs.
Releases all resources used by the <see cref="T:System.IO.TextWriter" /> object.
protected
void
Dispose(bool disposing)
Inherited from TextWriter
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.
Writes the text representation of a decimal value to the text stream.
public
void
Write(string format,
object arg0,
object arg1,
object arg2)
Inherited from TextWriter
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(Text.StringBuilder value)
Inherited from TextWriter
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)
Inherited from TextWriter
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)
Inherited from TextWriter
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[] buffer)
Inherited from TextWriter
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.
Writes the text representation of a decimal value to the text stream, followed by a line terminator.
public
void
WriteLine(string format,
object arg0,
object arg1,
object arg2)
Inherited from TextWriter
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(Text.StringBuilder value)
Inherited from TextWriter
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(ulong value)
Inherited from TextWriter
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(char[] buffer)
Inherited from TextWriter
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
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.