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

Provides on-demand access to pages and form fields from a PDF without loading the entire document into memory.

Definition

Namespace:Telerik.Documents.Fixed.FormatProviders.Pdf.Streaming

Assembly:Telerik.Windows.Documents.Fixed.dll

Syntax:

C#
public sealed class PdfFileSource : IDisposable

Inheritance: objectPdfFileSource

Implements: IDisposable

Constructors

Creates a streaming PDF source and optionally leaves the provided stream open when this instance is disposed.

C#
public PdfFileSource(Stream pdfFileStream, bool leaveStreamOpen)
Parameters:pdfFileStreamStream

The pdf file stream.

leaveStreamOpenbool

Boolean value indicating whether or not to close the stream when PdfFileSource instance is disposed. The default value is false.

Creates a streaming PDF source with the specified import importSettings and stream lifetime behavior.

C#
public PdfFileSource(Stream pdfFileStream, PdfImportSettings importSettings, bool leaveStreamOpen)
Parameters:pdfFileStreamStream

The PDF file Stream instance.

importSettingsPdfImportSettings

The PdfImportSettings instance specifying settings for PDF file import.

leaveStreamOpenbool

Boolean value indicating whether or not to close the stream when PdfFileSource instance is disposed. The default value is false.

Creates a streaming PDF source over the specified pdfFileStream, enabling on-demand page access.

C#
public PdfFileSource(Stream pdfFileStream)
Parameters:pdfFileStreamStream

The pdf file stream.

Properties

Gets the pages available in the source; pages are discovered lazily and can be read on demand.

C#
public PdfPageSource[] Pages { get; }
Property Value:

The pages.

Methods

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.

C#
protected ~PdfFileSource()
Exceptions: InvalidOperationException

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.

Disposes the source and releases resources; closes the underlying stream unless leaveStreamOpen was specified.

C#
public void Dispose()

Implements: IDisposable.Dispose()