Skip to main content

MarkdownSerializer Class

Definition

Assembly:Avalonia.Controls.Markdown
Package:Avalonia.Controls.Markdown

Read-only Avalonia.Controls.Documents.Serialization.IDocumentSerializer for Markdown files. Parses Markdown text into a Avalonia.Controls.Documents.Serialization.Snapshot.DocumentSnapshot via Markdig. Writing is not supported.

public class MarkdownSerializer

Inheritance: object -> MarkdownSerializer

Implements: IDocumentSerializer

Constructors

NameDescription
MarkdownSerializerNo summary available.

MarkdownSerializer Constructor

public MarkdownSerializer()

Methods

NameDescription
CanDeserializeNo summary available.
DeserializeAsyncNo summary available.
SerializeAsyncNo summary available.

CanDeserialize Method

public bool CanDeserialize(System.IO.Stream stream)

Parameters

stream System.IO.Stream

Returns

bool

DeserializeAsync Method

public System.Threading.Tasks.Task<Avalonia.Controls.Documents.Serialization.Snapshot.DocumentSnapshot> DeserializeAsync(System.IO.Stream stream, System.Threading.CancellationToken cancellationToken)

Parameters

stream System.IO.Stream

cancellationToken System.Threading.CancellationToken

Returns

System.Threading.Tasks.Task<Avalonia.Controls.Documents.Serialization.Snapshot.DocumentSnapshot>

SerializeAsync Method

public System.Threading.Tasks.Task SerializeAsync(Avalonia.Controls.Documents.Serialization.Snapshot.DocumentSnapshot snapshot, System.IO.Stream stream, System.Threading.CancellationToken cancellationToken)

Parameters

snapshot Avalonia.Controls.Documents.Serialization.Snapshot.DocumentSnapshot

stream System.IO.Stream

cancellationToken System.Threading.CancellationToken

Returns

System.Threading.Tasks.Task

Properties

NameDescription
CodeHighlighterGets or sets the optional code highlighter used during deserialization.
FileExtensionNo summary available.
FormatNameNo summary available.
MimeTypeNo summary available.

CodeHighlighter Property

Gets or sets the optional code highlighter used during deserialization.

public Avalonia.Controls.CodeHighlighter CodeHighlighter { get; set; }

FileExtension Property

public string FileExtension { get; set; }

FormatName Property

public string FormatName { get; set; }

MimeType Property

public string MimeType { get; set; }