Other Classes

Undocumented

Rect is a utility class used to manipulate PDF rectangle objects (refer to section 3.8.3 of the PDF Reference Manual).

Rect can be associated with a SDF/Cos rectangle array using Rect(Obj*) constructor or later using Rect::Attach(Obj*) or Rect::Update(Obj*) methods.

Rect keeps a local cache for rectangle points so it is necessary to call Rect::Update() method if the changes to the Rect should be saved in the attached Cos/SDF array.

Undocumented

Undocumented

A utility class that handles preparing PDF documents for printing.

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

This class represents a Byte Range.

RecentlyUsedCache

RecentlyUsedCache is a persistent cache that provides thumbnails for recently
used documents in PDFNet.  The cache is stored in the PDFNet Resources folder,
which can be set by calling PDFNet::SetPersistentCachePath. The cache will be used by
any PDFNet process that uses the resource path.  If more than one PDFNet process
is running concurrently, the first process to acquire a lock on the cache will
use it.  Subsequent processes will not read or modify the cache.

Recently used cache will track the order of N recently used documents, and store
references to generated PNG thumbnails for those documents.  Most of this functionality
happens 'magically', without any necessary user action.

2D Matrix

A Matrix2D object represents a 3x3 matrix that, in turn, represents an affine transformation. A Matrix2D object stores only six of the nine numbers in a 3x3 matrix because all 3x3 matrices that represent affine transformations have the same third column (0, 0, 1).

Affine transformations include rotating, scaling, reflecting, shearing, and translating. In PDFNet, the Matrix2D class provides the foundation for performing affine transformations on vector drawings, images, and text.

A transformation matrix specifies the relationship between two coordinate spaces. By modifying a transformation matrix, objects can be scaled, rotated, translated, or transformed in other ways.

A transformation matrix in PDF is specified by six numbers, usually in the form of an array containing six elements. In its most general form, this array is denoted [a b c d h v]; The following table lists the arrays that specify the most common transformations:

• Translations are specified as [1 0 0 1 tx ty], where tx and ty are the distances to translate the origin of the coordinate system in the horizontal and vertical dimensions, respectively.

• Scaling is obtained by [sx 0 0 sy 0 0]. This scales the coordinates so that 1 unit in the horizontal and vertical dimensions of the new coordinate system is the same size as sx and sy units, respectively, in the previous coordinate system.

• Rotations are produced by [cos(A) sin(A) -sin(A) cos(A) 0 0], which has the effect of rotating the coordinate system axes by an angle ‘A’ counterclockwise.

• Skew is specified by [1 tan(A) tan(B) 1 0 0], which skews the x axis by an angle A and the y axis by an angle B.

Matrix2D elements are positioned as follows : | m_a m_b 0 | | m_c m_d 0 | | m_h m_v 1 |

A single Matrix2D object can store a single transformation or a sequence of transformations. The latter is called a composite transformation. The matrix of a composite transformation is obtained by multiplying (concatenating) the matrices of the individual transformations. Because matrix multiplication is not commutative-the order in which matrices are multiplied is significant. For example, if you first rotate, then scale, then translate, you get a different result than if you first translate, then rotate, then scale.

For more information on properties of PDF matrices please refer to PDF Reference Manual (Sections 4.2 ‘Coordinate Systems’ and 4.2.3 ‘Transformation Matrices’)

 The following sample illustrates how to use Matrix2D in order to position
 an image on the page. Note that PDFNet uses the same convention of matrix
 multiplication used in PostScript and OpenGL.

    Element element = eb.CreateImage(Image(...));
    double deg2rad = 3.1415926535 / 180.0;

    Matrix2D mtx = Matrix2D(1, 0, 0, 1, 0, 200); // Translate
    mtx *= Matrix2D(300, 0, 0, 200, 0, 0);    // Scale
    mtx *= Matrix2D::RotationMatrix( 90 * deg2rad ); // Rotate
    element.GetGState().SetTransform(mtx);
    writer.WritePlacedElement(element);

 The following sample sample illustrates how to use Matrix2D in order to calculate
 absolute positioning for the text on the page.
 ...
 Matrix2D text_mtx = text_element.GetTextMatrix();
 double x, y;
 for (CharIterator itr = text_element.GetCharIterator(); itr.HasNext(); itr.Next()) {
   x = itr.Current().x; // character positioning information
   y = itr.Current().y;
   // Get current transformation matrix (CTM)
   Matrix2D ctm = text_element.GetCTM();

   // To get the absolute character positioning information concatenate current
   // text matrix with CTM and then multiply relative positioning coordinates with
   // the resulting matrix.
   Matrix2D mtx = ctm * text_mtx;
   mtx.Mult(x, y);
 }

Undocumented

Undocumented

Undocumented

MemoryFilter is a memory buffer that can be used as a source or a sink Filter in the Filter pipeline. When a MemoryFilter is the source, other filters can read data stored in memory; When MemoryFilter is a sink, other filters generate data which is then pushed in a memory buffer owned by MemoryFilter (MemoryFilter makes sure that there is enough space to accommodate all data).

Undocumented

This class represents PDFTron Custom Security handler that applies PDFTron’s custom encryption method on save.

Undocumented

Undocumented

Undocumented

Although PDF is not a programming language it provides several types of function object that represent parameterized classes of functions, including mathematical formulas and sampled representations with arbitrary resolution. Functions are used in various ways in PDF, including device-dependent rasterization information for high-quality printing (halftone spot functions and transfer functions), color transform functions for certain color spaces, and specification of colors as a function of position for smooth shadings. Functions in PDF represent static, self-contained numerical transformations.

PDF::Function represents a single, flat interface around all PDF function types.

The class GeometryCollection. A Preprocessed PDF geometry collection

ColorPt is an array of colorants (or tint values) representing a color point in an associated color space.

This abstract class is used to serve as a color space tag to identify the specific color space of a Color object. It contains methods that transform colors in a specific color space to/from several color space such as DeviceRGB and DeviceCMYK.

For purposes of the methods in this class, colors are represented as arrays of color components represented as doubles in a normalized range defined by each ColorSpace. For many ColorSpaces (e.g. DeviceRGB), this range is 0.0 to 1.0. However, some ColorSpaces have components whose values have a different range. Methods are provided to inquire per component minimum and maximum normalized values.

Undocumented

Undocumented

Page is a high-level class representing PDF page object (see ‘Page Objects’ in Section 3.6.2, ‘Page Tree,’ in PDF Reference Manual).

Among other associated objects, a page object contains:

• A series of objects representing the objects drawn on the page (See Element and ElementReader class for examples of how to extract page content).
• A list of resources used in drawing the page
• Annotations
• Beads, private metadata, optional thumbnail image, etc.

Undocumented

The Date class is a utility class used to simplify work with PDF date objects.

PDF defines a standard date format, which closely follows international standard ASN.1 (Abstract Syntax Notation One), A date is a string of the form (D:YYYYMMDDHHmmSSOHH'mm’); See PDF Reference Manual for details.

Date can be associated with a SDF/Cos date string using Date(Obj*) constructor or later using Date::Attach(Obj*) or Date::Update(Obj*) methods.

Date keeps a local date/time cache so it is necessary to call Date::Update() method if the changes to the Date should be saved in the attached Cos/SDF string.

GState is a class that keeps track of a number of style attributes used to visually define graphical Elements. Each PDF::Element has an associated GState that can be used to query or set various graphics properties.

Image class provides common methods for working with PDF images.

This class represents an object identifier (OID), as defined by ITU and used in X.509.

This class represents an AttributeTypeAndValue as mentioned in RFC 5280 in the context of DistinguishedNames and as defined in ITU X.501.

This class represents a distinguished name (DN) as defined in X.501. See the X.500 standards, RFC 5280, and an OID repository for more information.

This class represents an X509v3 certificate extension. See RFC 5280 as a specification.

This class represents an X509 public-key certificate, as specified in RFC 5280.

The class DisallowedChange. Data pertaining to a change detected in a document during a digital signature modification permissions verification step, the change bein g both made after the signature was signed, and disallowed by t he signature’s permissions settings.

Undocumented

Options pertaining to digital signature verification.

The detailed result of a trust verification step of a verification operation performed on a digital signature.

Retrieves the main verification status. The main status is determined based on the other statuses. Verification may fail for many reasons; some of these reasons are the presence of features that are not supported yet. It may be desirable for you to report unsupported signatures differently (for example, using a question mark rather than an X mark). Any unsupported features encountered can be retrieved by the use of the function GetUnsupportedFeatures on this class.

This class represents the result of verifying a secure embedded timestamp digital signature.

A class representing the result of testing a timestamping configuration.

A class representing a set of options for timestamping a document.

Undocumented

A class representing a digital signature form field.

Undocumented

FileSpec corresponds to the PDF file specification object.

A PDF file can refer to the contents of another file by using a file specification, which can take either of the following forms:

• A simple file specification gives just the name of the target file in a standard format, independent of the naming conventions of any particular file system.

• A full file specification includes information related to one or more specific file systems.

• A URL reference.

Although the file designated by a file specification is normally external to the PDF file referring to it, it is also possible to embed the file allowing its contents to be stored or transmitted along with the PDF file. However, embedding a file does not change the presumption that it is external to (or separate from) the PDF file.

For more details on file specifications, please refer to Section 3.10, ‘File Specifications’ in the PDF Reference Manual.

Undocumented

BorderStyle structure specifies the characteristics of the annotation’s border. The border is specified as a rounded rectangle.

A destination defines a particular view of a document, consisting of the following:

• The page of the document to be displayed
• The location of the document window on that page
• The magnification (zoom) factor to use when displaying the page

Destinations may be associated with Bookmarks, Annotations, and Remote Go-To Actions.

Destination is a utility class used to simplify work with PDF Destinations; Please refer to section 8.2.1 ‘Destinations’ in PDF Reference Manual for details.

Undocumented

Undocumented

Undocumented

Actions are typically what happens when a user clicks on a link or bookmark.

Instead of simply jumping to a destination in the document, an annotation or outline item can specify an action for the viewer application to perform, such as launching an application, playing a sound, or changing an annotation’s appearance state.

ActionParameter is a class used to describe all the information needed to execute an action. In most cases only the action itself is necessary since the document can be inferred from associated SDF::Obj, however some actions particularly JavaScript actions on Field or Annot objects need access to the associated Field or Annot object.

Undocumented

The class OCRModule. static interface to PDFTron SDKs OCR functionality

Undocumented

Undocumented

Undocumented

Undocumented

The class CADModule. static interface to PDFTron SDKs CAD functionality

The class PDF2WordModule. static interface to PDFTron SDKs PDF to Word functionality

The class PDF2HtmlReflowParagraphsModule. static interface to PDFTron SDKs PDF to HTML functionality

The class StructuredOutputModule. static interface to PDFTron SDKs PDF to Word, Excel, PowerPoint, HTML functionality

An object representing a check box used in a PDF Form.

An object representing a combo box used in a PDF Form.

An object representing a List Box used in a PDF Form.

An object representing a push button used in a PDF Form.

An object representing a Radio Button used in a PDF Form.

An object representing a Group of Radio Buttons that can be used to create new Radio Buttons. If a group contains multiple buttons they will be connected.

An object representing a Signature used in a PDF Form. These Widgets can be signed directly, or signed using a DigitalSignatureField.

An object representing a Text Box used in a PDF Form.

Undocumented

A %PDF document may optionally display a document outline 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 Bookmarks (sometimes called outline items), which serve as a ‘visual table of contents’ to display the document’s structure to the user.

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 PDF::Action) can be specified.

Bookmark is a utility class used to simplify work with %PDF bookmarks (or outlines; see section 8.2.2 ‘Document Outline’ in %PDF Reference Manual for more details).

ContentReplacer is a utility class for replacing content (text and images) in existing PDF (template) documents.

Users can replace content in a PDF page using the following operations:

• Replace an image that exists in a target rectangle with a replacement image.
• Replace text that exists in a target rectangle with replacement text.
• Replace all instances of a specially marked string with replacement string.

The following code replaces an image in a target region. This code also replaces the text “[NAME]” and “[JOB_TITLE]” with “John Smith” and “Software Developer” respectively. Notice the square braces (‘[’ and ‘]’) on the target strings in the original PDFDoc. These square braces are not included in the actual function calls below, as they’re implicitly added.

 PDFDoc doc("../../TestFiles/BusinessCardTemplate.pdf");
 doc.InitSecurityHandler();
 ContentReplacer replacer;
 Page page = doc.GetPage(1);
 Image img = Image::Create(doc, "../../TestFiles/peppers.jpg");
 replacer.AddImage(page.GetMediaBox(), img.GetSDFObj());
 replacer.AddString("NAME", "John Smith");
 replacer.AddString("JOB_TITLE", "Software Developer");
 replacer.Process(page);

Contains the information required to draw the path. Contains an array of PathSegmentType Operators and corresponding path data Points. A point may be on or off (off points are control points). The meaning of a point depends on associated id (or segment type) in the path segment type array.

The class ShapedText. A sequence of positioned glyphs – the visual representation of a given text string

A font that is used to draw text on a page. It corresponds to a Font Resource in a PDF file. More than one page may reference the same Font object. A Font has a number of attributes, including an array of widths, the character encoding, and the font’s resource name.

PDF document can contain several different types of fonts and Font class represents a single, flat interface around all PDF font types.

There are two main classes of fonts in PDF: simple and composite fonts.

Simple fonts are Type1, TrueType, and Type3 fonts. All simple fonts have the following properties:

• Glyphs in the font are selected by single-byte character codes obtained from a string that is shown by the text-showing operators. Logically, these codes index into a table of 256 glyphs; the mapping from codes to glyphs is called the font’s encoding. Each font program has a built-in encoding. Under some circumstances, the encoding can be altered by means described in Section 5.5.5 “Character Encoding” in PDF Reference Manual.
  
  

• Each glyph has a single set of metrics. Therefore simple fonts support only horizontal writing mode.
  
  

A composite font is one whose glyphs are obtained from a font like object called a CIDFont (e.g. CIDType0Font and CIDType0Font). A composite font is represented by a font dictionary whose Subtype value is Type0. The Type 0 font is known as the root font, while its associated CIDFont is called its descendant. CID-keyed fonts provide a convenient and efficient method for defining multiple-byte character encodings and fonts with a large number of glyphs. These capabilities provide great flexibility for representing text in writing systems for languages with large character sets, such as Chinese, Japanese, and Korean (CJK).

Shading is a class that represents a flat interface around all PDF shading types:

• In Function-based (type 1) shadings, the color at every point in the domain is defined by a specified mathematical function. The function need not be smooth or continuous. This is the most general of the available shading types, and is useful for shadings that cannot be adequately described with any of the other types.

• Axial shadings (type 2) define a color blend along a line between two points, optionally extended beyond the boundary points by continuing the boundary colors.

• Radial shadings (type 3) define a color blend that varies between two circles. Shadings of this type are commonly used to depict three-dimensional spheres and cones.

• Free-form Gouraud-shaded triangle mesh shadings (type 4) and lattice Gouraud shadings (type 5) are commonly used to represent complex colored and shaded three-dimensional shapes. The area to be shaded is defined by a path composed entirely of triangles. The color at each vertex of the triangles is specified, and a technique known as Gouraud interpolation is used to color the interiors. The interpolation functions defining the shading may be linear or nonlinear.

• Coons patch mesh shadings (type 6) are constructed from one or more color patches, each bounded by four cubic Bezier curves.

  A Coons patch generally has two independent aspects:

  • Colors are specified for each corner of the unit square, and bilinear interpolation is used to fill in colors over the entire unit square
    
  • Coordinates are mapped from the unit square into a four-sided patch whose sides are not necessarily linear. The mapping is continuous: the corners of the unit square map to corners of the patch and the sides of the unit square map to sides of the patch.

• Tensor-product patch mesh shadings (type 7) are identical to type 6 (Coons mesh), except that they are based on a bicubic tensor-product patch defined by 16 control points, instead of the 12 control points that define a Coons patch. The shading Patterns dictionaries representing the two patch types differ only in the value of the Type entry and in the number of control points specified for each patch in the data stream. Although the Coons patch is more concise and easier to use, the tensor- product patch affords greater control over color mapping.

Patterns are quite general, and have many uses; for example, they can be used to create various graphical textures, such as weaves, brick walls, sunbursts, and similar geometrical and chromatic effects.

Patterns are specified in a special family of color spaces named Pattern, whose ‘color values’ are PatternColor objects instead of the numeric component values used with other spaces. Therefore PatternColor is to pattern color space what is ColorPt to all other color spaces.

A tiling pattern consists of a small graphical figure called a pattern cell. Painting with the pattern replicates the cell at fixed horizontal and vertical intervals to fill an area. The effect is as if the figure were painted on the surface of a clear glass tile, identical copies of which were then laid down in an array covering the area and trimmed to its boundaries. This is called tiling the area.

The pattern cell can include graphical elements such as filled areas, text, and sampled images. Its shape need not be rectangular, and the spacing of tiles can differ from the dimensions of the cell itself.

The order in which individual tiles (instances of the cell) are painted is unspecified and unpredictable; it is inadvisable for the figures on adjacent tiles to overlap.

Element is the abstract interface used to access graphical elements used to build the display list.

Just like many other classes in PDFNet (e.g. ColorSpace, Font, Annot, etc), Element class follows the composite design pattern. This means that all Elements are accessed through the same interface, but depending on the Element type (that can be obtained using GetType()), only methods related to that type can be called. For example, if GetType() returns e_image, it is illegal to call a method specific to another Element type (i.e. a call to a text specific GetTextData() will throw an Exception).

ElementBuilder is used to build new PDF::Elements (e.g. image, text, path, etc) from scratch. In conjunction with ElementWriter, ElementBuilder can be used to create new page content.

ElementReader can be used to parse and process content streams. ElementReader provides a convenient interface used to traverse the Element display list of a page. The display list representing graphical elements (such as text-runs, paths, images, shadings, forms, etc) is accessed using the intrinsic iterator. ElementReader automatically concatenates page contents spanning multiple streams and provides a mechanism to parse contents of sub-display lists (e.g. forms XObjects and Type3 fonts).

A sample use case for ElementReader is given below:

 ...
 ElementReader reader;
 reader.Begin(page);
 for (Element element=reader.Next(); element; element = reader.Next()) // Read page contents
 {
   switch (element.GetType())   {
     case Element::e_path: { // Process path data...
         const double* data = element.GetPathPoints();
         int sz = element.GetPointCount();
     }
     break;
     case Element::e_text:
         // ...
     break;
   }
 }
 reader.End();

For a full sample, please refer to ElementReader and ElementReaderAdvTest sample projects.

ElementWriter can be used to assemble and write new content to a page, Form XObject, Type3 Glyph stream, pattern stream, or any other content stream.

The class ExternalAnnotManager. A manager class attached to a PDFView that takes care of annotations from xfdf sources

ExternalAnnotManager instances are created through the PDFView using PDFView.GetExternalAnnotManager()

Flattener is a optional PDFNet add-on that can be used to simplify and optimize existing PDF’s to render faster on devices with lower memory and speeds.

PDF documents can frequently contain very complex page description (e.g. thousands of paths, different shadings, color spaces, blend modes, large images etc.) that may not be suitable for interactive viewing on mobile devices. Flattener can be used to speed-up PDF rendering on mobile devices and on the Web by simplifying page content (e.g. flattening complex graphics into images) while maintaining vector text whenever possible.

By using the FlattenMode::e_simple option each page in the PDF will be reduced to a single background image, with the remaining text over top in vector format. Some text may still get flattened, in particular any text that is clipped, or underneath, other content that will be flattened.

On the other hand the FlattenMode::e_fast will not flatten simple content, such as simple straight lines, nor will it flatten Type3 fonts.

LinkInfo is a utility class used to store information about links when used along with the SetUrlExtraction feature.

Image2RGB is a filter that can decompress and normalize any PDF image stream (e.g. monochrome, CMYK, etc) into a raw RGB pixel stream.

Image2RGBA is a filter that can decompress and normalize any PDF image stream (e.g. monochrome, CMYK, etc) into a raw RGBA pixel stream.

SWIG director's base class

Contains virtual functions which match the signature of the PDFNet function pointers.

Each virtual function has a matching static function calling it. User extends this class in the target language and overrides the function of interest. The static function is assigned to the function pointer.

Undocumented

Undocumented

Save the current Highlight information in the class to a file.

A class representing the current text selection.

Undocumented

A class that stores downsampling/recompression settings for color and grayscale images.

A class that stores image downsampling/recompression settings for monochrome images.

A class that stores image text optimization settings.

A class that stores settings for the optimizer

PDF page labels can be used to describe a page. This is used to allow for non-sequential page numbering or the addition of arbitrary labels for a page (such as the inclusion of Roman numerals at the beginning of a book). PDFNet PageLabel object can be used to specify the numbering style to use (for example, upper- or lower-case Roman, decimal, and so forth), the starting number for the first page, and an arbitrary prefix to be pre-appended to each number (for example, “A-” to generate “A-1”, “A-2”, “A-3”, and so forth.)

PageLabel corresponds to the PDF Page Label object (Section 8.3.1, ‘Page Labels’ in the PDF Reference Manual.

Each page in a PDF document is identified by an integer page index that expresses the page’s relative position within the document. In addition, a document may optionally define page labels to identify each page visually on the screen or in print. Page labels and page indices need not coincide: the indices are fixed, running consecutively through the document starting from 1 for the first page, but the labels can be specified in any way that is appropriate for the particular document. For example, if the document begins with 12 pages of front matter numbered in roman numerals and the remainder of the document is numbered in Arabic, the first page would have a page index of 1 and a page label of i, the twelfth page would have index 12 and label xii, and the thirteenth page would have index 13 and label 1.

For purposes of page labeling, a document can be divided into labeling ranges, each of which is a series of consecutive pages using the same numbering system. Pages within a range are numbered sequentially in ascending order. A page’s label consists of a numeric portion based on its position within its labeling range, optionally preceded by a label prefix denoting the range itself. For example, the pages in an appendix might be labeled with decimal numeric portions prefixed with the string “A-” and the resulting page labels would be “A-1”, “A-2”,

@note There is no default numbering style; if no ‘S’ (Style) entry is present, page labels consist solely of a label prefix with no numeric portion. For example, if the ‘P’ entry (Prefix) specifies the label prefix “Appendix”, each page is simply labeled “Appendix” with no page number. If the ‘P’ entry is also missing or empty, the page label is an empty string.

Sample code (See PableLabelsTest sample project for examples):

 // Create a page labeling scheme that starts with the first page in
 // the document (page 1) and is using uppercase roman numbering
 // style.
 doc.SetPageLabel(1, PageLabel::Create(doc, PageLabel::e_roman_uppercase, "My Prefix ", 1));

 // Create a page labeling scheme that starts with the fourth page in
 // the document and is using decimal Arabic numbering style.
 // Also the numeric portion of the first label should start with number
 // 4 (otherwise the first label would be "My Prefix 1").
 PageLabel L2 = PageLabel::Create(doc, PageLabel::e_decimal, "My Prefix ", 4);
 doc.SetPageLabel(4, L2);

 // Create a page labeling scheme that starts with the seventh page in
 // the document and is using alphabetic numbering style. The numeric
 // portion of the first label should start with number 1.
 PageLabel L3 = PageLabel::Create(doc, PageLabel::e_alphabetic_uppercase, "My Prefix ", 1);
 doc.SetPageLabel(7, L3);

 // Read page labels from an existing PDF document.
 PageLabel label;
 for (int i=1; i<=doc.GetPageCount(); ++i) {
 label = doc.GetPageLabel(i);
 if (label.IsValid()) {
   UString title = label.GetLabelTitle(i);
 }

PageSet is a container of page numbers ordered following a linear sequence. The page numbers are integers and must be greater than zero. Duplicates are allowed.

(NOTE: This is not a mathematical set)

PDFDocInfo is a high-level utility class that can be used to read and modify document’s metadata.

PDFDocViewPrefs is a high-level utility class that can be used to control the way the document is to be presented on the screen or in print.

PDFDocViewPrefs class corresponds to PageMode, PageLayout, and ViewerPreferences entries in the document’s catalog. For more details please refer to section 8.1 ‘Viewer Preferences’ in PDF Reference Manual.

This class is used to store separations in PDFRasterize and PDFDraw

PDFRasterizer is a low-level PDF rasterizer.

The main purpose of this class is to convert PDF pages to raster images (or bitmaps).

Undocumented

Undocumented

Undocumented

Undocumented