Meziantou.Framework

DocumentStart Class

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

Represents a document start event.

public sealed class DocumentStart : ParsingEvent
Inheritance
ParsingEvent DocumentStart

Constructors

NameDescription
DocumentStart()Initializes a new instance of the DocumentStart class.
DocumentStart(Mark, Mark)Initializes a new instance of the DocumentStart class.
DocumentStart(VersionDirective?, TagDirectiveCollection?, bool)Initializes a new instance of the DocumentStart class.
DocumentStart(VersionDirective?, TagDirectiveCollection?, bool, Mark, Mark)Initializes a new instance of the DocumentStart class.

DocumentStart overloads

DocumentStart()

DocumentStart.cs

Initializes a new instance of the DocumentStart class.

public DocumentStart()

DocumentStart(Mark, Mark)

DocumentStart.cs

Initializes a new instance of the DocumentStart class.

public DocumentStart(Mark start, Mark end)
Parameters
start Mark
The start position of the event.
end Mark
The end position of the event.

DocumentStart(VersionDirective?, TagDirectiveCollection?, bool)

DocumentStart.cs

Initializes a new instance of the DocumentStart class.

public DocumentStart(VersionDirective? version, TagDirectiveCollection? tags, bool isImplicit)
Parameters
version VersionDirective?
The version.
tags TagDirectiveCollection?
The tags.
isImplicit bool
Indicates whether the event is implicit.

DocumentStart(VersionDirective?, TagDirectiveCollection?, bool, Mark, Mark)

DocumentStart.cs

Initializes a new instance of the DocumentStart class.

public DocumentStart(VersionDirective? version, TagDirectiveCollection? tags, bool isImplicit, Mark start, Mark end)
Parameters
version VersionDirective?
The version.
tags TagDirectiveCollection?
The tags.
isImplicit bool
Indicates whether the event is implicit.
start Mark
The start position of the event.
end Mark
The end position of the event.

Properties

NameDescription
IsImplicitGets a value indicating whether this instance is implicit.
NestingIncreaseGets 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.
TagsGets the tags.
VersionGets the version.

IsImplicit

DocumentStart.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

DocumentStart.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

Tags

DocumentStart.cs

Gets the tags.

public TagDirectiveCollection? Tags { get; }

Property value

TagDirectiveCollection? The tags.

Version

DocumentStart.cs

Gets the version.

public VersionDirective? Version { get; }

Property value

VersionDirective? The version.

Methods

NameDescription
ToString()Returns a String that represents the current Object.

ToString()

DocumentStart.cs

Returns a String that represents the current Object.

public override string ToString()

Returns

string A String that represents the current Object.