Skip to main content

HyperlinkSnapshotNode Class

Definition​

Assembly:Avalonia.Controls.Documents
Package:Avalonia.Controls.Documents

Snapshot node for hyperlinks. Contains the target URI and the optional link title (markdown [text](url "title"), HTML title attribute; surfaced on the element as its string tooltip).

public class HyperlinkSnapshotNode

Inheritance: object -> SnapshotNode -> InlineSnapshotNode -> HyperlinkSnapshotNode

Methods​

NameDescription
ChildrenOfKindEnumerates child nodes matching a specific kind. Inherited from SnapshotNode.
EnumerateDescendantsEnumerates this node and all descendants in pre-order (depth-first). Inherited from SnapshotNode.
GetFormatMetadataInherited from SnapshotNode.
SetFormatMetadataInherited from SnapshotNode.

Properties​

NameDescription
ChildrenChild nodes. Empty array for leaf nodes. Inherited from SnapshotNode.
CustomDataExtension-specific custom data for custom node kinds. Used by the builder path (Avalonia.Controls.Documents.Serialization.Snapshot.DocumentSnapshotBuilder) to propagate custom data from serializer importers to snapshot nodes. Must be immutable or thread-safe for background serialization. Inherited from SnapshotNode.
EndOffsetGets the absolute end offset (exclusive). Inherited from SnapshotNode.
FormatMetadataFormat-specific metadata for round-trip fidelity. Serializers (RtfWriter, DocxWriter, etc.) can attach format-specific state here to preserve information that doesn't map cleanly to the semantic snapshot model. Not thread-safe; single-threaded access only. Inherited from SnapshotNode.
HyperlinkTitleOptional link title. null when the source declared none — distinct from an empty string title.
HyperlinkUriURI for the hyperlink target.
InlineFormattingInline-specific formatting (text decorations, baseline alignment). Inherited from InlineSnapshotNode.
IsBlockGets whether this is a block-level node. Inherited from SnapshotNode.
IsInlineGets whether this is an inline-level node. Inherited from SnapshotNode.
IsLeafGets whether this is a leaf node (no children). Inherited from SnapshotNode.
IsTextRunGets whether this node represents a text run with actual content. Inherited from SnapshotNode.
KindThe kind of document element this node represents. Inherited from SnapshotNode.
LengthLength of this node's content in characters. Inherited from SnapshotNode.
StartOffsetAbsolute offset in the document text where this node starts. Inherited from SnapshotNode.
TextElementFormattingBase-level formatting from Avalonia.Controls.Documents.RichTextElement. Carries font, foreground, background, and letter-spacing for every node type. Inherited from SnapshotNode.

HyperlinkTitle Property​

Optional link title. null when the source declared none — distinct from an empty string title.

public string HyperlinkTitle { get; set; }

HyperlinkUri Property​

URI for the hyperlink target.

public string HyperlinkUri { get; set; }