Class
DocxFormatProvider

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

Definition

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

Assembly:Telerik.WinControls.RichTextEditor.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

Gets a value indicating whether this instance can export.

Declaration

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

Property Value

bool

true if this instance can export; otherwise, false.

Overrides DocumentFormatProviderBase.CanExport

CanImport

Gets a value indicating whether this instance can import.

Declaration

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

Property Value

bool

true if this instance can import; otherwise, false.

Overrides DocumentFormatProviderBase.CanImport

ExportSettings

Gets or sets the settings used while exporting content.

Declaration

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

Property Value

DocxExportSettings

The export settings.

Implements IConfigurableDocxFormatProvider.ExportSettings

FilesDescription

Gets the description of the supported file formats.

Declaration

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

Property Value

string

The files description.

Overrides DocumentFormatProviderBase.FilesDescription

ImportSettings

Gets or sets the settings used while importing content.

Declaration

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

Property Value

DocxImportSettings

The import settings.

Implements IConfigurableDocxFormatProvider.ImportSettings

Name

Gets the name of the specific format provider.

Declaration

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

Property Value

string

The name.

Overrides DocumentFormatProviderBase.Name

SupportedExtensions

Gets the extensions supported by this format provider.

Declaration

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

Property Value

IEnumerable<string>

The supported extensions.

Overrides DocumentFormatProviderBase.SupportedExtensions

Methods

Export(RadDocument, Stream)

Exports the specified RadDocument instance.

Declaration

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

Parameters

document

RadDocument

The document.

output

Stream

The Stream the document should be saved into.

Overrides DocumentFormatProviderBase.Export(RadDocument, Stream)

Import(Stream)

Imports the specified Stream into a RadDocument instance.

Declaration

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

Parameters

input

Stream

The Stream containing the document data.

Returns

RadDocument

The generated RadDocument instance.

Overrides DocumentFormatProviderBase.Import(Stream)