LineWrappingTextWriterForStringWriter Method
Namespace: Ookii.CommandLineAssembly: Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 4.2.0+a4d3631e4dcc0970081ed435288efdebc1325f83
public static LineWrappingTextWriter ForStringWriter(
int maximumLineLength = 0,
IFormatProvider? formatProvider = null,
bool countFormatting = false
)
Public Shared Function ForStringWriter (
Optional maximumLineLength As Integer = 0,
Optional formatProvider As IFormatProvider = Nothing,
Optional countFormatting As Boolean = false
) As LineWrappingTextWriter
Dim maximumLineLength As Integer
Dim formatProvider As IFormatProvider
Dim countFormatting As Boolean
Dim returnValue As LineWrappingTextWriter
returnValue = LineWrappingTextWriter.ForStringWriter(maximumLineLength,
formatProvider, countFormatting)
public:
static LineWrappingTextWriter^ ForStringWriter(
int maximumLineLength = 0,
IFormatProvider^ formatProvider = nullptr,
bool countFormatting = false
)
- maximumLineLength Int32 (Optional)
-
The maximum length of a line, in characters, or 0 to use no maximum.
- formatProvider IFormatProvider (Optional)
- An IFormatProvider that controls formatting.
- countFormatting Boolean (Optional)
-
If set to , virtual terminal sequences used to format the text
will not be counted as part of the line length, and will therefore not affect where
the text is wrapped. The default value is .
LineWrappingTextWriterA
LineWrappingTextWriter that writes to a
StringWriter.
To retrieve the resulting string, call the
ToString method. The result
will include any unflushed text without flushing that text to the
BaseWriter.