Scalar Class

Namespace: Meziantou.Framework.Yaml.Events
Assembly: Meziantou.Framework.Yaml.dll
Package: Meziantou.Framework.Yaml 2.0.11
Source: Scalar.cs
Available in package assets: net10.0net11.0

Represents a scalar event.

public sealed class Scalar : NodeEvent

Inheritance: NodeEvent Scalar

Constructors

Name	Description
Scalar(string)	Initializes a new instance of the `Scalar` class.
Scalar(string, ScalarStyle)	Initializes a new instance of the `Scalar` class.
Scalar(string?, string)	Initializes a new instance of the `Scalar` class.
Scalar(string, string, string)	Initializes a new instance of the `Scalar` class.
Scalar(string?, string?, string, ScalarStyle, bool, bool)	Initializes a new instance of the `Scalar` class.
Scalar(string?, string?, string, ScalarStyle, bool, bool, Mark, Mark)	Initializes a new instance of the `Scalar` class.

Scalar overloads

Scalar(string)

Initializes a new instance of the Scalar class.

public Scalar(string value)

Parameters

value string: The value.

Scalar(string, ScalarStyle)

Initializes a new instance of the Scalar class.

public Scalar(string value, ScalarStyle style)

Parameters

value string: The value.
style ScalarStyle: The style of this scalar

Scalar(string?, string)

Initializes a new instance of the Scalar class.

public Scalar(string? tag, string value)

Parameters

tag string?: The tag.
value string: The value.

Scalar(string, string, string)

Initializes a new instance of the Scalar class.

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

Parameters

anchor string
tag string
value string

Scalar(string?, string?, string, ScalarStyle, bool, bool)

Initializes a new instance of the Scalar class.

public Scalar(string? anchor, string? tag, string value, ScalarStyle style, bool isPlainImplicit, bool isQuotedImplicit)

Parameters

anchor string?: The anchor.
tag string?: The tag.
value string: The value.
style ScalarStyle: The style.
isPlainImplicit bool: .
isQuotedImplicit bool: .

Scalar(string?, string?, string, ScalarStyle, bool, bool, Mark, Mark)

Initializes a new instance of the Scalar class.

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

Parameters

anchor string?: The anchor.
tag string?: The tag.
value string: The value.
style ScalarStyle: The style.
isPlainImplicit bool: .
isQuotedImplicit bool: .
start Mark: The start position of the event.
end Mark: The end position of the event.

Properties

Name	Description
IsCanonical	Gets a value indicating whether this instance is canonical.
IsPlainImplicit	Gets a value indicating whether the tag is optional for the plain style.
IsQuotedImplicit	Gets a value indicating whether the tag is optional for any non-plain style.
NestingIncrease	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.
Style	Gets the style of the scalar.
Value	Gets the value.

IsCanonical

Gets a value indicating whether this instance is canonical.

public override bool IsCanonical { get; }

Property value

IsPlainImplicit

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

public bool IsPlainImplicit { get; }

Property value

IsQuotedImplicit

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

public bool IsQuotedImplicit { get; }

Property value

NestingIncrease

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; }

Property value

Style

Gets the style of the scalar.

public ScalarStyle Style { get; }

Property value

ScalarStyle The style.

Value

Gets the value.

public string Value { get; }

Property value

string The value.

Methods

Name	Description
ToString()	Returns a `String` that represents the current `Object`.

ToString()

Returns a String that represents the current Object.

public override string ToString()

Returns

string A String that represents the current Object.