Class MarkdownDocument

Represents a class to maintain Markdown document.

Inheritance

System.Object

MarkdownDocument

Namespace: Syncfusion.Office.Markdown

Assembly: Syncfusion.Markdown.dll

Syntax

public class MarkdownDocument : Object

Constructors

MarkdownDocument()

Initializes a new instance of the MarkdownDocument class.

Declaration

public MarkdownDocument()

MarkdownDocument(Stream, MdImportSettings)

Initializes new instance for MarkdownDocument class.

Declaration

public MarkdownDocument(Stream stream, MdImportSettings mdImportSettings)

Parameters

Type	Name	Description
System.IO.Stream	stream	Stream containing Markdown data.
MdImportSettings	mdImportSettings	Settings used for importing Markdown.

Properties

Blocks

Gets or sets list of blocks in Markdown

Declaration

public List<IMdBlock> Blocks { get; }

Property Value

Type
System.Collections.Generic.List<IMdBlock>

Methods

AddCodeBlock()

Adds the MdCodeBlock to the Markdown.

Declaration

public MdCodeBlock AddCodeBlock()

Returns

Type	Description
MdCodeBlock	Returns new MdCodeBlock.

AddParagraph()

Adds the MdParagraph to the Markdown.

Declaration

public MdParagraph AddParagraph()

Returns

Type	Description
MdParagraph	The reference to the newly created paragraph.

AddTable()

Adds the MdTable to the Markdown.

Declaration

public MdTable AddTable()

Returns

Type	Description
MdTable	The reference to the newly created table.

AddThematicBreak()

Adds the MdThematicBreak to the Markdown.

Declaration

public MdThematicBreak AddThematicBreak()

Returns

Type	Description
MdThematicBreak	The reference to the newly created thematicbreak.

Dispose()

Disposes the document.

Declaration

public void Dispose()

GetMarkdownText()

Gets markdown content as text.

Declaration

public string GetMarkdownText()

Returns

Type	Description
System.String	A string containing the serialized Markdown content.

Open(Stream, MdImportSettings)

Parses a Markdown document from stream using the given settings.

Declaration

public void Open(Stream stream, MdImportSettings mdImportSettings)

Parameters

Type	Name	Description
System.IO.Stream	stream	Stream containing Markdown content.
MdImportSettings	mdImportSettings	Import settings for parsing.