Skip to content

MKLinkReferenceDefinition

Description

Holds data about a link reference definition within a Markdown document.

Properties

Name Type Read-Only
Colon MarkdownKit.MKCharacter
EndPosition Integer
HasDestination Boolean
HasTitle Boolean
LinkDestination MarkdownKit.MKLinkDestination
LinkLabel String
LinkLabelCloser MarkdownKit.MKCharacter
LinkLabelLength Integer
LinkLabelOpener MarkdownKit.MKCharacter
LinkLabelStart Integer
LinkLabelStartChar MarkdownKit.MKCharacter
LinkTitle MarkdownKit.MKLinkTitle
Start Integer

Methods

Name Parameters Returns
Constructor start As Integer, linkLabelOpener As MarkdownKit.MKCharacter, linkLabelCloser As MarkdownKit.MKCharacter, label As String, linkLabelStartChar As MarkdownKit.MKCharacter, labelStart As Integer, labelLength As Integer, colon As MarkdownKit.MKCharacter, destination As MarkdownKit.MKLinkDestination, title As MarkdownKit.MKLinkTitle, endPos As Integer

Property Descriptions

Colon As MarkdownKit.MKCharacter

The colon character.


EndPosition As Integer

0-based index in the source that this link reference definition ends.


HasDestination As Boolean

True if this reference link has a destination.


HasTitle As Boolean

True if there is a link reference definition title. If False then LinkTitleStart and LinkTitleLength are invalid.


LinkDestination As MarkdownKit.MKLinkDestination

The link destination.


LinkLabel As String

The link label.


LinkLabelCloser As MarkdownKit.MKCharacter

The closing link label delimiter (]).


LinkLabelLength As Integer

The length of the link label (including the flanking []).


LinkLabelOpener As MarkdownKit.MKCharacter

The opening link label delimiter ([).


LinkLabelStart As Integer

0-based index in the source of the start of the link label.


LinkLabelStartChar As MarkdownKit.MKCharacter

The first character of the link label.


LinkTitle As MarkdownKit.MKLinkTitle

The link title. May be empty.


Start As Integer

0-based index in the source that this link reference definition starts.


Method Descriptions

Constructor(start As Integer, linkLabelOpener As MarkdownKit.MKCharacter, linkLabelCloser As MarkdownKit.MKCharacter, label As String, linkLabelStartChar As MarkdownKit.MKCharacter, labelStart As Integer, labelLength As Integer, colon As MarkdownKit.MKCharacter, destination As MarkdownKit.MKLinkDestination, title As MarkdownKit.MKLinkTitle, endPos As Integer)

Default constructor.

  • start is the 0-based index in the source that this link reference definition starts.
  • linkLabelOpener is the opening link label delimiter ([).
  • linkLabelCloser is the closing link label delimiter (]).
  • label is the link label.
  • linkLabelStartChar is the first character of the link label.