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

RtfFormatProvider

Class

Imports and exports flow documents in Rich Text Format (RTF) with support for text formatting, tables, images, and document structure.

Definition

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

Assembly:Telerik.Windows.Documents.Flow.dll

Syntax:

public class RtfFormatProvider : TextBasedFormatProviderBase<RadFlowDocument>, IFormatProvider<RadFlowDocument>, ITextBasedFormatProvider<RadFlowDocument>

Inheritance: objectFormatProviderBase<RadFlowDocument>TextBasedFormatProviderBase<RadFlowDocument>RtfFormatProvider

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

RtfFormatProvider()

Initializes a new instance of the RtfFormatProvider class with default export settings.

public RtfFormatProvider()

Properties

CanExport

bool

Gets whether this provider can export to RTF; always returns true.

public override bool CanExport { get; }

Property Value:

The value indicating whether can export.

Overrides: FormatProviderBase<RadFlowDocument>.CanExport

CanImport

bool

Gets whether this provider can import RTF documents; always returns true.

public override bool CanImport { get; }

Property Value:

The value indicating whether can import.

Overrides: FormatProviderBase<RadFlowDocument>.CanImport

ExportSettings

RtfExportSettings

Gets or sets the configuration options for RTF export, such as image compatibility mode.

public RtfExportSettings ExportSettings { get; set; }

Property Value:

The export settings.

SupportedExtensions

IEnumerable<string>

Gets the file extensions supported by this provider; returns ".rtf".

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)