Interface IDocumentFormatProvider

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

Namespace: Telerik.Windows.Documents.FormatProviders
Assembly: Telerik.Windows.Controls.RichTextBox.dll

Syntax

public interface IDocumentFormatProvider

Properties

CanExport

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

Declaration
bool CanExport { get; }
Property Value
System.Boolean

CanImport

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

Declaration
bool CanImport { get; }
Property Value
System.Boolean

FilesDescription

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

Declaration
string FilesDescription { get; }
Property Value
System.String

Name

Gets the name of the document format provider.

Declaration
string Name { get; }
Property Value
System.String

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

SupportedExtensions

Gets the supported file extensions for the document format provider.

Declaration
IEnumerable<string> SupportedExtensions { get; }
Property Value
System.Collections.Generic.IEnumerable<System.String>

Methods

Export(RadDocument)

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

Declaration
byte[] Export(RadDocument document)
Parameters
RadDocument document

The RadDocument to be exported.
Returns
System.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
void Export(RadDocument document, Stream output)
Parameters
RadDocument document

The RadDocument to be exported.
System.IO.Stream output

The stream to which the document will be exported.

Import(Byte[])

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

Declaration
RadDocument Import(byte[] input)
Parameters
System.Byte[] input

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.

Declaration
RadDocument Import(Stream input)
Parameters
System.IO.Stream input

The stream from which the document will be imported.
Returns
RadDocument

A value of type T representing the imported document.

Extension Methods