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

PdfFormatProvider

Class

Exports flow documents to PDF format by converting them to fixed-layout documents; import is not supported.

Definition

Namespace:Telerik.Documents.Flow.FormatProviders.Pdf

Assembly:Telerik.Windows.Documents.Flow.FormatProviders.Pdf.dll

Syntax:

public class PdfFormatProvider : BinaryFormatProviderBase<RadFlowDocument>, IFormatProvider<RadFlowDocument>, IBinaryFormatProvider<RadFlowDocument>

Inheritance: objectFormatProviderBase<RadFlowDocument>BinaryFormatProviderBase<RadFlowDocument>PdfFormatProvider

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?)FormatProviderBase<RadFlowDocument>.ImportOverride(Stream, CancellationToken)

Constructors

PdfFormatProvider()

Initializes a new instance of the PdfFormatProvider class.

public PdfFormatProvider()

Properties

CanExport

bool

Gets a value indicating whether this format provider can export documents, which is always true for PDF.

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 format provider can import documents, which is always false for PDF.

public override bool CanImport { get; }

Property Value:

The value indicating whether can import.

Overrides: FormatProviderBase<RadFlowDocument>.CanImport

ExportSettings

PdfExportSettings

Gets or sets the export settings that control numbering field precision and extensibility options during PDF generation.

public PdfExportSettings ExportSettings { get; set; }

Property Value:

The export settings.

SupportedExtensions

IEnumerable<string>

Gets the file extensions supported by this provider, which includes .pdf only.

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:documentRadFlowDocument

The document.

outputStream

The output.

cancellationTokenCancellationToken

The cancellation token used to cancel the operation.

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

ExportToFixedDocument(RadFlowDocument, TimeSpan?)

Converts the flow document to a fixed-layout document with a specified timeout and returns the resulting RadFixedDocument.

public RadFixedDocument ExportToFixedDocument(RadFlowDocument document, TimeSpan? timeout)

Parameters:documentRadFlowDocument

The document.

timeoutTimeSpan?

The timeout after which the operation will be cancelled.

Returns:

RadFixedDocument

The fixed document.

Exceptions: ArgumentOutOfRangeException

The exception that is thrown when timeout is less than -1 or greater than Int32.MaxValue. Note that this upper bound is more restrictive than TimeSpan.MaxValue.