Class YamlSerializerOptions

Configuration options for YamlSerializer.

Inheritance
Object
EncodingOptions
YamlSerializerOptions
Implements
Inherited Members
Namespace: Cuemon.Runtime.Serialization
Assembly: Cuemon.Core.dll
Syntax
public class YamlSerializerOptions : EncodingOptions, IEncodingOptions, IValidatableParameterObject, IParameterObject

Constructors

| Improve this Doc View Source

YamlSerializerOptions()

Initializes a new instance of the YamlSerializerOptions class.

Declaration
public YamlSerializerOptions()
Remarks

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

PropertyInitial Value
ConvertersList<T>
WhiteSpaceIndentation2
NamingPolicynull

Properties

| Improve this Doc View Source

Converters

Gets a YamlConverter collection that will be used during serialization.

Declaration
public IList<YamlConverter> Converters { get; set; }
Property Value
Type Description
IList<YamlConverter>

The converters that will be used during serialization.
| Improve this Doc View Source

NamingPolicy

Gets or sets a value that specifies the policy used to convert a property's name on an object to another format, or null to leave property names unchanged.

Declaration
public YamlNamingPolicy NamingPolicy { get; set; }
Property Value
Type Description
YamlNamingPolicy

A property naming policy, or null to leave property names unchanged.
| Improve this Doc View Source

ReflectionRules

Gets or sets the binding constraints for reflection based member searching.

Declaration
public MemberReflection ReflectionRules { get; set; }
Property Value
Type Description
MemberReflection

The binding constraints for reflection based member searching.
Exceptions
Type Condition
ArgumentNullException

value cannot be null.
| Improve this Doc View Source

WhiteSpaceIndentation

Gets or sets the white space indentation.

Declaration
public int WhiteSpaceIndentation { get; set; }
Property Value
Type Description
Int32

The white space indentation.

Methods

| Improve this Doc View Source

SetPropertyName(String)

Returns the specified name adhering to the underlying NamingPolicy.

Declaration
public string SetPropertyName(string name)
Parameters
Type Name Description
String name

The name of the property.
Returns
Type Description
String

When NamingPolicy is null, the specified name is returned unaltered; otherwise it is converted according to the NamingPolicy.
| Improve this Doc View Source

ValidateOptions()

Determines whether the public read-write properties of this instance are in a valid state.

Declaration
public void ValidateOptions()
Remarks

This method is expected to throw exceptions when one or more conditions fails to be in a valid state.

Exceptions
Type Condition
InvalidOperationException

Converters cannot be null - or -, ReflectionRules cannot be null.

Implements