YamlDotNet.Core : YamlDotNet.Core.Events Namespace

DocumentStart Class

Represents a document start event.

public class DocumentStart : ParsingEvent, IDocumentStart

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

Public Constructors

Public Properties

[read-only]
IsImplicit bool . Gets a value indicating whether this instance is implicit.
[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]
Tags YamlDotNet.Core.TagDirectiveCollection . Gets the tags.
[read-only]
Version YamlDotNet.Core.Tokens.VersionDirective . Gets the version.

Public Methods

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

Member Details

DocumentStart Constructor

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

public DocumentStart ()

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

DocumentStart Constructor

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

public DocumentStart (YamlDotNet.Core.Mark start, YamlDotNet.Core.Mark end)

Parameters

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

DocumentStart Constructor

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

Parameters

version
The version.
tags
The tags.
isImplicit
Indicates whether the event is implicit.

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

DocumentStart Constructor

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

Parameters

version
The version.
tags
The tags.
isImplicit
Indicates whether the event is implicit.
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

IsImplicit Property

Gets a value indicating whether this instance is implicit.

public bool IsImplicit { get; }

Value

true if this instance is implicit; otherwise, false.

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

Tags Property

Gets the tags.

Value

The tags.

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

Version Property

Gets the version.

Value

The version.

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