Class EncodingOptions

Specifies options that is related to Encoding operations.

Inheritance

System.Object

EncodingOptions

FallbackEncodingOptions

Namespace: Cuemon.Text

Assembly: Cuemon.Core.dll

Syntax

public class EncodingOptions

Constructors

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

DefaultEncoding

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

Declaration

public static Encoding DefaultEncoding { get; set; }

Property Value

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

Remarks

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.

Declaration

public static PreambleSequence DefaultPreambleSequence { get; set; }

Property Value

Type	Description
PreambleSequence	The default preamble action to use in Encoding related operations.

Remarks

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.

Declaration

public Encoding Encoding { get; set; }

Property Value

Type	Description
System.Text.Encoding	The encoding for the operation.

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.

Methods

DetectEncoding(Byte[])

Tries to detect an System.Text.Encoding object from the specified value. If unsuccessful, the encoding of this instance is returned.

Declaration

public Encoding DetectEncoding(byte[] value)

Parameters

Type	Name	Description
System.Byte[]	value	The System.Byte array to parse for an System.Text.Encoding.

Returns

Type	Description
System.Text.Encoding	Either the detected encoding of value or the encoding of this instance.

DetectEncoding(Stream)

Tries to detect an System.Text.Encoding object from the specified value. If unsuccessful, the encoding of this instance is returned.

Declaration

public Encoding DetectEncoding(Stream value)

Parameters

Type	Name	Description
System.IO.Stream	value	The System.IO.Stream to parse for an System.Text.Encoding.

Returns

Type	Description
System.Text.Encoding	Either the detected encoding of value or the encoding of this instance.

Extension Methods

ConverterExtensions.ParseWith<TSource, TResult>(TSource, Func<TSource, TResult>)

ConverterExtensions.ParseWith<TSource, T, TResult>(TSource, Func<TSource, T, TResult>, T)

ConverterExtensions.ParseWith<TSource, T1, T2, TResult>(TSource, Func<TSource, T1, T2, TResult>, T1, T2)

ConverterExtensions.ParseWith<TSource, T1, T2, T3, TResult>(TSource, Func<TSource, T1, T2, T3, TResult>, T1, T2, T3)

ConverterExtensions.ParseWith<TSource, T1, T2, T3, T4, TResult>(TSource, Func<TSource, T1, T2, T3, T4, TResult>, T1, T2, T3, T4)

ConverterExtensions.ParseWith<TSource, T1, T2, T3, T4, T5, TResult>(TSource, Func<TSource, T1, T2, T3, T4, T5, TResult>, T1, T2, T3, T4, T5)

ConverterExtensions.ParseWith<TSource, T1, T2, T3, T4, T5, T6, TResult>(TSource, Func<TSource, T1, T2, T3, T4, T5, T6, TResult>, T1, T2, T3, T4, T5, T6)

ConverterExtensions.ParseWith<TSource, T1, T2, T3, T4, T5, T6, T7, TResult>(TSource, Func<TSource, T1, T2, T3, T4, T5, T6, T7, TResult>, T1, T2, T3, T4, T5, T6, T7)

ConverterExtensions.ParseWith<TSource, T1, T2, T3, T4, T5, T6, T7, T8, TResult>(TSource, Func<TSource, T1, T2, T3, T4, T5, T6, T7, T8, TResult>, T1, T2, T3, T4, T5, T6, T7, T8)

ConverterExtensions.ParseWith<TSource, T1, T2, T3, T4, T5, T6, T7, T8, T9, TResult>(TSource, Func<TSource, T1, T2, T3, T4, T5, T6, T7, T8, T9, TResult>, T1, T2, T3, T4, T5, T6, T7, T8, T9)

ConverterExtensions.As<TResult>(Object)

ConverterExtensions.As<TResult>(Object, TResult)

ConverterExtensions.As<TResult>(Object, TResult, IFormatProvider)

DelegateUtilityExtensions.Wrap<TResult>(TResult)

DelegateUtilityExtensions.DynamicWrap<TResult>(TResult)

TweakerExtensions.Adjust<T>(T, Func<T, T>)

TypeUtilityExtensions.Is<T>(Object)

TypeUtilityExtensions.IsNot<T>(Object)

TypeUtilityExtensions.IsNullable<T>(T)

WrapperExtensions.UseWrapper<T>(T, Action<IDictionary<String, Object>>)

WrapperExtensions.UseWrapper<T>(T, MemberInfo, Action<IDictionary<String, Object>>)

EnumerableUtilityExtensions.Yield<TSource>(TSource)

HashUtilityExtensions.ComputeHash(Object, Action<HashOptions>)

HmacUtilityExtensions.ComputeKeyedHash(Object, Byte[], Action<KeyedHashOptions>)