ClassPdfFileSource
Provides on-demand access to pages and form fields from a PDF without loading the entire document into memory.
Definition
Namespace:Telerik.Windows.Documents.Fixed.FormatProviders.Pdf.Streaming
Assembly:Telerik.Windows.Documents.Fixed.dll
Syntax:
public sealed class PdfFileSource : IDisposableInheritance: objectPdfFileSource
Implements:
Constructors
PdfFileSource(Stream)
Creates a streaming PDF source over the specified pdfFileStream, enabling on-demand page access.
Declaration
public PdfFileSource(Stream pdfFileStream)Parameters
pdfFileStream
The pdf file stream.
PdfFileSource(Stream, PdfImportSettings, bool)
Creates a streaming PDF source with the specified import importSettings and stream lifetime behavior.
Declaration
public PdfFileSource(Stream pdfFileStream, PdfImportSettings importSettings, bool leaveStreamOpen)Parameters
pdfFileStream
The PDF file Stream instance.
importSettings
The PdfImportSettings instance specifying settings for PDF file import.
leaveStreamOpen
Boolean value indicating whether or not to close the stream when PdfFileSource instance is disposed. The default value is false.
PdfFileSource(Stream, bool)
Creates a streaming PDF source and optionally leaves the provided stream open when this instance is disposed.
Declaration
public PdfFileSource(Stream pdfFileStream, bool leaveStreamOpen)Parameters
pdfFileStream
The pdf file stream.
leaveStreamOpen
Boolean value indicating whether or not to close the stream when PdfFileSource instance is disposed. The default value is false.
Properties
Pages
Gets the pages available in the source; pages are discovered lazily and can be read on demand.
Declaration
public PdfPageSource[] Pages { get; }Property Value
The pages.
Methods
Dispose()
Disposes the source and releases resources; closes the underlying stream unless leaveStreamOpen was specified.
Declaration
public void Dispose()Implements
~PdfFileSource()
Finalizes an instance of the PdfFileSource class. Throws an exception if the instance was not disposed and a debugger is attached, ensuring that resource leaks are caught during development.
Declaration
protected ~PdfFileSource()Exceptions
Thrown when the PdfFileSource instance is garbage collected without being disposed and a debugger is attached. This indicates a resource leak that should be fixed by wrapping the instance in a 'using' statement.