LinkReferenceDefinition Class

Namespace: Meziantou.Framework.Markdown.Syntax
Assembly: Meziantou.Framework.Markdown.dll
Package: Meziantou.Framework.Markdown 1.0.8
Source: LinkReferenceDefinition.cs
Available in package assets: net10.0net11.0

A link reference definition (Section 4.7 CommonMark specs)

public class LinkReferenceDefinition : LeafBlock

Nested types

Name	Description
LinkReferenceDefinition.CreateLinkInlineDelegate	Creates an inline link for the specified `LinkReferenceDefinition`.

Constructors

Name	Description
LinkReferenceDefinition()	Initializes a new instance of the `LinkReferenceDefinition` class.
LinkReferenceDefinition(string?, string?, string?)	Initializes a new instance of the `LinkReferenceDefinition` class.

LinkReferenceDefinition overloads

LinkReferenceDefinition()

LinkReferenceDefinition.cs

Initializes a new instance of the LinkReferenceDefinition class.

public LinkReferenceDefinition()

LinkReferenceDefinition(string?, string?, string?)

LinkReferenceDefinition.cs

Initializes a new instance of the LinkReferenceDefinition class.

public LinkReferenceDefinition(string? label, string? url, string? title)

Parameters

label string?: The label.
url string?: The URL.
title string?: The title.

Properties

Name	Description
CreateLinkInline	Gets or sets the create link inline callback for this instance.
Label	Gets or sets the label. Text is normalized according to spec.
LabelWithTrivia	Non-normalized Label (includes trivia) Trivia: only parsed when `MarkdownPipeline.TrackTrivia` is enabled, otherwise `StringSlice.Empty`.
Title	Gets or sets the title.
TitleEnclosingCharacter	Gets or sets the character the `LinkReferenceDefinition.Title` is enclosed in. Trivia: only parsed when `MarkdownPipeline.TrackTrivia` is enabled, otherwise \0.
TriviaBeforeTitle	gets or sets the whitespace before a `LinkReferenceDefinition.Title`. Trivia: only parsed when `MarkdownPipeline.TrackTrivia` is enabled, otherwise `StringSlice.Empty`.
TriviaBeforeUrl	Whitespace before the `LinkReferenceDefinition.Url`. Trivia: only parsed when `MarkdownPipeline.TrackTrivia` is enabled, otherwise `StringSlice.Empty`.
UnescapedTitle	Non-normalized `LinkReferenceDefinition.Title`. Trivia: only parsed when `MarkdownPipeline.TrackTrivia` is enabled, otherwise `StringSlice.Empty`.
UnescapedUrl	Non-normalized `LinkReferenceDefinition.Url`. Trivia: only parsed when `MarkdownPipeline.TrackTrivia` is enabled, otherwise `StringSlice.Empty`.
Url	Gets or sets the URL.
UrlHasPointyBrackets	True when the `LinkReferenceDefinition.Url` is enclosed in point brackets in the source document. Trivia: only parsed when `MarkdownPipeline.TrackTrivia` is enabled, otherwise false.

CreateLinkInline

LinkReferenceDefinition.cs

Gets or sets the create link inline callback for this instance.

public LinkReferenceDefinition.CreateLinkInlineDelegate? CreateLinkInline { get; set; }

Property value

LinkReferenceDefinition.CreateLinkInlineDelegate?

Remarks

This callback is called when an inline link is matching this reference definition.

Label

LinkReferenceDefinition.cs

Gets or sets the label. Text is normalized according to spec.

public string? Label { get; set; }

Property value

string?

LabelWithTrivia

LinkReferenceDefinition.cs

Non-normalized Label (includes trivia) Trivia: only parsed when MarkdownPipeline.TrackTrivia is enabled, otherwise StringSlice.Empty.

public StringSlice LabelWithTrivia { get; set; }

Property value

StringSlice

Title

LinkReferenceDefinition.cs

Gets or sets the title.

public string? Title { get; set; }

Property value

string?

TitleEnclosingCharacter

LinkReferenceDefinition.cs

Gets or sets the character the LinkReferenceDefinition.Title is enclosed in. Trivia: only parsed when MarkdownPipeline.TrackTrivia is enabled, otherwise \0.

public char TitleEnclosingCharacter { get; set; }

Property value

char

TriviaBeforeTitle

LinkReferenceDefinition.cs

gets or sets the whitespace before a LinkReferenceDefinition.Title. Trivia: only parsed when MarkdownPipeline.TrackTrivia is enabled, otherwise StringSlice.Empty.

public StringSlice TriviaBeforeTitle { get; set; }

Property value

StringSlice

TriviaBeforeUrl

LinkReferenceDefinition.cs

Whitespace before the LinkReferenceDefinition.Url. Trivia: only parsed when MarkdownPipeline.TrackTrivia is enabled, otherwise StringSlice.Empty.

public StringSlice TriviaBeforeUrl { get; set; }

Property value

StringSlice

UnescapedTitle

LinkReferenceDefinition.cs

Non-normalized LinkReferenceDefinition.Title. Trivia: only parsed when MarkdownPipeline.TrackTrivia is enabled, otherwise StringSlice.Empty.

public StringSlice UnescapedTitle { get; set; }

Property value

StringSlice

UnescapedUrl

LinkReferenceDefinition.cs

Non-normalized LinkReferenceDefinition.Url. Trivia: only parsed when MarkdownPipeline.TrackTrivia is enabled, otherwise StringSlice.Empty.

public StringSlice UnescapedUrl { get; set; }

Property value

StringSlice

Url

LinkReferenceDefinition.cs

Gets or sets the URL.

public string? Url { get; set; }

Property value

string?

UrlHasPointyBrackets

LinkReferenceDefinition.cs

True when the LinkReferenceDefinition.Url is enclosed in point brackets in the source document. Trivia: only parsed when MarkdownPipeline.TrackTrivia is enabled, otherwise false.

public bool UrlHasPointyBrackets { get; set; }

Property value

bool

Methods

Name	Description
TryParse<T>(T, LinkReferenceDefinition?)	Tries to the parse the specified text into a definition.
TryParseTrivia<T>(T, LinkReferenceDefinition?, SourceSpan, SourceSpan, SourceSpan, SourceSpan, SourceSpan, SourceSpan, SourceSpan)	Tries to the parse the specified text into a definition.

TryParse<T>(T, LinkReferenceDefinition?)

LinkReferenceDefinition.cs

Tries to the parse the specified text into a definition.

public static bool TryParse<T>(ref T text, out LinkReferenceDefinition? block) where T : ICharIterator

Type parameters

T: Type of the text

Parameters

text T: The text.
block LinkReferenceDefinition?: The block.

Returns

bool true if parsing is successful; false otherwise

TryParseTrivia<T>(T, LinkReferenceDefinition?, SourceSpan, SourceSpan, SourceSpan, SourceSpan, SourceSpan, SourceSpan, SourceSpan)

LinkReferenceDefinition.cs

Tries to the parse the specified text into a definition.

public static bool TryParseTrivia<T>(ref T text, out LinkReferenceDefinition? block, out SourceSpan triviaBeforeLabel, out SourceSpan labelWithTrivia, out SourceSpan triviaBeforeUrl, out SourceSpan unescapedUrl, out SourceSpan triviaBeforeTitle, out SourceSpan unescapedTitle, out SourceSpan triviaAfterTitle) where T : ICharIterator

Type parameters

T: Type of the text

Parameters

text T: The text.
block LinkReferenceDefinition?: The block.
triviaBeforeLabel SourceSpan
labelWithTrivia SourceSpan
triviaBeforeUrl SourceSpan
unescapedUrl SourceSpan
triviaBeforeTitle SourceSpan
unescapedTitle SourceSpan
triviaAfterTitle SourceSpan

Returns

bool true if parsing is successful; false otherwise

Fields

Name	Description
LabelSpan	The label span
TitleSpan	The title span
UrlSpan	The URL span

LabelSpan

The label span

public SourceSpan LabelSpan

TitleSpan

The title span

public SourceSpan TitleSpan

UrlSpan

The URL span

public SourceSpan UrlSpan

LinkReferenceDefinition Class

See also

Nested types

Constructors

LinkReferenceDefinition overloads

LinkReferenceDefinition()

LinkReferenceDefinition(string?, string?, string?)

Parameters

Properties

CreateLinkInline

Property value

Remarks

Label

Property value

LabelWithTrivia

Property value

Title

Property value

TitleEnclosingCharacter

Property value

TriviaBeforeTitle

Property value

TriviaBeforeUrl

Property value

UnescapedTitle

Property value

UnescapedUrl

Property value

Url

Property value

UrlHasPointyBrackets

Property value

Methods

TryParse<T>(T, LinkReferenceDefinition?)

Type parameters

Parameters

Returns

TryParseTrivia<T>(T, LinkReferenceDefinition?, SourceSpan, SourceSpan, SourceSpan, SourceSpan, SourceSpan, SourceSpan, SourceSpan)

Type parameters

Parameters

Returns

Fields

LabelSpan

TitleSpan

UrlSpan