Class
MarkdownFormatProvider

Imports and exports RadFlowDocument instances from/to Markdown text (.md / .markdown), supporting CommonMark and GitHub Flavored Markdown (GFM).

Definition

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

Assembly:Telerik.Windows.Documents.Flow.dll

Syntax:

cs-api-definition
public class MarkdownFormatProvider : TextBasedFormatProviderBase<RadFlowDocument>, IFormatProvider<RadFlowDocument>, ITextBasedFormatProvider<RadFlowDocument>

Inheritance: objectFormatProviderBase<RadFlowDocument>TextBasedFormatProviderBase<RadFlowDocument>MarkdownFormatProvider

Implements: IFormatProvider<RadFlowDocument>ITextBasedFormatProvider<RadFlowDocument>

Inherited Members TextBasedFormatProviderBase<RadFlowDocument>.Import(string, TimeSpan?)TextBasedFormatProviderBase<RadFlowDocument>.Export(RadFlowDocument, TimeSpan?)FormatProviderBase<RadFlowDocument>.Import(Stream, TimeSpan?)FormatProviderBase<RadFlowDocument>.Export(RadFlowDocument, Stream, TimeSpan?)

Constructors

MarkdownFormatProvider()

Initializes a new instance with default import and export settings.

Declaration

cs-api-definition
public MarkdownFormatProvider()

Properties

CanExport

Gets a value indicating whether this provider supports export.

Declaration

cs-api-definition
public override bool CanExport { get; }

Property Value

bool

The value indicating whether can export.

Overrides FormatProviderBase<RadFlowDocument>.CanExport

CanImport

Gets a value indicating whether this provider supports import.

Declaration

cs-api-definition
public override bool CanImport { get; }

Property Value

bool

The value indicating whether can import.

Overrides FormatProviderBase<RadFlowDocument>.CanImport

ExportSettings

Gets or sets the export settings.

Declaration

cs-api-definition
public MarkdownExportSettings ExportSettings { get; set; }

Property Value

MarkdownExportSettings

Exceptions

ArgumentNullException

Thrown when set to null.

ImportSettings

Gets or sets the import settings.

Declaration

cs-api-definition
public MarkdownImportSettings ImportSettings { get; set; }

Property Value

MarkdownImportSettings

Exceptions

ArgumentNullException

Thrown when set to null.

SupportedExtensions

Gets the file extensions supported by this provider.

Declaration

cs-api-definition
public override IEnumerable<string> SupportedExtensions { get; }

Property Value

IEnumerable<string>

The supported extensions.

Overrides FormatProviderBase<RadFlowDocument>.SupportedExtensions

Methods

ExportOverride(RadFlowDocument, Stream, CancellationToken)

Exports the specified document.

Declaration

cs-api-definition
protected override void ExportOverride(RadFlowDocument document, Stream output, CancellationToken cancellationToken)

Parameters

document

RadFlowDocument

The document.

output

Stream

The output.

cancellationToken

CancellationToken

The cancellation token used to cancel the operation.

Overrides FormatProviderBase<RadFlowDocument>.ExportOverride(RadFlowDocument, Stream, CancellationToken)

ImportOverride(Stream, CancellationToken)

Imports the specified input.

Declaration

cs-api-definition
protected override RadFlowDocument ImportOverride(Stream input, CancellationToken cancellationToken)

Parameters

input

Stream

The input.

cancellationToken

CancellationToken

The cancellation token used to cancel the operation.

Returns

RadFlowDocument

The imported document.

Overrides FormatProviderBase<RadFlowDocument>.ImportOverride(Stream, CancellationToken)