datalogics_interface

When a user clicks a link or bookmark in a PDF, an action occurs, moving the reader to a new location. An action can involve moving the reader to a new page in the file, for example. Also, with a PDF Viewer a PDF file can have an Action that runs automatically when a user opens the file, or reaches a specific page. Applications can support Actions in custom annotation types they add. Only GoTo and URI Actions are supported; you can only use an Action with the interface to move from one part of a file to another or open an external web page.

A go-to action can be executed in a PDF document. A go-to action includes a hyperlink that, when clicked, takes the reader to a different place within the same document. The action is linked to a bookmark within the document. A remote go-to action includes a hyperlink that takes the reader to a destination in a separate document.

A launch action launches an application or opens or prints a document.

A remote go-to action is an action that includes a RemoteDestination object. The action associated with this object, when selected, opens a separate PDF file, or opens a web page in a browser window.

A text string, typically a hyperlink. A Uniform Resource Identifier (URI) is a text string that identifies a resource on the Internet, typically a hyperlink to a web page. A URI Action within a PDF file allows a reader to click on a hyperlink and open a separate web page or another PDF or other kind of file accessed through a web link.

Associates an object with its location on a page of a PDF document. An annotation associates an object such as a note, sound, or movie with a location on a page of a PDF document, or provides a way to interact with the user by means of the mouse and keyboard.

A circle annotation is an annotation surrounded by a curved and possibly elliptical border. The circle is inscribed within the annotation rectangle. Despite the circle name, the width and height of the annotation rectangle need not be equal. So the circle can actually be an ellipse.

The free text annotation allows a user to place text directly on a PDF page. An ordinary text annotation appears in a pop up window, and is attached to an icon; it represents a note added to a PDF file, and can be opened for viewing, or closed. But a free text annotation always appears open on the page. A free text annotation can be included anywhere in a PDF file by specifying the location and the CallOutLine points.

Allows the user to highlight text appearing on a PDF page. The annotated text is still readable on the PDF, but highlighted in yellow.

A type of annotation allowing a user to edit a PDF document. Ink annotations in a PDF file allow a user to work with a PDF document displayed on a screen just as if it were on paper, such as scribbling notes in the margins, or circling or underlining text. These types of annotations require a stylus or pen used on a tablet device.

The line annotation displays a single straight line on a PDF page. When opened it displays a pop-up window containing the text of an associated note, placed at specific x/y coordinates for starting and ending points of the line.

A link annotation, which features an embedded hyperlink.

A finite number of line segments in a PDF added as an annotation. A polyline is also called a polygonal chain or piecewise linear curve. It represents a finite number of line segments where the first and last vertex are not connected. In this case, the polyline is added as an annotation to a PDF file.

A polygon is a closed plane figure bounded by a finite number of line segments. In this case the polygon is created as an annotation added to a PDF file.

Associates an object with its location on a page of a PDF document. A redaction occludes some part of a document.

The square annotation allows a user to display a rectangle on a PDF page. Text associated with the Square Annotation appears in a pop-up window. The size and shape of the rectangle is defined within the Rect entry.

Annotations that appears as highlighted content when added to a PDF file. Text markup annotations appear as highlights, underlines, or strikeouts when added to a PDF document in a PDF Viewer. When the edited PDF file is opened the markups appear in a pop-up window containing the text of the associated note.

A type of text markup annotation, for underlining text. Text markup annotations added to a PDF file appear as highlights, underlines, or strikeouts. The Underline Annotation appears PDF document as underlined text when the documnent is opened in a PDF Viewer.

A color blend that varies along an axis. An axial shading specifies a color blend that varies along a linear axis between two endpoints, and indefinitely perpendicular to that axis.

A pattern is used to fill an area to be painted. A tiling pattern consists of a repeating graphical figure that is replicated across an area to be filled in, or painted. A shading pattern provides smoothly varying gradients of color, to produce a transition between colors across an area.

A shading pattern consists of a smoothly varying gradient between two colors.

The extended graphic state, to supplement original graphic state. The Graphics State is an internal data structure in a PDF file that holds the parameters that describe graphics within that file. These parameters define how individual graphics are presented on the page, including layers and transparencies. The Extended Graphic State was introduced to expand the original Graphics State data structure, providing space to define and store more data objects within a PDF.

The graphic state is an internal data structure in a PDF file. The graphics state holds the parameters that describe graphics within that file. These parameters define how individual graphics are presented on the page, including layers and transparencies.

A bookmark on a page of a PDF document. Each bookmark has a title that appears on screen, and an action that specifies what happens when a user clicks on the bookmark. The typical action for a user-created bookmark is to move to another location in the current document, although any action (see Action) can be specified.

Represents a particular view of a page in a document. A destination describes a place in the PDF document where the user will be taken in response to clicking a hyperlink. The destination defines where a bookmark or hyperlink points to. The ViewDestination contains a reference to a page, a place (rectangle) on that page, and information specifying how to adjust the view to fit the window's size and shape.

A calibrated gray color space. A CalGray color space is a special case of a single-component CIE-based color space, known as a CIE-based A color space. This type of space is the one-dimensional (and usually achromatic) analog of CIE-based ABC spaces.

A calibrated RGB color space. A CalRGB color space (Red, Green, Blue) is a CIE-based ABC color space with only one transformation stage instead of two. In this type of space, A, B, and C represent calibrated red, green, and blue color values. These three color components must be in the range 0.0 to 1.0; component values falling outside that range are adjusted to the nearest valid value without error indication.

A color specified by values appropriate for its color space. The values that are offered range from 0 to 1.0 for red, green, and blue (RGB) or cyan, magenta, yellow, and black (CYMK).

Base class for all color spaces.

Represents a color space with an arbitrary number of color components. DeviceN color spaces were designed to represent color spaces containing multiple color components that correspond to the colorants of some target device. They provide greater flexibility than is possible with standard device color spaces such as DeviceCMYK or with individual Separation color spaces. For example, it is possible to create a DeviceN color space consisting of only the cyan, magenta, and yellow color components, with the black component excluded.

Works with the ICC color space. The International Color Consortium (ICC) developed the ICC color space in 1993 to serve as a universal standard for for printing or presenting content with digital devices, and across all operating systems and platforms. The ICC color standard applies regardless the hardware or software involved, and is used to make sure that color images and text appear properly on a wide variety of platforms.

Indexed color spaces are used to reduce the amount of memory used for processing images. Indexed color spaces are used when a limited number of colors are needed. Commonly, an image with an indexed color space can be one third the size of the same image with a standard color space, because the indexed image uses a smaller palette of colors.

A Lab color space is a CIE-based ABC color space with two transformation stages. In this type of space, A, B, and C represent the L*, a*, and b* components of a CIE 1976 L*a*b* space. The range of the first (L*) component is always 0 to 100; the ranges of the second and third (a* and b*) components are defined by the Range.

Class used to define the color space in use.

Defines the use of additional named colorants in a PDF document. Colorants in a separation color space are also sometimes referred to as spot colorants. The device displaying or printing the PDF document will supply an appropriate color based on the colorant included in the separation color space.

A clipping path is used to mark an area within a page to be highlighted or removed. The clipping path clips out part of the design. A clip can also be used with text. The clipping path defines an area within a page (text or graphic) that will be highlighted or removed. For example, a clipping path could be used to remove the background in a photograph, to highlight a person or object in front, or to super-impose text over an image. Only part of the image appears through a shape created with the clipping path. The Clip class is made up of a list of path and text elements. Any element can have a clip associated with it, and clip objects can hold arbitrary levels of nested container and group objects. If a group object is inside a clip object, and the clip object also contains at least one text object and no path objects, the group object has a special meaning. All text objects contained in a group object like this are considered to be part of the same BT/ET block. This means that the union of these text objects makes up a single clipping path. The text objects do not intersect.

A container class represents a group of elements on a page in a PDF file. In the PDF file, every container has a set of Marked Content tags, starting with Begin Marked Content (BMC or BDC) and ending with End Marked Content (EMC), so each container has a BMC/EMC or BDC/EMC pair of tags. These tags can be used to define the beginning and end of metadata around objects, providing information about the text and shapes within a PDF file. Containers can be nested within other containers.

Class that represents the collection of elements on a PDF page. A content object represents a collection of elements that make up a page in a PDF file. A content object is more convenient to use than directly parsing or working with a page content stream. This is because a page can include a large collection of individual stream objects. Working with a content object, you can avoid focusing on this level of detail. The content converts individual stream items to a structured form, making it unnecessary to parse the individual syntax for each one. A content object can be associated with a large amount of unmanaged memory in APDFL and should be deleted when the object is no longer in use. The index associated with Content is 0-based, so 0 is the first element.

The base class for elements of the content of a page. An element is a building block; everything in a PDF file is an element. An element object can be associated with a large amount of unmanaged memory in APDFL and should be deleted when the object is no longer in use.

Represents a PDF form XObject. This is not to be confused with a PDF fillable form; a Form XObject is an object outside the page content stream. A form XObject is a way to group a number of PDF objects together, into a single container. A Form XObject can hold both text and images, and can be defined once within a PDF file and then reused multiple times in the same PDF, and across multiple pages.

A set of elements to be used within a PDF document. A Group represents objects in a content object, but it resides in memory. Therefore the group has no state and is not represented in any way in a PDF content stream. When used in a Clip, a group is used to associate Text objects into a single clipping object.

An operator that completes a vector shape, drawing a line from the first point to the last point. A path is a series of commands that define the boundary of a vector shape. The ClosePath command draws a line from the current location back to its starting point, effectively closing a box or parabolic shape on a page.

The curveto operator is used to draw a Bezier curve. The curved segment is appended to a path. The curveto operator calculates the curve between two endpoints, the current (beginning) point and the final (end) point, and in relation to two matching control points. The control points define the nature of the curve between the two endpoints. These values are represented by a series of x and y coordinates.

A curveto operator where the first control point matches the beginning. The current point is the beginning point in the curve. The name CurveToV is drawn from the "V" path construction operator.

A curveto operator where the second control point matches the end point. Here the new current point is the end point in the curve. The name CurveToY is drawn from the "Y" path construction operator.

A lineto operator, which draws a straight line. A lineto operator creates a line path element. It draws a straight line from the current position (MoveTo) to a new position-a new set of (x,y) coordinates: MoveTo{x:0 y:50} LineTo{x:100 y:100}

An operator that creates a path by moving to a new current position. A LineTo operator creates an addition to a path element by moving to the (x,y) coordinates specified in the MoveTo statement. The MoveTo coordinates serve as the new current position, and from here a new path element can start. For example, the MoveTo coordinates can define the starting position for a LineTo operator. The LineTo operator draws a straight line from the current position (MoveTo) to a new position, the set of (x,y) coordinates defined with the LineTo operator: MoveTo{x:0 y:50} LineTo{x:100 y:100}

A path in a PDF file defines shapes. Paths in PDF files are used to draw lines, define filled areas, and define boundaries for clipping graphics. A path is composed of straight and curved line segments.

A rectangle path operator. RectSegment represents a single path, or line, within a rectangle, with coordinates xy, xy for the beginning and end of the line.

Represents a segment, or a single line, within a path.

Allows for manipulation of PDF collections, or portfolios. The class illustrates how to process a collection's schema. It also describes sorting of a portfolio.

Provides for adding/removing/retrieving schema fields in a collection.

Allows for the creation of collection schema field objects. Parameters that are part of a schema's field may be set.

Stores data about fields that viewers use for sorting collection items. Collections are aslo known as portfolios.

Class that defines color conversion actions for an object described by certain attributes.

Holds parameters to be passed to a color convert method. This includes the actions to take in case of a match. Each object is compared against the selection criteria for each of the actions, in order, until a matching action is found.

This class contains methods used to convert sets of values from one Colorspace to another.

Result of a PDF/A or PDF/X conversion operation.

A class used to extract words from a document using a regular expression.

A phrase in the document that matched the supplied regular expression along with its associated quad bounding box(es). A phrase matching a regular expression, with location information.

A bounding box quad of a character in a PDF file that was part of a string that matched a given regular expression. Bounding box quad information for a character match, including page number.

The underlying PDF representation of a document. Use document objects to perform most of the functions related to pages in a PDF file, such as deleting pages, inserting blank pages, copying watermarks, creating bookmarks and thumbnails, and so on. Threading: single-thread use. A <code>Document</code> is bound to the <code>Library</code> active on the thread where it was constructed. Do not share <code>Document</code> instances across threads. See <code>datalogics_interface.hpp</code> for the full threading model.

A class representing a Rolled back instance of a PDF document that was previously saved Incrementally.

Settings for rendering PDF pages as images. This is used for rendering PDF pages to images, such as PNG or JPG files, to export to separate files or to send to a printer.

Represents a font's encoding data. Encoding is the process that transforms a set of Unicode characters into a series of bytes. With PDF files, Unicode values are used to represent individual character within a font set. Unicode assigns a symbolic value to represent every single character in a wide variety of fonts, scripts, and languages. For example, the Unicode value "U+0041" refers to the capital letter "A" in a Latin script. The EncodingInfo Class is used to provide basic information about an encoding. For example, EncodingInfo could be used to provide just the code name and description for a Unicode standard font or language encoding, like this: IBM860 (Portuguese, DOS) ibm861 (Icelandic, DOS) DOS-862 (Hebrew, DOS) IBM863 (French Canadian, DOS) IBM864 (Arabic, 864) iso-8859-9 (Turkish, ISO) iso-8859-13 (Estonian, ISO) (c)2007 Datalogics Inc. Datalogics is a registered trademark of Datalogics Incorporated. Other company and brand, product and service names are for identification purposes only and may be trademarks or registered trademarks of their respective holders. Data is subject to change without notice.

Represents a font. Defines the typeface, size, style (bold, italic), Unicode values, and other details. The Font class represents a font installed on the system.

An interpolation between two output values as input values vary across a domain. For an Exponential Function, the curve between the two values is determined by the exponent N.

A function is a process. A function takes input values and manipulates them to create output values.

A function represented as a stream containing code written in a small subset of the PostScript language.

A file attachment. Any file can be attached to the PDF document. The class allows to create attachment and manipulate by its content.

Refers to the location of a PDF file within a file system. The PDF file system is known more commonly as the file path name. The reference can be either absolute, as in a complete path name, or relative to the current place in a directory structure.

Represents control parameters for flattening transparencies within a PDF file. Class that represents control parameters for flattening transparencies within a PDF file. PDF files can hold objects that are stacked, and that are partially or fully transparent. This means that these objects can blend in various ways with objects behind them. With a stacked set of transparent graphics or images in a PDF file, each one contributing to the final result that appears on the page. One or more graphics images presented together in a stack is referred to as a transparency group. With a stack of transparent images, the final colors shown are the result of blending the colors of all of the overlapping objects. Flatten Transparency merges a stack of transparent objects or graphics into a single image on the PDF page. Flattening images in a PDF file is generally necessary before you can send the document to a printer. The flattening process simplifies the PDF file and may make it smaller as well.

An image resource can either be an image XObject or inline image found in a page's content stream. An Image Xobject is stored separately from the graphics content stream in a PDF, and so can be used multiple times in the document, even across pages. The image is described in the /Xobject entry in the resources dictionary on the PDF page. Image size and resoultion: For images that are imported from raster image files, the design width and height are stored in the Image object's Matrix, in the A (width) and D (depth) Matrix members, when the image is imported. These are stored in PDF units. To derive the effective resolution of an image imported from a raster image file: Horizontal resolution: divide the Image Width by the Image's Matrix A member and multiply by 72 to scale to DPI (dots per inch). Vertical resolution: divide the Image Height by the Image's Matrix D member and multiply by 72 to scale to DPI (dots per inch).

An image collection can hold multiple images, created from an image file. The full set of images in the collection can be saved to a single image file, but only as a .tif image file. For any other file type (JPG, PNG, and so on), the collection can only be saved as one image object per file.

A class representing the decompressed Image Data.

Class that defines parameters for saving an image to a graphics file. The parameters include the file type (such as PNG or JPG), compression, image quality, and gray scale.

Used to manage converting a PDF page to an image. The Page Image Parameters are a set of parameters used to control converting a PDF page to an image, such as a PNG, JPG, or BMP. The parameters include pixel height & width, color space, resolution, so on.

The ink object represents the color in the color space, CYMK or RGB.

Used to create a new instance of a library object or change properties. A Library object can be used to create a new instance of a library or change the properties of an existing library. Threading: per-thread. Each thread that touches the SDK must construct its own <code>Library</code> before creating any <code>Document</code>, <code>Page</code>, or <code>PDFObject</code>, and that <code>Library</code> must outlive every object it backs. Do not share a <code>Library</code> instance across threads. See <code>datalogics_interface.hpp</code> for the full threading model.

Defines the parameters for writing error messages to a log file. The messages include the date and time, the source of the error, and the error type: debug, info, warning, error, or fatal. This class also defines the log file name and path.

A transformation matrix in a PDF file is specified by six numbers. The matrix is usually in the form of an array containing the six elements [a b c d h v]. A translation is specified as [ 1 0 0 1 tx ty], where tx and ty are the distance to translate from the origin of the coordinate system in the horizontal and vertical dimension, respectively. A scaling is obtained by [sx 0 0 sy 0 0]. This scales the coordinates so that 1 unit in the horizontal and vertical dimension of the new coordinate system is the same size as sx and sy units, respectively, as in the previous coordinate system. A rotation is produced by [ cos T sin T -sin T cos T 0 0 ], which has the effect of rotating the coordinate system axes by an angle T (degrees) counterclockwise. This material indicates that the matrix specifying a transformation is premultiplied with the current transformation matrix, i.e., M' = Mt * M The implementation of the Scale, Rotate, and Translate convenience functions of Matrix reflect the same order of operations, so that they are consistent with the PDF Reference manual. They are also consistent with the scale, rotate, and translate operators in PostScript, from which the coordinate system model in PDF is derived.

Represents a discrete point or space in a PDF. A Point in a PDF document is in the right plane, relative to the origin being the lower left corner of the document.

Represents a quadrilateral in a program. A quadrilateral is a polygon graphic that has four sides or edges and four corners, Bottom Left, Bottom Right, Top Left, and Top Right.

A rect holds four coordinates for a rectangle. The coordinates for a rectangle include left, top, right, bottom. Width () and height () defines the rectangle's width and height. LLx and LLy defines lower left corner, and URx and URy defines the upper right corner.

The name tree is a common data structure in PDF files. A name tree is a type of dictionary that can store many more pairs of matched records than a standard object dictionary. A name tree uses keys that are character strings to map to data objects. The strings can use a standard coding format, such as Unicode, are sorted in order in the data structure, and can be associated with any type of object.

The number tree is a common data structure in PDF files. The number tree is a type of dictionary that can store many more pairs of matched records than a standard object dictionary. A number tree uses keys that are integers to map to data objects, sorted in ascending numerical order.

Represents an OCR Engine and its configuration. Create an OCREngine object once, and reuse it to convert multiple images to Form objects to avoid repeating the sometimes expensive initialization of the engine. The configuration of the engine can't be changed after it's created; if you need to do that, create another OCREngine object.

Parameters for configuring the OCR (Optical Character Recognition) engine. Parameters for configuring the OCR engine. OCRParams controls settings such as the engine to use, the resolution of the input images, the language(s) to recognize, performance tuning, page segmentation mode, candidate font names for placing text, and image preprocessing options.

Specify a language, along with any metadata about that language. A language with optional prohibition flag.

Thrown when a user-supplied progress callback returns false to cancel a long-running operation. Distinct from WebConvertError so that non-coupling catch handlers can quietly handle cancellation without also being aware of the web-conversion subsystem.

Implementation of the PDF Optimizer function. Use the PDFOptimizer object to accumulate options for the Optimization, and to Optimize documents.

A structure used to store data related to layers in a PDF. The Optional Content Configuration Structure is used to maintain a set of visibility states and other optional values related to layers, or Optional Content Groups, within a PDF file. These configuration values are stored for future use. The default configuration for a PDF document is stored in the D entry in the Optional Content Properties dictionary. An Optional Content Group, or layer, is a set of graphic images that can be made visible or invisible within a PDF file, and the Optional Content Configuration Structure is typically used to set the initial value for these images-On or Off, visible or invisible.

Defines the context for optional content in a PDF. An Optional Content Context is a status object that defines the context for optional content within a document. The context tracks the On/Off status for Optional Content Groups (layers) within a document. It contains flags that control whether to display content that is marked as optional.

A dictionary used to manage graphics images in a PDF. An Optional Content Group is a dictionary that represents a set of graphics images that users can turn on or off in a PDF document, making them visible or invisible. In a PDF Viewer, Optional Content Groups are referred to as "Layers."

Attaches content to one or more optional content groups. Form, container, and annotation objects can be associated with one or more optional content groups. By associating them with an optional content group, they become part of that 'layer', and the user can control the visibility of the content. Note that by placing other element objects in a container, they can also be associated with an optional content group. An OptionalContentMembershipDict connects content to the OptionalContentGroup; it contains a list of OptionalContentGroups, and rules for determining visibility when the OptionalContentGroups have conflicting on/off states in the active OptionalContentContext. An OptionalContentMembershipDict cannot be changed once created; you must create a new OptionalContentMembershipDict and change the objects to point to it.

Array node class for items in the OptionalContentConfig Order array. Items in the Order array can be arranged into a tree structure; subarrays within the parent array form 'branches' of the tree. Each OptionalContentOrderArray may contain OptionalContentOrderLeafs or OptionalContentOrderArrays in a specific order; this order determines how they will appear in the 'Layers' control of the viewer. By placing OptionalContentOrderArrays into a higher-level array, branches can be added to the tree. The 'Title' property is a string that will appear next to the expand/collapse branch control in a PDF Viewer 'Layers' panel.

Leaf node class for items in the OptionalContentConfig Order array. Items in the Order array can be arranged into a tree structure. Each 'leaf' on this tree would be an OptionalContentOrderLeaf that contains a reference to an OptionalContentGroup in this document.

Base class for items in the OptionalContentConfig Order array. Items in the OptionalContentConfig's Order array are either OptionalContentOrderLeaf or OptionalContentOrderArray. This is the base class for both; you cannot instantiate an OptionalContentOrderNode, only one of its child classes.

Represents a page within a PDF file. The page is the basic object used for organizing content in a PDF document. Threading: single-thread use. A <code>Page</code> is bound to its owning <code>Document</code>'s thread; do not share it across threads. See <code>datalogics_interface.hpp</code> for the full threading model. Lifetime: a <code>Page</code> must not outlive the <code>Document</code> that produced it.

Describes numbering labels for a range of pages. PageLabel describes how to construct a label string for a range of pages. It contains information on number style, any prefixes, and a starting position within the document. Note that a single PageLabel describes the label string for several pages all pages up until the first page covered by the next PageLabel, or the end of the document. Also note that if a Document has any PageLabels, there must be one that starts at page index 0. This will be automatically created if the user does not supply one.

Parameters for converting a document to PDF/A compliance. These parameters control how a Document is converted to the PDF/A standard. RemoveAllAnnotations if true, will remove all Annotations and Actions from the output IgnoreFontErrors if true, will try to rasterize the page when fonts cannot be embedded AbortIfXFAIsPresent if true, will abort conversion process if XFA form entry is detected NoValidationErrors if true, will ignore validation errors RasterizationResolution rasterization resolution; if 0, use 72 DPI ValidateImplementationLimitsOfDocument Validate PDF Implementation Limits of the Document. PDF/A is an ISO-standard version the PDF format. It is designed to be used with PDF files that need to be archived and stored for long periods. For example, the fonts in a PDF/A file are embedded in the file itself, rather than accessed through a link to a font directory on a local server.

Represents an array of data elements within a PDF document. All objects in a PDF document are built from a collection of simpler objects that represent fundamental datatypes like numbers, strings and arrays. PDFObject and its subclasses allow direct access and manipulation of these simple objects. Some subclasses represent single data elements. For example, PDFInteger represents a single integer value. Others represent a collection of PDFObjects, like PDFArray, an indexed array of data elements. A PDFArray is a heterogenous collection object that gathers other PDFObjects (including other PDFArrays) into an indexed list.

Represents a boolean data element within a PDF document. All objects in a PDF document are built from a collection of simpler objects that represent fundamental datatypes like numbers, strings and arrays. PDFObject and its subclasses allow direct access and manipulation of these simple objects. Some subclasses represent single data elements. For example, PDFBoolean represents a single boolean value. Others represent a collection of PDFObjects, such as PDFArray, an indexed array of data elements. A PDFBoolean represents a single boolean value, and may be inserted into any collection object.

Represents an associative collection of data elements within a PDF document. All objects in a PDF document are built from a collection of simpler objects that represent fundamental datatypes like numbers, strings and arrays. PDFObject and its subclasses allow direct access and manipulation of these simple objects. Some subclasses represent single data elements, such as PDFInteger, which represents a single integer value. Other subclasses represent a collection of PDFObjects, like PDFArray, an indexed array of data elements. A PDFDict is a heterogenous collection object that maps other PDFObjects (including other PDFDicts) to PDFName objects.

Represents an integer data element within a PDF document. All objects in a PDF document are built from a collection of simpler objects that represent fundamental datatypes like numbers, strings and arrays. PDFObject and its subclasses allow direct access and manipulation of these simple objects. Some subclasses represent single data elements. For example, PDFInteger represents a single integer value. Others represent a collection of PDFObjects, such as PDFArray, an indexed array of data elements. A PDFInteger represents a single integer value, and may be inserted into any collection object.

Represents a name data element within a PDF document. All objects in a PDF document are built from a collection of simpler objects that represent fundamental datatypes like numbers, strings and arrays. PDFObject and its subclasses allow direct access and manipulation of these simple objects. Some subclasses represent single data elements. For example, PDFName represents a single name value. Others represent a collection of PDFObjects, such as PDFArray, an indexed array of data elements. A PDFName represents a single indivisible name token, and may be inserted into any collection object. It may also be used as a key in a PDFDictionary.

Represents the underlying simple data element of an object in a PDF document. All objects in a PDF document are built from a collection of simpler objects that represent fundamental datatypes like numbers, strings and arrays. PDFObject and its subclasses allow direct access and manipulation of these simple objects. Some subclasses represent single data elements. For example, PDFInteger represents a single integer value. Others represent a collection of PDFObjects, such as PDFArray, an indexed array of data elements. PDFObject is the superclass of these simple objects. A PDFObject cannot be directly instantiated, but any of its subclasses may. Any PDFObject may be either direct or indirect. A direct object exists within its collection object (such as a PDFArray) and can be referenced only within that collection object. An indirect object exists outside of any collection object and can be referenced by many collection objects. Threading: single-thread use. A <code>PDFObject</code> (and every subclass: <code>PDFDict</code>, <code>PDFArray</code>, <code>PDFStream</code>, <code>PDFString</code>, <code>PDFName</code>, <code>PDFInteger</code>, <code>PDFReal</code>, <code>PDFBoolean</code>) is bound to its owning <code>Document</code>'s thread. Do not share instances across threads. See <code>datalogics_interface.hpp</code> for the full threading model.

Represents a floating point data element within a PDF document. All objects in a PDF document are built from a collection of simpler objects that represent fundamental datatypes like numbers, strings and arrays. PDFObject and its subclasses allow direct access and manipulation of these simple objects. Some subclasses represent single data elements. For example, PDFReal represents a single floating point value. Others represent a collection of PDFObjects, such as PDFArray, an indexed array of data elements. A PDFReal represents a single floating point value, and may be inserted into any collection object.

Represents a stream of data within a PDF document. All objects in a PDF document are built from a collection of simpler objects that represent fundamental datatypes like numbers, strings and arrays. PDFObject and its subclasses allow direct access and manipulation of these simple objects. Some subclasses represent single data elements (e.g. PDFInteger represents a single integer value); other subclasses represent a collection of PDFObjects (e.g. PDFArray is an indexed array of data elements). A PDFStream represents a stream of unsigned bytes, and may be inserted into any collection object. It includes a dictionary that describes how the data in the stream is encoded and other useful information about the stream. A PDFStream is always an indirect object. PDFStreams can be encoded using built-in filters. These filters include compression schemes for most popular image formats, and text encoding translators to permit safe transmission of the document over the Internet. The data in a PDFStream will be automatically encoded when it is created; the user can read either the encoded (raw) or decoded (filtered) data. PDFStreams can be used for any large collection of data that need not be read into memory all at once, including image data, multimedia data or XML markup.

Represents an array of unsigned bytes within a PDF document. A PDFString is a single data element that represents an array of unsigned bytes. It may be inserted into any collection object. PDFString may be a string of human readable text, but this is not required, and it may be stored either as characters or as hex values.

Parameters for converting a document to PDF/X compliance. These parameters control how a Document is converted to the PDF/X standard. PDF/X is a subset of the PDF ISO standard. The purpose of PDF/X is to facilitate graphics exchange, and it therefore has a series of printing related requirements. For example, in PDF/X-1a all fonts need to be embedded and all images need to be CMYK or spot colors. PDF/X-3 accepts calibrated RGB and CIELAB colors, while retaining most of the other restrictions of PDF/X-1a.

An XObject stream with the subtype PostScript. A PostScript XObject is an XObject stream with the subtype entry of PostScript. The XObject contains a fragment of code expressed in the PostScript language. PostScript External Objects are not recommended.

A structure used to set parameters for print jobs. Two structures provide settings for setting parameters for print jobs, PrintUserParams and PrintParams. PrintUserParams was created first, and then PrintParams was created as an extension of PrintUserParams, to provide more settings to account for changing technology. When the system seeks to print a document it will pass the content and the print parameters, such as the page size, paper tray, and landscape v. portrait, to the print API in APDFL. If the setting is in PrintParams it will pass the document and parameters to PrintParams and then to PrintUserParams and from there to the print API to complete the printing process. The print logic may take different code paths depending on whether or not the print content is being sent to a printer or to a file, or if the printing uses PostScript or not. When you see a print setting that appears in both PrintUserParams and PrintParams, such as "ShrinktoFit," set the appropriate value in both of these classes. Also, PrintParams offers a variety of settings related to PostScript, but the use of PrintParams is not limited to PostScript.

Used to control how the QR color is created. <strong>Note:</strong> This class intentionally uses inline storage rather than the pimpl pattern because it is a trivial 3-member value type with no internal APDFL object to wrap.

Used to control how the QR code is created.

A view of a page contained in a separate document. A RemoteDestination is not the same as a ViewDestination; the two objects are not interchangeable.

Holds parameters for making color separations. Used with PostScript.

Represents a plate for making print separations. Used with PostScript.

Implementation of the PDF SignDoc function. Use the SignDoc object to digitally sign a document

Internal wrapper for a single node in the PDF logical structure tree. Owns a non-owning reference to its CDocument. Exposes type (/S) access, the backing dict (for arbitrary attribute reads/writes), child creation, and marked-content reference insertion. Threading: single-thread use. A <code>StructElement</code> is bound to its owning <code>Document</code>'s thread; do not share it across threads. See <code>datalogics_interface.hpp</code> for the full threading model. Lifetime: a <code>StructElement</code> must not outlive the <code>Document</code> that produced it.

Internal wrapper for the root of a PDF logical structure tree. Owns a non-owning reference to its CDocument. The underlying PDF structure tree is owned by the document; this wrapper provides C++ access to catalog- level struct tree operations (add children, access the backing dict). Root of the PDF logical structure tree. Obtained exclusively via Document::create_struct_tree_root() or Document::get_struct_tree_root(). Threading: single-thread use. A <code>StructTreeRoot</code> is bound to its owning <code>Document</code>'s thread; do not share it across threads. See <code>datalogics_interface.hpp</code> for the full threading model. Lifetime: a <code>StructTreeRoot</code> must not outlive the <code>Document</code> that produced it.

Provides access to data about fonts, font sizes, and colors used in a word.

Represents a style change in a word. A StyleTransition provides information about the character index in the word where the style changes, and the new Style.

A container that represents a series of text elements and characters. A Text object is container that represents both a series of TextRun elements and a series of text characters. Operations can be performed on individual TextRuns within a Text or on individual characters within a Text by specifying the index of the individual TextRun or character. All indices start at 0.

Represents one or more contiguous characters in a text object. @structure PDEGraphicState @structure PDETextState @structure PDETextItem All the characters contained within a text run have the same style, color, font, and size.

The text state includes parameters that affect text. These parameters include character and word spacing, font, font size, and horizontal scale.

Watermark settings control the appearance of a watermark in a PDF.

Watermark settings to control the appearance of text in a text-based watermark.

Thrown by web-to-PDF conversion when the underlying plugin reports a non-cancellation failure. Carries the C-layer result code and textual detail in addition to the human-readable what() string.

Metadata about a successful web/HTML conversion. Result metadata for a completed web-to-PDF conversion: page count, conversion time, document title, and resolved source URL. Populate() reads the plugin's last-conversion record on supported platforms and is a no-op (returning false) on the stub path; the page count is then overridden by the curator bridge with the authoritative count from the opened PDF. Header has no plugin-typed surface; all conversions live in the .cpp.

Parameters controlling Document::from_web_url and Document::from_html_file. Plain value type. Safe to construct and pass by reference. Parameters that control web/HTML-to-PDF conversion. Configure the target page geometry, viewport, image handling, and behavior on this object, then pass it to a web-to-PDF conversion call. The enum-valued settings (viewport preset, page size, page orientation, image compression, and downsampling resolution) take named values rather than raw integers. Safe to construct and configure on any platform; conversion itself runs only where the WebToPDF plugin is supported.

Result of a successful web/HTML conversion. Designed for structured-binding destructuring at the call site: <code>auto[doc,info]=Document::from_web_url(url,params);</code>

A word in a PDF file. Each word contains a sequence of characters in one or more styles (see Style).

A class used to extract words from a document.

Wraps the key fields from PDWordFinderConfigRec to configure word extraction.

Class that works with XPS conversion parameters. The XML Paper Specification (XPS) is a standard document format that Microsoft created in 2006 as an alternative to the PDF format. The XPS format is intended to be a simple but secure file format, without embedded images or video clips, and easy to share and print. NOTE: This class is only available on Windows or Linux.

AcroForm Data Export types.

AcroForm Data Import types.

Flags that control how annotations are handled when adding a page to a Content object.

Represents the relationship between the component of the PDF document that refers to this attachment and the file denoted by the attachment

Bitfield flags controlling the display and behavior of annotations.

Specifies horizontal alignment (quadding) for text layout.

Line-ending shape for annotations whose appearance includes line endings (line, polyline, polygon, free-text callouts).

The blend mode used for painting objects.

The line cap style specifies the shape to be used at the ends of open subpaths (and dashes, if any) when they are stroked.

The line join style specifies the shape to be used at the corners of paths that are stroked. Join styles are significant only at points where consecutive segments of a path connect at an angle; segments that meet or intersect fortuitously receive no special treatment.

Constants that specify a standard ICC rendering intent for a device color profile. The rendering intent specifies the color translation method for colors that are outside the gamut of the color profile.

Flags describing the visual style of a bookmark's title text.

Runtime element type tag returned by Element::get_element_type().

Specifies the split orientation for a PDF collection (portfolio) view. Controls how the navigator and preview panes are arranged when displaying a PDF collection.

Specifies the type of navigator view used to display a PDF collection (portfolio).

Constants specifying the action to take when a color conversion match occurs.

Bit field constants specifying object attributes used for matching in color conversion actions.

Constants specifying color space types used for matching in color conversion actions.

Constants identifying standard ICC color profiles for use in color conversion.

Compression values for generating graphics files from PDF pages. A compression value must be provided for JPG or GIF images.

Enumeration to specify credential encoding format as either Non-PFX (PEM/DER) or PFX (PKCS#12).

Enumeration to specify credential is required to be retrieved from disk (OnDisk) or is cached in memory (InMemory).

Enumeration to specify cryptographic hash functions that generate variable- length message digests required for digital signature creation.

Enumeration to specify fields to display as part of signature appearance.

Specifies the rotation angle for a page, in degrees clockwise. Used by Page.Rotation to get or set the display and print rotation of a page.

Bit flags indicating how a page is rendered. These flags can be OR'd together to control various rendering behaviors.

Flags controlling smoothing and antialiasing when rendering a page. These flags can be OR'd together to control text, line art, and image smoothing behavior during page rendering.

Flags that control how an Element is cloned.

Flags for creating fonts.

Font descriptor flags.

Encryption types for securing a PDF document.

Enumeration for setting the compression scheme for the Flattened Color images.

Enumeration for setting the compression scheme for the Flattened Grayscale images.

Enumeration for setting the compression scheme for the Flattened Monochrome images.

Enumeration for setting the Quality setting for the JPEG or JPEG2000 images.

Specifies the visual effect used when a link annotation is activated (clicked).

Graphic types for importing an image and exporting a page to. Specifies the format of the raster image file to import or export.

Specifies the ink type used for trapping purposes.

Flags for initializing the library. Unless you require fine-grain control of the intialization process of the library there is no need to use LibraryFlags or you can specify the value of NoFlags.

Flags that control where DLE log output is written. Multiple flags can be combined using bitwise OR to send log output to more than one destination simultaneously.

Options for mirroring output in the PostScript stream.

Specifies the numbering style for page labels in a document.

The policy for drawing optional content within the document.

Languages which may be selected for OCR recognition. Languages which may be selected. To find if a language is available, call IsLanguageAvailable() on the OCREngine.

The behavior to use if a suitable Font can't be found to represent recognized text. The behavior to use if a suitable Font can't be found to represent the recognized Text.

How the OCR engine views the page and detects text segments. Specify how the OCR engine will view the page, and how it detects text segments.

Performance mode for the OCR engine, balancing speed vs accuracy. Specify the performance of the OCR engine in an abstract way. In Tesseract, for instance, this changes the OCREngineMode.

Enumerator used to select type of compression used when images are recompressed. For color or grayscale images: Flate, JPEG or JPEG2000 may be selected. For black and white images: Flate, JBIG2, CCITTG3, or CCITTG4 may be selected.

Establish the compression quality to be used in compression schemas that allow variable quality. (JPEG, JPEG2000, JBIG2). Unset should be selected for compression schemes that are inherently lossless (Flate, CCITTG3, or CCITTG4). JBIG2 may select any value. JPEG and JPEG2000 can select any value between Minimum and Maximum, but should not select Unset or Lossless.

Enumerator to allow the selection of image type to Set the values for resampling and recompression.

Enumerator to allow the selection of object compression type to Set the values for object compression type.

Select the optimization option to be set or obtained.

Enumerates the base visibility states for optional content groups in an OptionalContentConfig. These values determine the default ON/OFF state applied to optional content groups when an OptionalContentConfig is used to initialize an OptionalContentContext.

A code specifying whether a color component value of 0 in a DeviceCMYK color space should erase that component or leave it unchanged when overprinting.

An enumerated data type used to describe the page view mode of a Document.

Insertion flags used by InsertPages().

Bit flags indicating which page marks are emitted for color separations.

Specifies which pages a watermark targets.

Flags indicating the different paint operations for a Path. These flags control whether a path is stroked, filled, or both, and which fill rule is used.

Specifies the PDF/A conformance level and color space for conversion. Each value corresponds to a specific PDF/A standard (1a, 1b, 2a, 2b, 2u, 3a, 3b, 3u, 4, 4e, 4f) combined with a target color space (RGB or CMYK).

The underlying PDF data type of a PDFObject. Use with PDFObject::get_type() for switch-style dispatch instead of chained dynamic_cast.

Specifies the PDF/X standard version to convert a document to.

Permissions mask, for Save.

An enumerated data type used to describe the target operation of a permissions request.

The Error Correction Level of the QR Code.

Flags for saving documents.

The data type of a collection schema field.

Options controlling how fonts are emitted in separation output.

Specifies how a colorant is handled during a separation preview.

Digital signature field options.

Enumeration to specify fields to display as part of signature appearance.

Discriminator for the three shapes of kid entries that can live in a struct element's /K array: another struct element, a marked-content reference (inline MCID or MCR dict), or an object reference (OBJR).

Enumeration for selecting the temporary storage type used by the library. Controls whether temporary files are stored on disk or in memory.

Flags that control how text operations address text within a Text object.

Rendering mode for text, corresponding to the Tr operator in a PDF content stream.

TIFF Byte Order values describing the byte order used within a file.

Specification of vertical alignment options.

Determines how content visibility is resolved when an OptionalContentMembershipDict references multiple OptionalContentGroups with conflicting on/off states.

Specifies how a watermark should be drawn in a PDF document. Controls whether the watermark is rendered as an annotation or as a form XObject within the page content stream. The "Try" variants attempt the specified method but may fall back if it is not possible.

Downsampling resolution for raster images. The plugin supports only this discrete set; arbitrary DPI values are not accepted. Numeric values match the underlying <code>WebToPDFDownsamplingDPI</code> enum so a <code>static_cast</code> suffices at the bridge.

This refers to versions of the WordFinder algorithm. WordFinder extracts words from a PDF file and enumerates the words on a single page or on all of the pages in the document.

Flags returned by Word::GetAttributes.

Writing direction for text.

XFA Form Data Export types.