BlockSnapshotNode Class

Definition

Namespace:Avalonia.Controls.Documents.Serialization.Snapshot

Assembly:Avalonia.Controls.Documents

Package:Avalonia.Controls.Documents

Base class for block-level snapshot nodes. Contains block formatting information.

public class BlockSnapshotNode

Inheritance: object -> SnapshotNode -> BlockSnapshotNode

Derived types: ListSnapshotNode, SectionSnapshotNode, TableSnapshotNode

Constructors

Name	Description
BlockSnapshotNode	Initializes a new instance of Avalonia.Controls.Documents.Serialization.Snapshot.BlockSnapshotNode with the specified parameters.

BlockSnapshotNode Constructor

Initializes a new instance of Avalonia.Controls.Documents.Serialization.Snapshot.BlockSnapshotNode with the specified parameters.

public BlockSnapshotNode(Avalonia.Controls.Documents.TextModel.TextDocumentNodeKind kind, int startOffset, int length, Avalonia.Controls.Documents.TextModel.Formatting.BlockFormatting blockFormatting, Avalonia.Controls.Documents.Serialization.Snapshot.SnapshotNodeChildren children, Avalonia.Controls.Documents.TextModel.Formatting.TextElementFormatting textElementFormatting)

Parameters

kind Avalonia.Controls.Documents.TextModel.TextDocumentNodeKind

startOffset int

length int

blockFormatting Avalonia.Controls.Documents.TextModel.Formatting.BlockFormatting

children Avalonia.Controls.Documents.Serialization.Snapshot.SnapshotNodeChildren

textElementFormatting Avalonia.Controls.Documents.TextModel.Formatting.TextElementFormatting

Methods

Name	Description
ChildrenOfKind	Enumerates child nodes matching a specific kind. Inherited from SnapshotNode.
EnumerateDescendants	Enumerates this node and all descendants in pre-order (depth-first). Inherited from SnapshotNode.
GetFormatMetadata	Inherited from SnapshotNode.
SetFormatMetadata	Inherited from SnapshotNode.

Properties

Name	Description
BlockFormatting	Block formatting captured from the element.
Children	Child nodes. Empty array for leaf nodes. Inherited from SnapshotNode.
CustomData	Extension-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.
EndOffset	Gets the absolute end offset (exclusive). Inherited from SnapshotNode.
FormatMetadata	Format-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.
IsBlock	Gets whether this is a block-level node. Inherited from SnapshotNode.
IsInline	Gets whether this is an inline-level node. Inherited from SnapshotNode.
IsLeaf	Gets whether this is a leaf node (no children). Inherited from SnapshotNode.
IsTextRun	Gets whether this node represents a text run with actual content. Inherited from SnapshotNode.
Kind	The kind of document element this node represents. Inherited from SnapshotNode.
Length	Length of this node's content in characters. Inherited from SnapshotNode.
StartOffset	Absolute offset in the document text where this node starts. Inherited from SnapshotNode.
TextElementFormatting	Base-level formatting from Avalonia.Controls.Documents.RichTextElement. Carries font, foreground, background, and letter-spacing for every node type. Inherited from SnapshotNode.

BlockFormatting Property

Block formatting captured from the element.

public Avalonia.Controls.Documents.TextModel.Formatting.BlockFormatting BlockFormatting { get; set; }