Class YamlFormatterOptions

Configuration options for YamlFormatter.

Inheritance
Object
EncodingOptions
YamlFormatterOptions
Implements
Inherited Members
Namespace: Cuemon.Text.Yaml.Formatters
Assembly: Cuemon.Core.dll
Syntax
public sealed class YamlFormatterOptions : EncodingOptions, IEncodingOptions, IValidatableParameterObject, IParameterObject

Constructors

| Improve this Doc View Source

YamlFormatterOptions()

Initializes a new instance of the YamlFormatterOptions class.

Declaration
public YamlFormatterOptions()
Remarks

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

PropertyInitial Value

Properties

| Improve this Doc View Source

DefaultConverters

Gets or sets a delegate that is invoked when YamlFormatterOptions is initialized and propagates registered YamlConverter implementations.

Declaration
public static Action<IList<YamlConverter>> DefaultConverters { get; set; }
Property Value
Type Description
Action<IList<YamlConverter>>

The delegate which propagates registered YamlConverter implementations when YamlFormatterOptions is initialized.
| Improve this Doc View Source

Settings

Gets or sets the settings to support the YamlConverter.

Declaration
public YamlSerializerOptions Settings { get; set; }
Property Value
Type Description
YamlSerializerOptions

A YamlSerializerOptions instance that specifies a set of features to support the YamlConverter object.

Methods

| 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

Settings cannot be null.

Implements