LineWrappingTextWriter Class

public class LineWrappingTextWriter : TextWriter

Public Class LineWrappingTextWriter
	Inherits TextWriter

Dim instance As LineWrappingTextWriter

public ref class LineWrappingTextWriter : public TextWriter

Inheritance

Object    MarshalByRefObject    TextWriter    LineWrappingTextWriter

If the MaximumLineLength property is not zero, the LineWrappingTextWriter will buffer the data written to it until an explicit new line is present in the text, or until the length of the buffered data exceeds the value of the MaximumLineLength property.

If the length of the buffered data exceeds the value of the MaximumLineLength property, the LineWrappingTextWriter will attempt to find a white-space character to break the line at. If such a white-space character is found, everything before that character is output to the BaseWriter, followed by a line ending, and everything after that character is kept in the buffer. The white-space character itself is not written to the output.

If no suitable place to break the line could be found, the line is broken at the maximum line length. This may occur in the middle of a word. If the Wrapping property is set to EnabledNoForce, lines without a suitable white-space character will not be wrapped and can be longer than the value of the MaximumLineLength property.

After a line break (either one that was caused by wrapping or one that was part of the text), the next line is indented by the number of characters specified by the Indent property, unless the previous line was blank. The length of the indentation counts towards the maximum line length.

When the Flush or FlushAsync method is called, the current contents of the buffer are written to the BaseWriter, followed by a new line, unless the buffer is empty. If the buffer contains only indentation, it is considered empty and no new line is written. Calling Flush has the same effect as writing a new line to the LineWrappingTextWriter if the buffer is not empty. The LineWrappingTextWriter is flushed when the Dispose(Boolean) or DisposeAsync method is called.

The ResetIndent or ResetIndentAsync(CancellationToken) method can be used to move the output position back to the beginning of the line. If the buffer is not empty, is first flushed and indentation is reset to zero on the next line. After the next line break, indentation will again be set to the value of the Indent property.

If there is no maximum line length, output is written directly to the BaseWriter and buffering does not occur. Indentation is still inserted as appropriate.

The Flush, FlushAsync, Dispose(Boolean) and DisposeAsync methods will not write an additional new line if the MaximumLineLength property is zero.

Reference