New to Telerik Document Processing? Start a free 30-day trial

DocxFormatProvider

Class

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:

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[], TimeSpan?)BinaryFormatProviderBase<RadFlowDocument>.Export(RadFlowDocument, TimeSpan?)FormatProviderBase<RadFlowDocument>.Import(Stream, TimeSpan?)FormatProviderBase<RadFlowDocument>.Export(RadFlowDocument, Stream, TimeSpan?)

Constructors

DocxFormatProvider()

Initializes a new instance of the DocxFormatProvider class.

public DocxFormatProvider()

Properties

CanExport

bool

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

public override bool CanExport { get; }

Property Value:

The value indicating whether can export.

Overrides: FormatProviderBase<RadFlowDocument>.CanExport

CanImport

bool

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

public override bool CanImport { get; }

Property Value:

The value indicating whether can import.

Overrides: FormatProviderBase<RadFlowDocument>.CanImport

ExportSettings

DocxExportSettings

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

public DocxExportSettings ExportSettings { get; set; }

Property Value:

The export settings.

ImportSettings

DocxImportSettings

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

public DocxImportSettings ImportSettings { get; set; }

Property Value:

The export settings.

SupportedExtensions

IEnumerable<string>

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

public override IEnumerable<string> SupportedExtensions { get; }

Property Value:

The supported extensions.

Overrides: FormatProviderBase<RadFlowDocument>.SupportedExtensions

Methods

ExportOverride(RadFlowDocument, Stream, CancellationToken)

Exports the specified document.

protected override void ExportOverride(RadFlowDocument document, Stream output, CancellationToken cancellationToken)

Parameters:documentRadFlowDocumentoutputStream

The output.

cancellationTokenCancellationToken

The cancellation token used to cancel the operation.

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

ImportOverride(Stream, CancellationToken)

Imports the specified input.

protected override RadFlowDocument ImportOverride(Stream input, CancellationToken cancellationToken)

Parameters:inputStream

The input.

cancellationTokenCancellationToken

The cancellation token used to cancel the operation.

Returns:

RadFlowDocument

The imported document.

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