Skip to content

MKInlineLinkData

Description

Holds data about an inline link within a Markdown document.

Properties

Name Type Read-Only
Characters() MarkdownKit.MKCharacter
CloserCharacter MarkdownKit.MKCharacter
Destination MarkdownKit.MKLinkDestination
EndPosition Integer
FullReferenceDestinationCloser MarkdownKit.MKCharacter
FullReferenceDestinationOpener MarkdownKit.MKCharacter
FullReferenceLabelLength Integer
IsInlineImage Boolean
Label MarkdownKit.MKLinkLabel
LinkType MarkdownKit.MKLinkTypes
OpenerCharacter MarkdownKit.MKCharacter
Title MarkdownKit.MKLinkTitle

Methods

Name Parameters Returns
Constructor isInlineImage As Boolean, type As MKLinkTypes

Property Descriptions

Characters() As MarkdownKit.MKCharacter

The characters representing this inline link's LinkText or, if an inline image, it's "alt" description.


CloserCharacter As MarkdownKit.MKCharacter

The link closing bracket character. Comes either after the link label or the link text (depending on the link type).


Destination As MarkdownKit.MKLinkDestination

This inline link's destination.


EndPosition As Integer

The position in the container's Characters array of the closing "]".


FullReferenceDestinationCloser As MarkdownKit.MKCharacter

If this is a full reference type inline link, this is the ] character after the reference link's name.


FullReferenceDestinationOpener As MarkdownKit.MKCharacter

If this is a full reference type inline link, this is the [ character before the reference link's name.


FullReferenceLabelLength As Integer

If this is a full reference type inline link, this is the length of the reference link label.


IsInlineImage As Boolean

True if this link data represents an inline image.


Label As MarkdownKit.MKLinkLabel

This inline link's label. May be Nil.


LinkType As MarkdownKit.MKLinkTypes

The type of link this is.


OpenerCharacter As MarkdownKit.MKCharacter

The link opener character ([ for links and ! for images). Either the start of the link label or the link text.


Title As MarkdownKit.MKLinkTitle

Optional title data. May be Nil.


Method Descriptions

Constructor(isInlineImage As Boolean, type As MKLinkTypes)

Default constructor.

  • isInlineImage is True if this is an inline image (rather than an inline link).
  • type is the type of link.