Class RichTextDocumentSnapshot

Namespace

RichEdit.Maui

Assembly

RichEdit.Maui.dll

Represents an immutable, enumerable view of one rich-text document version.

public sealed class RichTextDocumentSnapshot

Inheritance

object

RichTextDocumentSnapshot

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Properties

DefaultCharacterFormat

Gets the declared default character format.

public RichTextCharacterFormat DefaultCharacterFormat { get; }

Property Value

RichTextCharacterFormat

DefaultParagraphFormat

Gets the declared default paragraph format.

public RichTextParagraphFormat DefaultParagraphFormat { get; }

Property Value

RichTextParagraphFormat

Fields

Gets the ordered, non-overlapping fields.

public ImmutableArray<RichTextField> Fields { get; }

Property Value

ImmutableArray<RichTextField>

Images

Gets the ordered inline images.

public ImmutableArray<RichTextImage> Images { get; }

Property Value

ImmutableArray<RichTextImage>

Length

Gets the logical UTF-16 text length.

public int Length { get; }

Property Value

int

Links

Gets the ordered, non-overlapping hyperlinks.

public ImmutableArray<RichTextLink> Links { get; }

Property Value

ImmutableArray<RichTextLink>

ListPictures

Gets owned list-marker pictures by ordinal identifier.

public ImmutableDictionary<string, RichTextListPicture> ListPictures { get; }

Property Value

ImmutableDictionary<string, RichTextListPicture>

Lists

Gets reusable document-list definitions by document-local ID.

public ImmutableDictionary<RichTextListId, RichTextListDefinition> Lists { get; }

Property Value

ImmutableDictionary<RichTextListId, RichTextListDefinition>

Metadata

Gets application metadata by ordinal key.

public ImmutableDictionary<string, string> Metadata { get; }

Property Value

ImmutableDictionary<string, string>

Paragraphs

Gets one normalized entry for every paragraph.

public ImmutableArray<RichTextParagraph> Paragraphs { get; }

Property Value

ImmutableArray<RichTextParagraph>

Revision

Gets the owning document's opaque revision, or an invalid value for a standalone fragment.

public DocumentRevision Revision { get; }

Property Value

DocumentRevision

RtfText

Gets the canonical RTF representation of this snapshot.

public string RtfText { get; }

Property Value

string

Runs

Gets the normalized character-format runs.

public ImmutableArray<RichTextRun> Runs { get; }

Property Value

ImmutableArray<RichTextRun>

Text

Gets the complete normalized plain text.

public string Text { get; }

Property Value

string

TextBuffer

Gets the immutable, chunked plain text represented by this rich snapshot.

public TextSnapshot TextBuffer { get; }

Property Value

TextSnapshot

Version

Gets the document version captured by this snapshot.

public long Version { get; }

Property Value

long

Methods

GetText(TextSpan)

Reads a bounded UTF-16 range without materializing the whole document.

public string GetText(TextSpan range)

Parameters

range TextSpan

Returns

string