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

Exports workbooks to PDF format by rendering worksheets as paginated documents; import is not supported.

Definition

Constructors

Initializes a new instance of the PdfFormatProvider class.

C#
public PdfFormatProvider()

Properties

Indicates that this provider supports exporting workbooks to PDF format.

C#
public override bool CanExport { get; }
Property Value:

The value indicating whether can export.

Overrides: WorkbookFormatProviderBase.CanExport

Indicates that this provider does not support importing PDF files into workbooks.

C#
public override bool CanImport { get; }
Property Value:

The value indicating whether can import.

Overrides: WorkbookFormatProviderBase.CanImport

Configures which content to export and how to render worksheets as PDF pages.

C#
public PdfExportSettings ExportSettings { get; set; }
Property Value:

The export settings.

Describes the file type as "PDF Documents" for display in UI contexts.

C#
public override string FilesDescription { get; }
Property Value:

The files description.

Overrides: WorkbookFormatProviderBase.FilesDescription

Identifies this format provider as "PdfFormatProvider" for registration and lookup.

C#
public override string Name { get; }
Property Value:

The name of the provider.

Overrides: WorkbookFormatProviderBase.Name

Specifies that this provider handles files with .pdf extension.

C#
public override IEnumerable<string> SupportedExtensions { get; }
Property Value:

The supported extensions.

Overrides: WorkbookFormatProviderBase.SupportedExtensions

Methods

Writes the workbook content to the stream as a PDF document, respecting export settings for scope and rendering options.

C#
protected override void ExportOverride(Workbook workbook, Stream output, CancellationToken cancellationToken)
Parameters:workbookWorkbook

The workbook to export.

outputStream

The output.

cancellationTokenCancellationToken

The cancellation token used to cancel the operation.

Overrides: WorkbookFormatProviderBase.ExportOverride(Workbook, Stream, CancellationToken)

Converts the workbook to a RadFixedDocument for further processing or rendering, based on export settings.

C#
public RadFixedDocument ExportToFixedDocument(Workbook workbook, TimeSpan? timeout)
Parameters:workbookWorkbook

The workbook.

timeoutTimeSpan?

The timeout after which the operation will cancel.

Returns:

RadFixedDocument

The exported fixed document.