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

PdfFormatProvider

Class

Imports and exports RadFixedDocument to and from PDF, supporting both all-at-once and on-demand reading.

Definition

Namespace:Telerik.Documents.Fixed.FormatProviders.Pdf

Assembly:Telerik.Windows.Documents.Fixed.dll

Syntax:

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

Inheritance: objectFormatProviderBase<RadFixedDocument>BinaryFormatProviderBase<RadFixedDocument>PdfFormatProvider

Implements: IBinaryFormatProvider<RadFixedDocument>IFormatProvider<RadFixedDocument>

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

Constructors

PdfFormatProvider()

Creates a provider with default import and export settings.

public PdfFormatProvider()

Properties

CanExport

bool

Gets a value indicating whether exporting to PDF is supported.

public override bool CanExport { get; }

Property Value:

The value indicating whether can export.

Overrides: FormatProviderBase<RadFixedDocument>.CanExport

CanImport

bool

Gets a value indicating whether importing from PDF is supported.

public override bool CanImport { get; }

Property Value:

The value indicating whether can import.

Overrides: FormatProviderBase<RadFixedDocument>.CanImport

ExportSettings

PdfExportSettings

Gets or sets PDF export settings used when writing documents.

public PdfExportSettings ExportSettings { get; set; }

Property Value:

The export settings.

ImportSettings

PdfImportSettings

Gets or sets PDF import settings, including reading mode and execution behavior.

public PdfImportSettings ImportSettings { get; set; }

Property Value:

The import settings.

SupportedExtensions

IEnumerable<string>

Gets the file extensions this provider can process.

public override IEnumerable<string> SupportedExtensions { get; }

Property Value:

The supported extensions.

Overrides: FormatProviderBase<RadFixedDocument>.SupportedExtensions

Methods

ExportOverride(RadFixedDocument, Stream, CancellationToken)

Exports the specified document.

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

Parameters:documentRadFixedDocument

The document to export.

outputStream

The output.

cancellationTokenCancellationToken

The cancellation token used to cancel the operation.

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

ImportOverride(Stream, CancellationToken)

Imports the specified input.

protected override RadFixedDocument ImportOverride(Stream input, CancellationToken cancellationToken)

Parameters:inputStream

The input.

cancellationTokenCancellationToken

The cancellation token used to cancel the operation.

Returns:

RadFixedDocument

The imported document.

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