GemBox.Pdf Namespace

Contains classes, structures, and enumerations that implement the PDF Document Structure as specified in the PDF Specification ISO 32000-1:2008, section '7.7 Document Structure' and subsequent subclauses. The root object in the PDF Document Structure is an instance of a PdfDocument class.

Classes

ComHelper	Contains methods that can be useful for users which are calling GemBox.Pdf component using COM interop.
ComponentInfo	Contains diagnostic information and licensing members for GemBox.Pdf assembly.
FreeLimitEventArgs	Provides data for the FreeLimitReached event.
FreeLimitReachedException	Exception that occurs when free limit is reached.
ImageLoadOptions	Represents options used for loading a PdfImage from a file or a stream.
ImageSaveOptions	Represents a class which stores saving options for image files.
InvalidPdfArrayItemException	Represents errors that occur when a value that is being retrieved from or being set to a PdfArray instance is not according to the PDF Specification ISO 32000-1:2008.
InvalidPdfDictionaryEntryException	Represents errors that occur when a value that is being retrieved from or being set to a PdfDictionary is not according to the PDF Specification ISO 32000-1:2008.
InvalidPdfValueException	Represents errors that occur when a value that is being retrieved from or being set to a PdfDictionary or a PdfArray instance is not according to the PDF Specification ISO 32000-1:2008.
LicenseException	Exception that occurs when licensing information is not correctly specified.
PdfAssociatedFileCollection	Represents a collection of associated files that provide a means to associate content in other formats with selected objects of a PDF file and to identify the relationship between them. For associated files their associated PdfFileSpecification shall include the AssociatedRelationshipType property indicating one of several possible relationships that the file has to the associated PDF object.
PdfCollection	Represents a base non-generic class for all collection types that implement various PDF components in the GemBox.Pdf assembly.
PdfCollection<T>	Represents a base class for all collection types that implement various PDF components in the GemBox.Pdf assembly.
PdfDestination	A destination defines a particular view of a document, consisting of the following items: The page of the document that shall be displayed. The location of the document window on that page. The magnification (zoom) factor.
PdfDocument	Represents a root class in the GemBox.Pdf implementation of the PDF Document Structure as specified in the PDF Specification ISO 32000-1:2008, section '7.7 Document Structure'.
PdfDocumentIdentifier	Represents an identifier of a PdfDocument.
PdfDocumentInformation	Contains metadata for the PdfDocument.
PdfDocumentNames	Contains the correspondence between names and objects for some categories of objects in a PDF file that can be referred to by name rather than by object reference.
PdfEmbeddedFile	Represents an embedded file stream (PDF 1.3) that enables embedding the contents of referenced files directly within the body of the PDF file. This makes the PDF file a self-contained unit that can be stored or transmitted as a single entity.
PdfEmbeddedFileSpecificationTree	Represents a name tree mapping name PdfStrings to PdfFileSpecifications for PdfEmbeddedFiles (see 7.11.4, "Embedded File Streams").
PdfException	Represents a base class for all errors that occur in GemBox.Pdf assembly.
PdfFileSpecification	Represents a full file specification that might include information related to one or more specific file systems with which a PDF file can refer to the contents of another file (PDF 1.1). A file specification shall refer to a file external to the PDF file or to a file embedded within the referring PDF file, allowing its contents to be stored or transmitted along with the PDF file. The file is considered external to the PDF file in either case.
PdfLoadOptions	Represents options used for loading a PdfDocument from a PDF file.
PdfNumberRangeCollection	Represents a collection of PdfNumberRanges.
PdfObject	Represents a base class for all types that implement various PDF components in the GemBox.Pdf assembly.
PdfOptionalCollection<T>	Represents a base class for all collection types whose backing storage (usually PdfArray) is optional and created only if required.
PdfOutline	A PDF document may contain a document outline that the conforming reader may display on the screen, allowing the user to navigate interactively from one part of the document to another. The outline consists of a tree-structured hierarchy of outline items (sometimes called bookmarks), which serve as a visual table of contents to display the document’s structure to the user. PdfOutline represents a single outline item that is a node in the doubly linked list of outline items represented by PdfOutlineCollection.
PdfOutlineCollection	A PDF document may contain a document outline that the conforming reader may display on the screen, allowing the user to navigate interactively from one part of the document to another. The outline consists of a tree-structured hierarchy of outline items (sometimes called bookmarks), which serve as a visual table of contents to display the document’s structure to the user. PdfOutlineCollection represents a collection of outline items. note This collection is implemented as doubly linked list and therefore methods that use random access (index) are an O(n) operations, where n is Count.
PdfPage	Represents the leaf of the page tree, a page object, a dictionary specifying the attributes of a single page of the document.
PdfPageObject	Represents a base class for page tree nodes: intermediate nodes, called page tree nodes represented with PdfPages type, and leaf nodes, called page objects represented with PdfPage type.
PdfPageObjectCollection	Represents a collection of page tree nodes, both intermediate and leaf that are kids of the particular intermediate page tree node.
PdfPages	Represents an intermediate node in a page tree, called a page tree node. note This class provides a flattened view of all descendant PdfPages by implementing the IList<T> interface.
PdfRectangle	Represents a rectangle used to describe locations on a page and bounding boxes for a variety of objects.
PdfSaveOptions	Represents options used for saving a PdfDocument to a PDF file.
PdfTree<TKey, TValue>	Represents a base class for name trees and number trees.
PdfViewerPreferences	Represents a viewer preferences dictionary (PDF 1.2) controlling the way the document shall be presented on the screen or in print. If no such dictionary is specified, conforming readers should behave in accordance with their own current user preference settings.
PdfXmlMetadataStream	Represents an XML metadata stream.
PrintOptions	Specifies information about how a document is printed.
SaveOptions	Represents a base class for saving options of various file formats.
XpsSaveOptions	Represents options for saving to XML Paper Specification file format.

Structs

PdfCollection<T>.Enumerator	Enumerates the elements of a PdfCollection<T>.
PdfLanguage	Represents a language identifier that shall either be the empty text string, to indicate that the language is unknown, or a Language-Tag as defined in RFC 3066, Tags for the Identification of Languages.
PdfNumberRange	Represents a range of numbers.
PdfOutlineCollection.Enumerator	Enumerates the elements of a PdfOutlineCollection.
PdfPadding	Represents padding or margin information.
PdfPages.Enumerator	Enumerates the PdfPages underneath a PdfPages.
PdfTree<TKey, TValue>.Enumerator	Enumerates the elements of a PdfTree<TKey, TValue>.
PdfXmlMetadataStream.PropertyEnumerator	Enumerates the properties of a PdfXmlMetadataStream.

Enums

FreeLimitReachedAction	Type of action that can be chosen when free limit is reached.
ImageSaveFormat	An enumeration of supported image file formats when saving an image.
PdfAssociatedFileRelationshipType	Represents the type of the relationship between the component of the PdfDocument that refers to the PdfFileSpecification and the associated file denoted by the PdfFileSpecification.
PdfCrossReferenceType	Represents how cross-reference information (information about byte positions of the indirect objects) and indirect objects are stored in the PDF file.
PdfDestinationViewType	Enumerates the allowed syntactic forms for specifying a destination explicitly in a PDF file.
PdfPageBoundaryType	A PDF page may be prepared either for a finished medium, such as a sheet of paper, or as part of a prepress process in which the content of the page is placed on an intermediate medium, such as film or an imposed reproduction plate. In the latter case, it is important to distinguish between the intermediate page and the finished page. The intermediate page may often include additional production-related content, such as bleeds or printer marks, that falls outside the boundaries of the finished page. To handle such cases, a PDF page may define as many as five separate boundaries to control various aspects of the imaging process:
PdfPageLayout	Represents a page layout that shall be used when the document is opened.
PdfPageMode	Represents how the document should be displayed by a viewer when opened.
PdfTextAlignment	Specifies whether the text is left-aligned, right-aligned, centered, or justified.
PdfVersion	Represents the version of the PDF specification to which the PdfDocument conforms.
PixelFormat	An enumeration of supported pixel formats when saving a PdfDocument to an image using an ImageSaveOptions.
TiffCompression	An enumeration of supported compression schemes for Tagged Image File Format (TIFF) when saving a PdfDocument to an image using an ImageSaveOptions.