Class PdfFormatProvider

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

Inheritance

System.Object

FormatProviderBase<RadFlowDocument>

BinaryFormatProviderBase<RadFlowDocument>

PdfFormatProvider

Inherited Members

BinaryFormatProviderBase<RadFlowDocument>.Import(Byte[])

BinaryFormatProviderBase<RadFlowDocument>.Import(Byte[], Nullable<TimeSpan>)

BinaryFormatProviderBase<RadFlowDocument>.Export(RadFlowDocument)

BinaryFormatProviderBase<RadFlowDocument>.Export(RadFlowDocument, Nullable<TimeSpan>)

FormatProviderBase<RadFlowDocument>.Import(Stream)

FormatProviderBase<RadFlowDocument>.Import(Stream, Nullable<TimeSpan>)

FormatProviderBase<RadFlowDocument>.Export(RadFlowDocument, Stream)

FormatProviderBase<RadFlowDocument>.Export(RadFlowDocument, Stream, Nullable<TimeSpan>)

FormatProviderBase<RadFlowDocument>.ImportOverride(Stream)

FormatProviderBase<RadFlowDocument>.ImportOverride(Stream, CancellationToken)

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

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>

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

System.Boolean The value indicating whether can export.

Overrides

Telerik.Windows.Documents.Common.FormatProviders.FormatProviderBase<Telerik.Windows.Documents.Flow.Model.RadFlowDocument>.CanExport

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

System.Boolean The value indicating whether can import.

Overrides

Telerik.Windows.Documents.Common.FormatProviders.FormatProviderBase<Telerik.Windows.Documents.Flow.Model.RadFlowDocument>.CanImport

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

PdfExportSettings 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

System.Collections.Generic.IEnumerable<System.String> The supported extensions.

Overrides

Telerik.Windows.Documents.Common.FormatProviders.FormatProviderBase<Telerik.Windows.Documents.Flow.Model.RadFlowDocument>.SupportedExtensions

Methods

ExportOverride(RadFlowDocument, Stream)

Exports the specified document.

Declaration

[Obsolete("This method is obsolete. Please use ExportOverride(RadFlowDocument document, Stream output, CancellationToken cancellationToken) instead.")]
protected override void ExportOverride(RadFlowDocument document, Stream output)

Parameters

RadFlowDocument document The document.

System.IO.Stream output The output.

Overrides

Telerik.Windows.Documents.Common.FormatProviders.FormatProviderBase<Telerik.Windows.Documents.Flow.Model.RadFlowDocument>.ExportOverride(Telerik.Windows.Documents.Flow.Model.RadFlowDocument, System.IO.Stream)

ExportOverride(RadFlowDocument, Stream, CancellationToken)

Exports the specified document.

Declaration

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

Parameters

RadFlowDocument document The document.

System.IO.Stream output The output.

System.Threading.CancellationToken cancellationToken The cancellation token used to cancel the operation.

Overrides

Telerik.Windows.Documents.Common.FormatProviders.FormatProviderBase<Telerik.Windows.Documents.Flow.Model.RadFlowDocument>.ExportOverride(Telerik.Windows.Documents.Flow.Model.RadFlowDocument, System.IO.Stream, System.Threading.CancellationToken)

ExportToFixedDocument(RadFlowDocument)

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

Declaration

[Obsolete("This method is obsolete. Please use Export(RadFlowDocument document, TimeSpan? timeout) instead.")]
public RadFixedDocument ExportToFixedDocument(RadFlowDocument document)

Parameters

RadFlowDocument document The document.

Returns

RadFixedDocument The fixed document.

ExportToFixedDocument(RadFlowDocument, Nullable<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

RadFlowDocument document The document.

System.Nullable<System.TimeSpan> timeout The timeout after which the operation will be cancelled.

Returns

RadFixedDocument The fixed document.

Exceptions

System.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.