New to Telerik UI for WPF? Start a free 30-day trial

IDocumentFormatProvider

Interface

Represents a contract for a document format provider that can handle different types of document formats.

Definition

Namespace:Telerik.Windows.Documents.FormatProviders

Assembly:Telerik.Windows.Controls.RichTextBox.dll

Syntax:

public interface IDocumentFormatProvider

Derived Classes: DocumentFormatProviderBaseHtmlFormatProviderDocxFormatProviderPdfFormatProviderRtfFormatProviderTxtFormatProviderXamlFormatProvider...

Properties

CanExport

bool

Determines whether the document format provider can export a document to a specific format.

bool CanExport { get; }

CanImport

bool

Determines whether the document format provider can import a specified format.

bool CanImport { get; }

FilesDescription

string

Represents the description of files supported by the document format provider in the Telerik Windows Documents library.

string FilesDescription { get; }

Name

string

Gets the name of the document format provider.

string Name { get; }

Property Value:

A string that represents the name of the document format provider.

SupportedExtensions

IEnumerable<string>

Gets the supported file extensions for the document format provider.

IEnumerable<string> SupportedExtensions { get; }

Methods

Export(RadDocument, Stream)

Exports the specified RadDocument to a given stream using the document format provider.

void Export(RadDocument document, Stream output)

Parameters:documentRadDocument

The RadDocument to be exported.

outputStream

The stream to which the document will be exported.

Export(RadDocument)

Exports the specified RadDocument to a desired format using the document format provider.

byte[] Export(RadDocument document)

Parameters:documentRadDocument

The RadDocument to be exported.

Returns:

byte[]

A boolean value indicating whether the export operation was successful.

Import(byte[])

Imports a document from a byte array using the specified format provider.

RadDocument Import(byte[] input)

Parameters:inputbyte[]

A byte array containing the document data to be imported.

Returns:

RadDocument

An object of type RadDocument representing the imported document.

Import(Stream)

Imports a document from the specified stream using the document format provider.

RadDocument Import(Stream input)

Parameters:inputStream

The stream from which the document will be imported.

Returns:

RadDocument

A value of type T representing the imported document.