Class StreamWriterOptions

Namespace

Cuemon.IO

Assembly

Cuemon.IO.dll

Configuration options for System.IO.StreamWriter.

public class StreamWriterOptions : StreamEncodingOptions, IParameterObject, IEncodingOptions

Inheritance

Object

DisposableOptions

StreamEncodingOptions

StreamWriterOptions

Implements

IParameterObject

IEncodingOptions

Inherited Members

StreamEncodingOptions.Preamble

StreamEncodingOptions.Encoding

DisposableOptions.LeaveOpen

Constructors

StreamWriterOptions()

Initializes a new instance of the StreamWriterOptions class.

public StreamWriterOptions()

Remarks

The following table shows the initial property values for an instance of StreamWriterOptions.

Property	Initial Value
AutoFlush	false
BufferSize	1024
Preamble	Keep
Encoding	DefaultEncoding
FormatProvider	System.Globalization.CultureInfo.InvariantCulture
NewLine	System.Environment.NewLine

Properties

AutoFlush

Gets or sets a value indicating whether the System.IO.StreamWriter will flush its buffer to the underlying stream after every call to the Write method.

public bool AutoFlush { get; set; }

Property Value

Boolean

true to force System.IO.StreamWriter to flush its buffer; otherwise, false.

BufferSize

Gets or sets the size of the buffer.

public int BufferSize { get; set; }

Property Value

Int32

The size of the buffer in bytes for the System.IO.StreamWriter.

FormatProvider

Gets or sets the culture-specific formatting information used when writing data with the System.IO.StreamWriter.

public IFormatProvider FormatProvider { get; set; }

Property Value

IFormatProvider

An System.IFormatProvider that contains the culture-specific formatting information. The default is System.Globalization.CultureInfo.InvariantCulture.

NewLine

Gets or sets the line terminator string used by the System.IO.StreamWriter.

public string NewLine { get; set; }

Property Value

String

The line terminator string for the System.IO.StreamWriter.