New to Telerik Document Processing? Start a free 30-day trial

MarkdownFormatProvider

Class

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:

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.

public MarkdownFormatProvider()

Properties

CanExport

bool

Gets a value indicating whether this provider supports export.

public override bool CanExport { get; }

Property Value:

The value indicating whether can export.

Overrides: FormatProviderBase<RadFlowDocument>.CanExport

CanImport

bool

Gets a value indicating whether this provider supports import.

public override bool CanImport { get; }

Property Value:

The value indicating whether can import.

Overrides: FormatProviderBase<RadFlowDocument>.CanImport

ExportSettings

MarkdownExportSettings

Gets or sets the export settings.

public MarkdownExportSettings ExportSettings { get; set; }

Exceptions:

ArgumentNullException

Thrown when set to null.

ImportSettings

MarkdownImportSettings

Gets or sets the import settings.

public MarkdownImportSettings ImportSettings { get; set; }

Exceptions:

ArgumentNullException

Thrown when set to null.

SupportedExtensions

IEnumerable<string>

Gets the file extensions supported by this provider.

public override IEnumerable<string> SupportedExtensions { get; }

Property Value:

The supported extensions.

Overrides: FormatProviderBase<RadFlowDocument>.SupportedExtensions

Methods

ExportOverride(RadFlowDocument, Stream, CancellationToken)

Exports the specified document.

protected override void ExportOverride(RadFlowDocument document, Stream output, CancellationToken cancellationToken)

Parameters:documentRadFlowDocument

The document.

outputStream

The output.

cancellationTokenCancellationToken

The cancellation token used to cancel the operation.

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

ImportOverride(Stream, CancellationToken)

Imports the specified input.

protected override RadFlowDocument ImportOverride(Stream input, CancellationToken cancellationToken)

Parameters:inputStream

The input.

cancellationTokenCancellationToken

The cancellation token used to cancel the operation.

Returns:

RadFlowDocument

The imported document.

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