Class EncodingOptions

Specifies options that is related to the Encoding class.

Inheritance

Object

EncodingOptions

YamlSerializerOptions

AsyncEncodingOptions

FallbackEncodingOptions

YamlFormatterOptions

XmlEncodingOptions

Implements

IEncodingOptions

IParameterObject

Namespace: Cuemon.Text

Assembly: Cuemon.Core.dll

Syntax

public class EncodingOptions : IEncodingOptions, IParameterObject

Constructors

| Improve this Doc View Source

EncodingOptions()

Initializes a new instance of the EncodingOptions class.

Declaration

public EncodingOptions()

Remarks

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

Property	Initial Value
Preamble	DefaultPreambleSequence
Encoding	DefaultEncoding

Properties

| Improve this Doc View Source

DefaultEncoding

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

Declaration

public static Encoding DefaultEncoding { get; set; }

Property Value

Type	Description
Encoding	The default encoding to use in 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.

| Improve this Doc View Source

DefaultPreambleSequence

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

Declaration

public static PreambleSequence DefaultPreambleSequence { get; set; }

Property Value

Type	Description
PreambleSequence	The default preamble action to use in 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.

| Improve this Doc View Source

Encoding

Gets or sets the encoding for the operation.

Declaration

public Encoding Encoding { get; set; }

Property Value

Type	Description
Encoding	The encoding for the operation.

Exceptions

Type	Condition
ArgumentNullException	`value` cannot be null.

| Improve this Doc View Source

Preamble

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

Declaration

public PreambleSequence Preamble { get; set; }

Property Value

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

Implements

IEncodingOptions

IParameterObject