Class
DocxFormatProvider

Imports and exports DOCX (Office Open XML) documents to and from RadFlowDocument instances.

Definition

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

Assembly:Telerik.Windows.Documents.Flow.dll

Syntax:

cs-api-definition
public class DocxFormatProvider : BinaryFormatProviderBase<RadFlowDocument>, IFormatProvider<RadFlowDocument>, IBinaryFormatProvider<RadFlowDocument>

Inheritance: objectFormatProviderBase<RadFlowDocument>BinaryFormatProviderBase<RadFlowDocument>DocxFormatProvider

Implements: IBinaryFormatProvider<RadFlowDocument>IFormatProvider<RadFlowDocument>

Inherited Members BinaryFormatProviderBase<RadFlowDocument>.Import(byte[])BinaryFormatProviderBase<RadFlowDocument>.Import(byte[], TimeSpan?)BinaryFormatProviderBase<RadFlowDocument>.Export(RadFlowDocument)BinaryFormatProviderBase<RadFlowDocument>.Export(RadFlowDocument, TimeSpan?)FormatProviderBase<RadFlowDocument>.Import(Stream)FormatProviderBase<RadFlowDocument>.Import(Stream, TimeSpan?)FormatProviderBase<RadFlowDocument>.Export(RadFlowDocument, Stream)FormatProviderBase<RadFlowDocument>.Export(RadFlowDocument, Stream, TimeSpan?)

Constructors

DocxFormatProvider()

Initializes a new instance of the DocxFormatProvider class.

Declaration

cs-api-definition
public DocxFormatProvider()

Properties

CanExport

Gets a value indicating whether this provider supports exporting documents (always true for DOCX).

Declaration

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

Property Value

bool

The value indicating whether can export.

Overrides FormatProviderBase<RadFlowDocument>.CanExport

CanImport

Gets a value indicating whether this provider supports importing documents (always true for DOCX).

Declaration

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

Property Value

bool

The value indicating whether can import.

Overrides FormatProviderBase<RadFlowDocument>.CanImport

ExportSettings

Gets or sets the settings that control DOCX export behavior, including field updates and validation actions.

Declaration

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

Property Value

DocxExportSettings

The export settings.

ImportSettings

Gets or sets the settings that control DOCX import behavior, including image and shape handling.

Declaration

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

Property Value

DocxImportSettings

The export settings.

SupportedExtensions

Gets the file extensions supported by this provider (.docx).

Declaration

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

Property Value

IEnumerable<string>

The supported extensions.

Overrides FormatProviderBase<RadFlowDocument>.SupportedExtensions

Methods

ExportOverride(RadFlowDocument, Stream)

Exports the specified document.

Declaration

cs-api-definition
[Obsolete("This method is obsolete. Please use ExportOverride(RadFlowDocument document, Stream output, CancellationToken cancellationToken) instead.")]
protected override void ExportOverride(RadFlowDocument document, Stream output)

Parameters

document

RadFlowDocument

output

Stream

The output.

Overrides FormatProviderBase<RadFlowDocument>.ExportOverride(RadFlowDocument, Stream)

ExportOverride(RadFlowDocument, Stream, CancellationToken)

Exports the specified document.

Declaration

cs-api-definition
protected override void ExportOverride(RadFlowDocument document, Stream output, CancellationToken cancellationToken)

Parameters

document

RadFlowDocument

output

Stream

The output.

cancellationToken

CancellationToken

The cancellation token used to cancel the operation.

Overrides FormatProviderBase<RadFlowDocument>.ExportOverride(RadFlowDocument, Stream, CancellationToken)

ImportOverride(Stream)

Imports the specified input.

Declaration

cs-api-definition
[Obsolete("This method is obsolete. Please use ImportOverride(Stream input, CancellationToken cancellationToken) instead.")]
protected override RadFlowDocument ImportOverride(Stream input)

Parameters

input

Stream

The input.

Returns

RadFlowDocument

The imported document.

Overrides FormatProviderBase<RadFlowDocument>.ImportOverride(Stream)

ImportOverride(Stream, CancellationToken)

Imports the specified input.

Declaration

cs-api-definition
protected override RadFlowDocument ImportOverride(Stream input, CancellationToken cancellationToken)

Parameters

input

Stream

The input.

cancellationToken

CancellationToken

The cancellation token used to cancel the operation.

Returns

RadFlowDocument

The imported document.

Overrides FormatProviderBase<RadFlowDocument>.ImportOverride(Stream, CancellationToken)