ClassPdfFormatProvider
Exports workbooks to PDF format by rendering worksheets as paginated documents; import is not supported.
Definition
Namespace:Telerik.Windows.Documents.Spreadsheet.FormatProviders.Pdf
Assembly:Telerik.Windows.Documents.Spreadsheet.FormatProviders.Pdf.dll
Syntax:
public class PdfFormatProvider : BinaryWorkbookFormatProviderBase, IBinaryWorkbookFormatProvider, IWorkbookFormatProviderInheritance: objectWorkbookFormatProviderBaseBinaryWorkbookFormatProviderBasePdfFormatProvider
Implements:
Inherited Members
Constructors
PdfFormatProvider()
Initializes a new instance of the PdfFormatProvider class.
Declaration
public PdfFormatProvider()Properties
CanExport
Indicates that this provider supports exporting workbooks to PDF format.
Declaration
public override bool CanExport { get; }Property Value
The value indicating whether can export.
Overrides
CanImport
Indicates that this provider does not support importing PDF files into workbooks.
Declaration
public override bool CanImport { get; }Property Value
The value indicating whether can import.
Overrides
ExportSettings
Configures which content to export and how to render worksheets as PDF pages.
Declaration
public PdfExportSettings ExportSettings { get; set; }Property Value
The export settings.
FilesDescription
Describes the file type as "PDF Documents" for display in UI contexts.
Declaration
public override string FilesDescription { get; }Property Value
The files description.
Overrides
Name
Identifies this format provider as "PdfFormatProvider" for registration and lookup.
Declaration
public override string Name { get; }Property Value
The name of the provider.
Overrides
SupportedExtensions
Specifies that this provider handles files with .pdf extension.
Declaration
public override IEnumerable<string> SupportedExtensions { get; }Property Value
The supported extensions.
Overrides
Methods
ExportOverride(Workbook, Stream)
Exports the specified workbook.
Declaration
[Obsolete("This method is obsolete. Please use ExportOverride(Workbook workbook, Stream output, CancellationToken cancellationToken) instead.")]
protected override void ExportOverride(Workbook workbook, Stream output)Parameters
workbook
The workbook to export.
output
The output.
Overrides
ExportOverride(Workbook, Stream, CancellationToken)
Writes the workbook content to the stream as a PDF document, respecting export settings for scope and rendering options.
Declaration
protected override void ExportOverride(Workbook workbook, Stream output, CancellationToken cancellationToken)Parameters
workbook
The workbook to export.
output
The output.
cancellationToken
The cancellation token used to cancel the operation.
Overrides
ExportToFixedDocument(Workbook)
Exports to fixed document.
Declaration
[Obsolete("This method is obsolete. Please use Export(Workbook workbook, TimeSpan? timeout) instead.")]
public RadFixedDocument ExportToFixedDocument(Workbook workbook)Parameters
workbook
The workbook.
Returns
The exported fixed document.
ExportToFixedDocument(Workbook, TimeSpan?)
Converts the workbook to a RadFixedDocument for further processing or rendering, based on export settings.
Declaration
public RadFixedDocument ExportToFixedDocument(Workbook workbook, TimeSpan? timeout)Parameters
workbook
The workbook.
timeout
The timeout after which the operation will cancel.
Returns
The exported fixed document.