Class
DocxFormatProvider

Represents a format provider that can import and export DOCX documents from/to RadDocument.

Definition

Namespace:Telerik.Windows.Documents.FormatProviders.OpenXml.Docx

Assembly:Telerik.Windows.Controls.RichTextBox.dll

Syntax:

cs-api-definition
public class DocxFormatProvider : DocumentFormatProviderBase, IDocumentFormatProvider, IConfigurableDocxFormatProvider

Inheritance: objectDocumentFormatProviderBaseDocxFormatProvider

Implements: IConfigurableDocxFormatProviderIDocumentFormatProvider

Inherited Members DocumentFormatProviderBase.Import(byte[])DocumentFormatProviderBase.Export(RadDocument)

Constructors

DocxFormatProvider()

Declaration

cs-api-definition
public DocxFormatProvider()

Properties

CanExport

Determines whether the specified document can be exported to the Open XML Docx format.

Declaration

cs-api-definition
public override bool CanExport { get; }

Property Value

bool

Overrides DocumentFormatProviderBase.CanExport

CanImport

Determines whether the specified document can be imported by the DocxFormatProvider.

Declaration

cs-api-definition
public override bool CanImport { get; }

Property Value

bool

Overrides DocumentFormatProviderBase.CanImport

ExportSettings

Gets or sets the export settings for the DocxFormatProvider.

Declaration

cs-api-definition
public DocxExportSettings ExportSettings { get; set; }

Property Value

DocxExportSettings

An object representing the settings used during the export process.

Implements IConfigurableDocxFormatProvider.ExportSettings

FilesDescription

Represents the description of the files handled by the Docx format provider in the Telerik RadRichTextBox.

Declaration

cs-api-definition
public override string FilesDescription { get; }

Property Value

string

Overrides DocumentFormatProviderBase.FilesDescription

ImportSettings

Gets or sets the import settings for the DocxFormatProvider.

Declaration

cs-api-definition
public DocxImportSettings ImportSettings { get; set; }

Property Value

DocxImportSettings

The import settings that determine how the document is processed when imported.

Implements IConfigurableDocxFormatProvider.ImportSettings

Name

Gets the name of the Docx format provider.

Declaration

cs-api-definition
public override string Name { get; }

Property Value

string

Overrides DocumentFormatProviderBase.Name

SupportedExtensions

Gets the supported file extensions for the DOCX format.

Declaration

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

Property Value

IEnumerable<string>

Overrides DocumentFormatProviderBase.SupportedExtensions

Methods

Export(RadDocument, Stream)

Exports the specified RadDocument to a DOCX format stream.

Declaration

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

Parameters

document

RadDocument

The RadDocument to be exported.

output

Stream

The stream where the exported DOCX content will be written.

Overrides DocumentFormatProviderBase.Export(RadDocument, Stream)

Import(Stream)

Imports a document from the specified stream in the OpenXml Docx format.

Declaration

cs-api-definition
public override RadDocument Import(Stream input)

Parameters

input

Stream

The stream from which to import the document.

Returns

RadDocument

A document representation of the imported content.

Overrides DocumentFormatProviderBase.Import(Stream)