Interface
IDocumentFormatProvider

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:

cs-api-definition
public interface IDocumentFormatProvider

Properties

CanExport

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

Declaration

cs-api-definition
bool CanExport { get; }

Property Value

bool

CanImport

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

Declaration

cs-api-definition
bool CanImport { get; }

Property Value

bool

FilesDescription

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

Declaration

cs-api-definition
string FilesDescription { get; }

Property Value

string

Name

Gets the name of the document format provider.

Declaration

cs-api-definition
string Name { get; }

Property Value

string

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

SupportedExtensions

Gets the supported file extensions for the document format provider.

Declaration

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

Property Value

IEnumerable<string>

Methods

Export(RadDocument)

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

Declaration

cs-api-definition
byte[] Export(RadDocument document)

Parameters

document

RadDocument

The RadDocument to be exported.

Returns

byte[]

A boolean value indicating whether the export operation was successful.

Export(RadDocument, Stream)

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

Declaration

cs-api-definition
void Export(RadDocument document, Stream output)

Parameters

document

RadDocument

The RadDocument to be exported.

output

Stream

The stream to which the document will be exported.

Import(Stream)

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

Declaration

cs-api-definition
RadDocument Import(Stream input)

Parameters

input

Stream

The stream from which the document will be imported.

Returns

RadDocument

A value of type T representing the imported document.

Import(byte[])

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

Declaration

cs-api-definition
RadDocument Import(byte[] input)

Parameters

input

byte[]

A byte array containing the document data to be imported.

Returns

RadDocument

An object of type RadDocument representing the imported document.