YamlDotNet.Core : YamlDotNet.Core.Events Namespace

Scalar Class

Represents a scalar event.

public class Scalar : NodeEvent, IScalar

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: YamlDotNet.Core.Events
Assembly: YamlDotNet.Core (in YamlDotNet.Core.dll)
Assembly Versions: 0.2.3385.42326

Members

See Also: Inherited members from NodeEvent.

Public Constructors

Initializes a new instance of the YamlDotNet.Core.Events.Scalar class.
Initializes a new instance of the YamlDotNet.Core.Events.Scalar class.
Initializes a new instance of the YamlDotNet.Core.Events.Scalar class.
Initializes a new instance of the YamlDotNet.Core.Events.Scalar class.
Initializes a new instance of the YamlDotNet.Core.Events.Scalar class.

Public Properties

[read-only]
override
IsCanonical bool . Gets a value indicating whether this instance is canonical.
[read-only]
IsPlainImplicit bool . Gets a value indicating whether the tag is optional for the plain style.
[read-only]
IsQuotedImplicit bool . Gets a value indicating whether the tag is optional for any non-plain style.
[read-only]
override
NestingIncrease int . Gets a value indicating the variation of depth caused by this event. The value can be either -1, 0 or 1. For start events, it will be 1, for end events, it will be -1, and for the remaining events, it will be 0.
[read-only]
Style YamlDotNet.Core.ScalarStyle . Gets the style of the scalar.
[read-only]
Value string . Gets the value.

Public Methods

override
ToString () : string
Returns a string that represents the current object.

Member Details

Scalar Constructor

Initializes a new instance of the YamlDotNet.Core.Events.Scalar class.

public Scalar (string value)

Parameters

value
The value.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: YamlDotNet.Core.Events
Assembly: YamlDotNet.Core (in YamlDotNet.Core.dll)
Assembly Versions: 0.2.3385.42326

Scalar Constructor

Initializes a new instance of the YamlDotNet.Core.Events.Scalar class.

public Scalar (string tag, string value)

Parameters

tag
The tag.
value
The value.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: YamlDotNet.Core.Events
Assembly: YamlDotNet.Core (in YamlDotNet.Core.dll)
Assembly Versions: 0.2.3385.42326

Scalar Constructor

Initializes a new instance of the YamlDotNet.Core.Events.Scalar class.

public Scalar (string alias, string tag, string value)

Parameters

alias
The alias.
tag
The tag.
value
The value.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: YamlDotNet.Core.Events
Assembly: YamlDotNet.Core (in YamlDotNet.Core.dll)
Assembly Versions: 0.2.3385.42326

Scalar Constructor

Initializes a new instance of the YamlDotNet.Core.Events.Scalar class.

public Scalar (string anchor, string tag, string value, YamlDotNet.Core.ScalarStyle style, bool isPlainImplicit, bool isQuotedImplicit)

Parameters

anchor
The anchor.
tag
The tag.
value
The value.
style
The style.
isPlainImplicit
.
isQuotedImplicit
.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: YamlDotNet.Core.Events
Assembly: YamlDotNet.Core (in YamlDotNet.Core.dll)
Assembly Versions: 0.2.3385.42326

Scalar Constructor

Initializes a new instance of the YamlDotNet.Core.Events.Scalar class.

public Scalar (string anchor, string tag, string value, YamlDotNet.Core.ScalarStyle style, bool isPlainImplicit, bool isQuotedImplicit, YamlDotNet.Core.Mark start, YamlDotNet.Core.Mark end)

Parameters

anchor
The anchor.
tag
The tag.
value
The value.
style
The style.
isPlainImplicit
.
isQuotedImplicit
.
start
The start position of the event.
end
The end position of the event.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: YamlDotNet.Core.Events
Assembly: YamlDotNet.Core (in YamlDotNet.Core.dll)
Assembly Versions: 0.2.3385.42326

IsCanonical Property

Gets a value indicating whether this instance is canonical.

public override bool IsCanonical { get; }

Value

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: YamlDotNet.Core.Events
Assembly: YamlDotNet.Core (in YamlDotNet.Core.dll)
Assembly Versions: 0.2.3385.42326

IsPlainImplicit Property

Gets a value indicating whether the tag is optional for the plain style.

public bool IsPlainImplicit { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: YamlDotNet.Core.Events
Assembly: YamlDotNet.Core (in YamlDotNet.Core.dll)
Assembly Versions: 0.2.3385.42326

IsQuotedImplicit Property

Gets a value indicating whether the tag is optional for any non-plain style.

public bool IsQuotedImplicit { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: YamlDotNet.Core.Events
Assembly: YamlDotNet.Core (in YamlDotNet.Core.dll)
Assembly Versions: 0.2.3385.42326

NestingIncrease Property

Gets a value indicating the variation of depth caused by this event. The value can be either -1, 0 or 1. For start events, it will be 1, for end events, it will be -1, and for the remaining events, it will be 0.

public override int NestingIncrease { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: YamlDotNet.Core.Events
Assembly: YamlDotNet.Core (in YamlDotNet.Core.dll)
Assembly Versions: 0.2.3385.42326

Style Property

Gets the style of the scalar.

public YamlDotNet.Core.ScalarStyle Style { get; }

Value

The style.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: YamlDotNet.Core.Events
Assembly: YamlDotNet.Core (in YamlDotNet.Core.dll)
Assembly Versions: 0.2.3385.42326

ToString Method

Returns a string that represents the current object.

public override string ToString ()

Returns

A string that represents the current object.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: YamlDotNet.Core.Events
Assembly: YamlDotNet.Core (in YamlDotNet.Core.dll)
Assembly Versions: 0.2.3385.42326

Value Property

Gets the value.

public string Value { get; }

Value

The value.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: YamlDotNet.Core.Events
Assembly: YamlDotNet.Core (in YamlDotNet.Core.dll)
Assembly Versions: 0.2.3385.42326