Class
MarkdownExportSettings

Controls how a RadFlowDocument is exported to Markdown.

Definition

Namespace:Telerik.Windows.Documents.Flow.FormatProviders.Md

Assembly:Telerik.Windows.Documents.Flow.dll

Syntax:

cs-api-definition
public class MarkdownExportSettings

Inheritance: objectMarkdownExportSettings

Constructors

MarkdownExportSettings()

Declaration

cs-api-definition
public MarkdownExportSettings()

Properties

CodeFenceStyle

Gets or sets the code fence character. Default is Backtick.

Declaration

cs-api-definition
public CodeFenceExportStyle CodeFenceStyle { get; set; }

Property Value

CodeFenceExportStyle

Encoding

Gets or sets the encoding used when writing the Markdown stream. Defaults to UTF-8 without BOM.

Declaration

cs-api-definition
public Encoding Encoding { get; set; }

Property Value

Encoding

Exceptions

ArgumentNullException

Thrown when set to null.

HeadingStyle

Gets or sets the heading syntax style. Default is Atx.

Declaration

cs-api-definition
public HeadingExportStyle HeadingStyle { get; set; }

Property Value

HeadingExportStyle

ImageExport

Gets or sets how images are exported. Default is Inline.

Declaration

cs-api-definition
public ImageExportMode ImageExport { get; set; }

Property Value

ImageExportMode

MonospaceFontNames

Gets the set of font family names that are treated as monospace (code) fonts during export. Runs using one of these fonts are exported as inline code spans (text). The set is pre-seeded with common monospace fonts and is case-insensitive.

Declaration

cs-api-definition
public ISet<string> MonospaceFontNames { get; }

Property Value

ISet<string>

Remarks

Do not modify this set while an export is in progress.

TableExport

Gets or sets how tables are exported. Default is GfmPipe.

Declaration

cs-api-definition
public TableExportMode TableExport { get; set; }

Property Value

TableExportMode

Warnings

Gets the list of non-fatal warnings generated during the last export operation. This list is cleared and repopulated each time MarkdownFormatProvider exports a document.

Declaration

cs-api-definition
public IList<string> Warnings { get; }

Property Value

IList<string>

Remarks

Do not modify this list while an export is in progress.