Class ConsoleDocumentRenderer
An IDocumentRenderer<T> which writes formatted text to the Console.
Inheritance
- object
- ConsoleDocumentRenderer
Implements
Inherited Members
- object.GetType()
- object.MemberwiseClone()
- object.ToString()
- object.Equals(object)
- object.Equals(object, object)
- object.ReferenceEquals(object, object)
- object.GetHashCode()
Declaration
public class ConsoleDocumentRenderer : IDocumentRenderer<ConsoleFormattingAnnotation>Constructors
ConsoleDocumentRenderer()
An IDocumentRenderer<T> which writes formatted text to the Console.
Declaration
public ConsoleDocumentRenderer()Methods
NewLine(CancellationToken)
Write a line break into the output stream.
Declaration
public ValueTask NewLine(CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
cancellationToken |
Returns
| Type | Description |
|---|---|
A ValueTask which will complete when the line break has been written to the output stream. |
PopAnnotation(CancellationToken)
Discard the value of a previous call to PushAnnotation(T, CancellationToken).
Declaration
public ValueTask PopAnnotation(CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
cancellationToken |
Returns
| Type | Description |
|---|---|
A ValueTask which will complete when the value has been popped from the stack. |
PushAnnotation(ConsoleFormattingAnnotation, CancellationToken)
Accept an annotation.
Declaration
public ValueTask PushAnnotation(ConsoleFormattingAnnotation value, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
value |
The annotation to push onto the stack. |
|
cancellationToken |
Returns
| Type | Description |
|---|---|
A ValueTask which will complete when the value has been pushed onto the stack. |
Text(ReadOnlyMemory<char>, CancellationToken)
Write some text into the output stream.
Declaration
public ValueTask Text(ReadOnlyMemory<char> memory, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
memory |
The text to write to the output stream. |
|
cancellationToken |
Returns
| Type | Description |
|---|---|
A ValueTask which will complete when the text has been written to the output stream. |
WhiteSpace(int, CancellationToken)
Write the given amount of
blank space into the output stream.
Declaration
public ValueTask WhiteSpace(int amount, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
amount |
The amount of white space to write. |
|
cancellationToken |
Returns
| Type | Description |
|---|---|
A ValueTask which will complete when the white space has been written to the output stream. |