DocumentEnd Class

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

Represents a document end event.

public class DocumentEnd : ParsingEvent

Inheritance: ParsingEvent DocumentEnd

Constructors

Name	Description
DocumentEnd(bool)	Initializes a new instance of the `DocumentEnd` class.
DocumentEnd(bool, Mark, Mark)	Initializes a new instance of the `DocumentEnd` class.

DocumentEnd overloads

DocumentEnd(bool)

DocumentEnd.cs

Initializes a new instance of the DocumentEnd class.

public DocumentEnd(bool isImplicit)

Parameters

isImplicit bool: Indicates whether the event is implicit.

DocumentEnd(bool, Mark, Mark)

DocumentEnd.cs

Initializes a new instance of the DocumentEnd class.

public DocumentEnd(bool isImplicit, Mark start, Mark end)

Parameters

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

Name	Description
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.

IsImplicit

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

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

Methods

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

ToString()

DocumentEnd.cs

Returns a String that represents the current Object.

public override string ToString()

Returns

string A String that represents the current Object.