Table of Contents

Class EncodingOptions

Namespace
Cuemon.Text
Assembly
Cuemon.Core.dll

Specifies options that is related to the System.Text.Encoding class.

public class EncodingOptions : IEncodingOptions, IParameterObject
Inheritance
Object
EncodingOptions
Implements
Derived

Constructors

EncodingOptions()

Initializes a new instance of the EncodingOptions class.

public EncodingOptions()

Remarks

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

PropertyInitial Value
PreambleDefaultPreambleSequence
EncodingDefaultEncoding

Properties

DefaultEncoding

Gets or sets the default encoding of EncodingOptions. Default is System.Text.Encoding.UTF8.

public static Encoding DefaultEncoding { get; set; }

Property Value

Encoding

The default encoding to use in System.Text.Encoding related operations.

Remarks

Warning: changing this value should be thought through carefully as it can change the behavior you have come to expect. Consider using local adjustment instead.

DefaultPreambleSequence

Gets or sets the default preamble action of EncodingOptions. Default is Remove.

public static PreambleSequence DefaultPreambleSequence { get; set; }

Property Value

PreambleSequence

The default preamble action to use in System.Text.Encoding related operations.

Remarks

Warning: changing this value should be thought through carefully as it can change the behavior you have come to expect. Consider using local adjustment instead.

Encoding

Gets or sets the encoding for the operation.

public Encoding Encoding { get; set; }

Property Value

Encoding

The encoding for the operation.

Exceptions

System.ArgumentNullException

value cannot be null.

Preamble

Gets or sets the action to take in regards to encoding related preamble sequences.

public PreambleSequence Preamble { get; set; }

Property Value

PreambleSequence

A value that indicates whether to preserve or remove preamble sequences.

Edit this page