PdfSharp.Pdf.IO Namespace Reference

Classes
class	Chars
	Character table by name.
class	Lexer
	Lexical analyzer for PDF files. Technically a PDF file is a stream of bytes. Some chunks of bytes represent strings in several encodings. The actual encoding depends on the context where the string is used. Therefore the bytes are 'raw encoded' into characters, i.e. a character or token read by the lexer has always character values in the range from 0 to 255.
class	Parser
	Provides the functions to parse PDF documents.
class	StreamHelper
class	PdfPasswordProviderArgs
	Encapsulates the arguments of the PdfPasswordProvider delegate. More...
class	PdfReader
	Represents the functionality for reading PDF documents.
class	PdfReaderException
	Exception thrown by PdfReader. More...
class	PdfWriter
	Represents a writer for generation of PDF streams.
class	ShiftStack
	Represents the stack for the shift-reduce parser. It seems that it is only needed for reduction of indirect references.

Enumerations
enum class	PasswordValidity { Invalid , UserPassword , OwnerPassword }
	Determines the type of the password. More...
enum class	PdfDocumentOpenMode { Modify , Import , ReadOnly , InformationOnly }
	Determines how a PDF document is opened. More...
enum class	PdfWriterLayout { Compact , Standard , Indented , Verbose }
	Determines how the PDF output stream is formatted. Even all formats create valid PDF files, only Compact or Standard should be used for production purposes. More...
enum class	PdfWriterOptions { Regular = 0x000000 , OmitStream = 0x000001 , OmitInflation = 0x000002 }
	INTERNAL USE ONLY. More...

Functions
delegate void	PdfPasswordProvider (PdfPasswordProviderArgs args)
	A delegated used by the PdfReader.Open function to retrieve a password if the document is protected. More...

Enumeration Type Documentation

PasswordValidity

enum PdfSharp.Pdf.IO.PasswordValidity

strong

Determines the type of the password.

Enumerator
Invalid	Password is neither user nor owner password.
UserPassword	Password is user password.
OwnerPassword	Password is owner password.

PdfDocumentOpenMode

enum PdfSharp.Pdf.IO.PdfDocumentOpenMode

strong

Determines how a PDF document is opened.

Enumerator
Modify	The PDF stream is completely read into memory and can be modified. Pages can be deleted or inserted, but it is not possible to extract pages. This mode is useful for modifying an existing PDF document.
Import	The PDF stream is opened for importing pages from it. A document opened in this mode cannot be modified.
ReadOnly	The PDF stream is completely read into memory, but cannot be modified. This mode preserves the original internal structure of the document and is useful for analyzing existing PDF files.
InformationOnly	The PDF stream is partially read for information purposes only. The only valid operation is to call the Info property at the imported document. This option is very fast and needs less memory and is e.g. useful for browsing information about a collection of PDF documents in a user interface.

PdfWriterLayout

enum PdfSharp.Pdf.IO.PdfWriterLayout

strong

Determines how the PDF output stream is formatted. Even all formats create valid PDF files, only Compact or Standard should be used for production purposes.

Enumerator
Compact	The PDF stream contains no unnecessary characters. This is default in release build.
Standard	The PDF stream contains some superfluous line feeds, but is more readable.
Indented	The PDF stream is indented to reflect the nesting levels of the objects. This is useful for analyzing PDF files, but increases the size of the file significantly.
Verbose	The PDF stream is indented to reflect the nesting levels of the objects and contains additional information about the PDFsharp objects. Furthermore content streams are not deflated. This is useful for debugging purposes only and increases the size of the file significantly.

PdfWriterOptions

enum PdfSharp.Pdf.IO.PdfWriterOptions

strong

INTERNAL USE ONLY.

Enumerator
Regular	If only this flag is specified the result is a regular valid PDF stream.
OmitStream	Omit writing stream data. For debugging purposes only. With this option the result is not valid PDF.
OmitInflation	Omit inflate filter. For debugging purposes only.

Function Documentation

PdfPasswordProvider()

delegate void PdfSharp.Pdf.IO.PdfPasswordProvider

(

PdfPasswordProviderArgs

args

)

A delegated used by the PdfReader.Open function to retrieve a password if the document is protected.