MappingStart Class

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

Represents a mapping start event.

public sealed class MappingStart : NodeEvent

Inheritance: NodeEvent MappingStart

Constructors

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

MappingStart overloads

MappingStart()

MappingStart.cs

Initializes a new instance of the MappingStart class.

public MappingStart()

MappingStart(string?, string?, bool, YamlStyle)

MappingStart.cs

Initializes a new instance of the MappingStart class.

public MappingStart(string? anchor, string? tag, bool isImplicit, YamlStyle style)

Parameters

anchor string?: The anchor.
tag string?: The tag.
isImplicit bool: Indicates whether the event is implicit.
style YamlStyle: The style of the mapping.

MappingStart(string?, string?, bool, YamlStyle, Mark, Mark)

MappingStart.cs

Initializes a new instance of the MappingStart class.

public MappingStart(string? anchor, string? tag, bool isImplicit, YamlStyle style, Mark start, Mark end)

Parameters

anchor string?: The anchor.
tag string?: The tag.
isImplicit bool: Indicates whether the event is implicit.
style YamlStyle: The style of the mapping.
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.
IsImplicit	Gets a value indicating whether this instance is implicit.
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 mapping.

IsCanonical

MappingStart.cs

Gets a value indicating whether this instance is canonical.

public override bool IsCanonical { get; }

Property value

bool

IsImplicit

MappingStart.cs

Gets a value indicating whether this instance is implicit.

public bool IsImplicit { get; }

Property value

bool true if this instance is implicit; otherwise, false.

NestingIncrease

MappingStart.cs

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

int

Style

MappingStart.cs

Gets the style of the mapping.

public YamlStyle Style { get; }

Property value

YamlStyle

Methods

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

ToString()

MappingStart.cs

Returns a String that represents the current Object.

public override string ToString()

Returns

string A String that represents the current Object.