ClassPdfFormatProvider
Exports flow documents to PDF format by converting them to fixed-layout documents; import is not supported.
Definition
Namespace:Telerik.Windows.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:
Inherited Members
Constructors
PdfFormatProvider()
Initializes a new instance of the PdfFormatProvider class.
Declaration
public PdfFormatProvider()Properties
CanExport
Gets a value indicating whether this format provider can export documents, which is always true for PDF.
Declaration
public override bool CanExport { get; }Property Value
The value indicating whether can export.
Overrides
CanImport
Gets a value indicating whether this format provider can import documents, which is always false for PDF.
Declaration
public override bool CanImport { get; }Property Value
The value indicating whether can import.
Overrides
ExportSettings
Gets or sets the export settings that control numbering field precision and extensibility options during PDF generation.
Declaration
public PdfExportSettings ExportSettings { get; set; }Property Value
The export settings.
SupportedExtensions
Gets the file extensions supported by this provider, which includes .pdf only.
Declaration
public override IEnumerable<string> SupportedExtensions { get; }Property Value
The supported extensions.
Overrides
Methods
ExportOverride(RadFlowDocument, Stream, CancellationToken)
Exports the specified document.
Declaration
protected override void ExportOverride(RadFlowDocument document, Stream output, CancellationToken cancellationToken)Parameters
document
The document.
output
The output.
cancellationToken
The cancellation token used to cancel the operation.
Overrides
ExportToFixedDocument(RadFlowDocument, TimeSpan?)
Converts the flow document to a fixed-layout document with a specified timeout and returns the resulting RadFixedDocument.
Declaration
public RadFixedDocument ExportToFixedDocument(RadFlowDocument document, TimeSpan? timeout)Parameters
document
The document.
timeout
The timeout after which the operation will be cancelled.
Returns
The fixed document.
Exceptions
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.