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

DocxFormatProvider

Class

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:

public class DocxFormatProvider : DocumentFormatProviderBase, IDocumentFormatProvider, IConfigurableDocxFormatProvider

Inheritance: objectDocumentFormatProviderBaseDocxFormatProvider

Implements: IConfigurableDocxFormatProviderIDocumentFormatProvider

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

Constructors

DocxFormatProvider()

public DocxFormatProvider()

Properties

CanExport

bool

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

public override bool CanExport { get; }

Overrides: DocumentFormatProviderBase.CanExport

CanImport

bool

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

public override bool CanImport { get; }

Overrides: DocumentFormatProviderBase.CanImport

ExportSettings

DocxExportSettings

Gets or sets the export settings for the DocxFormatProvider.

public DocxExportSettings ExportSettings { get; set; }

Property Value:

An object representing the settings used during the export process.

Implements: IConfigurableDocxFormatProvider.ExportSettings

FilesDescription

string

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

public override string FilesDescription { get; }

Overrides: DocumentFormatProviderBase.FilesDescription

ImportSettings

DocxImportSettings

Gets or sets the import settings for the DocxFormatProvider.

public DocxImportSettings ImportSettings { get; set; }

Property Value:

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

Implements: IConfigurableDocxFormatProvider.ImportSettings

Name

string

Gets the name of the Docx format provider.

public override string Name { get; }

Overrides: DocumentFormatProviderBase.Name

SupportedExtensions

IEnumerable<string>

Gets the supported file extensions for the DOCX format.

public override IEnumerable<string> SupportedExtensions { get; }

Overrides: DocumentFormatProviderBase.SupportedExtensions

Methods

Export(RadDocument, Stream)

Exports the specified RadDocument to a DOCX format stream.

public override void Export(RadDocument document, Stream output)

Parameters:documentRadDocument

The RadDocument to be exported.

outputStream

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.

public override RadDocument Import(Stream input)

Parameters:inputStream

The stream from which to import the document.

Returns:

RadDocument

A document representation of the imported content.

Overrides: DocumentFormatProviderBase.Import(Stream)