Class PdfReader

Namespace

PdfSharp.Pdf.IO

Assembly

PdfSharp.dll

Represents the functionality for reading PDF documents.

public sealed class PdfReader

Inheritance

object

PdfReader

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Methods

Open(Stream)

Opens an existing PDF document.

public static PdfDocument Open(Stream stream)

Parameters

stream Stream

Returns

PdfDocument

Open(Stream, PdfDocumentOpenMode, PdfPasswordProvider, PdfReaderOptions?)

Opens an existing PDF document.

public static PdfDocument Open(Stream stream, PdfDocumentOpenMode openMode, PdfPasswordProvider passwordProvider, PdfReaderOptions? options = null)

Parameters

stream Stream

openMode PdfDocumentOpenMode

passwordProvider PdfPasswordProvider

options PdfReaderOptions

Returns

PdfDocument

Open(Stream, PdfDocumentOpenMode, PdfReaderOptions?)

Opens an existing PDF document.

public static PdfDocument Open(Stream stream, PdfDocumentOpenMode openMode, PdfReaderOptions? options = null)

Parameters

stream Stream

openMode PdfDocumentOpenMode

options PdfReaderOptions

Returns

PdfDocument

Open(Stream, string?, PdfDocumentOpenMode, PdfPasswordProvider?, PdfReaderOptions?)

Opens an existing PDF document.

public static PdfDocument Open(Stream stream, string? password, PdfDocumentOpenMode openMode, PdfPasswordProvider? passwordProvider, PdfReaderOptions? options = null)

Parameters

stream Stream

password string

openMode PdfDocumentOpenMode

passwordProvider PdfPasswordProvider

options PdfReaderOptions

Returns

PdfDocument

Open(Stream, string?, PdfDocumentOpenMode, PdfReaderOptions?)

Opens an existing PDF document.

public static PdfDocument Open(Stream stream, string? password, PdfDocumentOpenMode openMode, PdfReaderOptions? options = null)

Parameters

stream Stream

password string

openMode PdfDocumentOpenMode

options PdfReaderOptions

Returns

PdfDocument

Open(string, PdfDocumentOpenMode, PdfPasswordProvider, PdfReaderOptions?)

Opens an existing PDF document.

public static PdfDocument Open(string path, PdfDocumentOpenMode openMode, PdfPasswordProvider passwordProvider, PdfReaderOptions? options = null)

Parameters

path string

openMode PdfDocumentOpenMode

passwordProvider PdfPasswordProvider

options PdfReaderOptions

Returns

PdfDocument

Open(string, PdfDocumentOpenMode, PdfReaderOptions?)

Opens an existing PDF document.

public static PdfDocument Open(string path, PdfDocumentOpenMode openMode, PdfReaderOptions? options = null)

Parameters

path string

openMode PdfDocumentOpenMode

options PdfReaderOptions

Returns

PdfDocument

Open(string, PdfReaderOptions?)

Opens an existing PDF document.

public static PdfDocument Open(string path, PdfReaderOptions? options = null)

Parameters

path string

options PdfReaderOptions

Returns

PdfDocument

Open(string, string?, PdfDocumentOpenMode, PdfPasswordProvider?, PdfReaderOptions?)

Opens an existing PDF document.

public static PdfDocument Open(string path, string? password, PdfDocumentOpenMode openMode, PdfPasswordProvider? passwordProvider, PdfReaderOptions? options = null)

Parameters

path string

password string

openMode PdfDocumentOpenMode

passwordProvider PdfPasswordProvider

options PdfReaderOptions

Returns

PdfDocument

Open(string, string, PdfDocumentOpenMode, PdfReaderOptions?)

Opens an existing PDF document.

public static PdfDocument Open(string path, string password, PdfDocumentOpenMode openMode, PdfReaderOptions? options = null)

Parameters

path string

password string

openMode PdfDocumentOpenMode

options PdfReaderOptions

Returns

PdfDocument

Open(string, string, PdfReaderOptions?)

Opens an existing PDF document.

public static PdfDocument Open(string path, string password, PdfReaderOptions? options = null)

Parameters

path string

password string

options PdfReaderOptions

Returns

PdfDocument

TestPdfFile(byte[])

Determines whether the specified data is a PDF file by inspecting the first eight bytes of the data. If the data begins with «%PDF-x.y» the function returns the version number as integer (e.g. 14 for PDF 1.4). If the data is invalid or inaccessible for any reason, 0 is returned. The function never throws an exception.

public static int TestPdfFile(byte[] data)

Parameters

data byte[]

Returns

int

TestPdfFile(Stream)

Determines whether the specified stream is a PDF file by inspecting the first eight bytes of the data. If the data begins with «%PDF-x.y» the function returns the version number as integer (e.g. 14 for PDF 1.4). If the data is invalid or inaccessible for any reason, 0 is returned. The function never throws an exception. This method expects the stream position to point to the start of the file data to be checked.

public static int TestPdfFile(Stream stream)

Parameters

stream Stream

Returns

int

TestPdfFile(string)

Determines whether the file specified by its path is a PDF file by inspecting the first eight bytes of the data. If the file header has the form «%PDF-x.y» the function returns the version number as integer (e.g. 14 for PDF 1.4). If the file header is invalid or inaccessible for any reason, 0 is returned. The function never throws an exception.

public static int TestPdfFile(string path)

Parameters

path string

Returns

int