Table of Contents

Namespace PdfSharp.Pdf

Namespaces

PdfSharp.Pdf.Actions
PdfSharp.Pdf.Advanced
PdfSharp.Pdf.Annotations
PdfSharp.Pdf.Attachments
PdfSharp.Pdf.Content
PdfSharp.Pdf.Filters
PdfSharp.Pdf.Forms
PdfSharp.Pdf.IO
PdfSharp.Pdf.Invoicing
PdfSharp.Pdf.Metadata
PdfSharp.Pdf.OldAcroForms
PdfSharp.Pdf.PdfA
PdfSharp.Pdf.PdfArrayExtensions
PdfSharp.Pdf.PdfDictionaryExtensions
PdfSharp.Pdf.PdfItemExtensions
PdfSharp.Pdf.Security
PdfSharp.Pdf.Signatures
PdfSharp.Pdf.Structure

Classes

ArrayOrSingleItemHelper

Provides methods to handle keys that may contain a PdfArray or a single PdfItem.

ElementsBase

Base class for both ArrayElements and DictionaryElements.

KeysBase

Base class for all dictionary Keys classes.

Name.NameComparer

Implements a comparer that compares Name objects.

NameTreeNameEntry
PdfArray

Represents a PDF array object.

PdfArray.ArrayElements

Represents the elements of a PdfArray.

PdfArrayOfDictionaries

Represents a PdfArray of PDF dictionaries. Used e.g. for the /AF entry in the PDF catalog.

PdfBoolean

Represents a direct boolean value.

PdfBooleanObject

Represents an indirect boolean value. This type is not used by PDFsharp. If it is imported from an external PDF file, the value is converted into a direct object.

PdfContainer

Common abstract base class for both PdfArray and PdfDictionary. For technical purposes only, e.g. as marker class. There is no counterpart of this class in the PDF specification.

PdfCustomValue

This class is intended for empira internal use only and may change or drop in future releases.

PdfCustomValues

This class is intended for empira internal use only and may change or drop in future releases.

PdfDate

Represents a direct date value.

PdfDictionary

Represents a PDF dictionary object.

PdfDictionary.DictionaryElements

Represents the interface to the elements of a PDF dictionary.

PdfDictionary.PdfStream

Represents the optional PDF stream of a dictionary.

PdfDictionary.PdfStream.Keys

Common keys for all streams.

PdfDocument

Represents a PDF document.

PdfDocumentInformation

Represents the PDF document information dictionary.

PdfDocumentInformation.Keys

Predefined keys of this dictionary.

PdfDocumentOptions

Holds information how to handle the document when it is saved as PDF stream.

PdfDocumentSettings

Holds PDF specific information of the document.

PdfInteger

Represents a direct 32-bit signed integer value.

PdfIntegerObject

Represents an indirect 32-bit signed integer value. This type is not created by PDFsharp. If it is imported from an external PDF file, the value is converted into a direct object.

PdfItem

The base class of all PDF objects and primitive PDF types.

PdfLiteral

Represents text that is written ‘as it is’ into the PDF stream. Using this class can lead to invalid PDF files. E.g. strings in a literal are not encrypted when the document is saved with a password.

PdfLongInteger

Represents a direct 64-bit signed integer value.

PdfLongIntegerObject

Represents an indirect 64-bit signed integer value. This type is not created by PDFsharp. If it is imported from an external PDF file, the value is converted into a direct object.

PdfMetadata

Represents an XML Metadata stream.

PdfMetadata.Keys

Predefined keys of this dictionary.

PdfName

Represents a direct PDF name object.

PdfName.PdfNameComparer

Implements a comparer that compares PdfName objects.

PdfNameObject

Represents an indirect name value. This type is not used by PDFsharp. If it is imported from an external PDF file, the value is converted into a direct object. Acrobat sometimes uses indirect names to save space, because an indirect reference to a name may be shorter than a long name.

PdfNameTreeKids
PdfNameTreeLimits
PdfNameTreeNames
PdfNameTreeNode

Represents a node in a name tree.

PdfNameTreeNode.Keys

Predefined keys of this dictionary.

PdfNull

Represents a direct reference that is not in the cross-reference table.

PdfNullObject

Represents an indirect null value. This type is not used by PDFsharp, but at least one tool from Adobe creates PDF files with a null object.

PdfNumber

Base class for direct number values.

PdfNumberObject

Base class for indirect number values.

PdfNumberTreeKids
PdfNumberTreeLimits
PdfNumberTreeNames
PdfNumberTreeNode

Represents a number tree node.

PdfNumberTreeNode.Keys

Predefined keys of this dictionary.

PdfObject

Base class of all PDF objects that can be used indirectly.

PdfOutline

Represents an outline item in the outlines tree. An 'outline' is also known as a 'bookmark'.

PdfOutline.Keys

Predefined keys of this dictionary.

PdfOutlineCollection

Represents a collection of outlines.

PdfPage

Represents a page in a PDF document.

PdfPage.InheritablePageKeys

Predefined keys common to PdfPage and PdfPages.

PdfPage.Keys

Predefined keys of this dictionary.

PdfPageImportOptions

Options for AppendPages(PdfDocument, int, int, PdfPageImportOptions) and ExtractPages(int, int, PdfPageImportOptions).

PdfPageImportResult

What AppendPages(PdfDocument, int, int, PdfPageImportOptions) added.

PdfPageTreeBase

Base class of all page tree entries. Allows PdfPageTreeNode as well as PdfPage objects to be elements in a PdfTreeNodes array.

PdfPageTreeNode

Represents an entry in the documents page tree that is not a leaf.

PdfPageTreeNode.Keys

Predefined keys of this dictionary.

PdfPageTreeNodes

Represents the children of a PdfPageTreeNode.

PdfPages

Represents the root of the page tree of the document.

PdfPages.Keys

Predefined keys of this dictionary.

PdfPrimitive

Base class for all types that cannot be indirect PDF objects. All primitive types are immutable and can be used multiple times. Therefore, e.g. for strings exists PdfString and PdfStringObject.

PdfPrimitiveObject

Common base class for PDF objects that are neither PdfArray nor PdfDictionary. ‘Primitive objects’ are PdfStringObject or PdfNumberObject, which is base class of PdfIntegerObject, PdfLongIntegerObject, and PdfRealObject. A none-compound object must not be used as a direct object. For technical use only, e.g. as marker class. There is no counterpart of this class in the PDF specification.

PdfReal

Represents a direct real value.

PdfRealObject

Represents an indirect real value. This type is not used by PDFsharp. If it is imported from an external PDF file, the value is converted into a direct object.

PdfRectangle

Represents an immutable PDF rectangle object. In a PDF file it is represented by an array of four real values.

PdfString

Represents a direct text string value.

PdfStringObject

Represents an indirect text string value. This type is not created by PDFsharp. If it is imported from an external PDF file, the value is converted into a direct object.

PdfViewerPreferences

Represents the PDF document viewer preferences dictionary.

PdfViewerPreferences.Keys

Predefined keys of this dictionary.

TrimMargins

Represents trim margins added to the page.

Structs

Name

Implements a PDF name as a value type.

PdfObjectID

Represents a PDF object identifier, a pair of object and generation number.

Enums

PdfColorMode

Specifies what color model is used in a PDF document.

PdfCustomValueCompressionMode

This class is undocumented and may change or drop in future releases.

PdfFlateEncodeMode

Sets the mode for the Deflater (FlateEncoder).

PdfFontColoredGlyphs

Specifies whether the glyphs of an XFont are rendered multicolored into PDF. Useful for emoji fonts that have a COLR and a CPAL table.

PdfFontEmbedding

Specifies the embedding options of an XFont when converted into PDF. Font embedding is not optional anymore. So TryComputeSubset and EmbedCompleteFontFile are the only options.

PdfFontEncoding

Specifies the encoding schema used for an XFont when converting into PDF.

PdfOutlineStyle

Specifies the font style for the outline (bookmark) text.

PdfPageDestinationType

Specifies the type of a page destination in outline items, annotations, or actions.

PdfPageLayout

Specifies the page layout to be used by a viewer when the document is opened.

PdfPageMode

Specifies how the document should be displayed by a viewer when opened.

PdfReadingDirection

Specifies how the document should be displayed by a viewer when opened.

PdfStringEncoding

Determines the encoding of a PdfString or PdfStringObject.

PdfTextStringEncoding

Specifies how text strings are encoded. A text string is any text used outside of a page content stream, e.g. document information, outline text, annotation text etc.

PdfUseFlateDecoderForJpegImages

Specifies whether to compress JPEG images with the FlateDecode filter.

PdfVersion

Identifies the PDF version of a document. NOT YET USED.

VCF

Value creation flags. Specifies whether and how a value that does not exist is created.