Skip to main content

FootnoteReferenceSnapshotNode Class

Definition​

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

Snapshot node for a Avalonia.Controls.Documents.RichFootnoteReference anchor or a Avalonia.Controls.Documents.RichFootnoteCitation, which carry the same data and differ by Avalonia.Controls.Documents.Serialization.Snapshot.SnapshotNode.Kind: the anchor owns the note, a citation only points at it. The node's text range is one object replacement character; Avalonia.Controls.Documents.Serialization.Snapshot.FootnoteReferenceSnapshotNode.NoteId pairs it with its Avalonia.Controls.Documents.Serialization.Snapshot.FootnoteSnapshot body, whose position among the snapshot's Avalonia.Controls.Documents.Serialization.Snapshot.DocumentSnapshot.Footnotes is the number both show.

public class FootnoteReferenceSnapshotNode

Inheritance: object -> SnapshotNode -> FootnoteReferenceSnapshotNode

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.
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.
NoteIdThe identity pairing the anchor with its note body.
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.

NoteId Property​

The identity pairing the anchor with its note body.

public int NoteId { get; set; }