Class Index - PDFTron PDFNet SDK API Reference

_ A B C D E F G H I J K L M N O P Q R S T U V W

_

__Delete  

A

Action Actions are typically what happens when a user clicks on a link or bookmark. 
ActionParameter Container for parameters used in handling various actions. 
AnalyticsHandlerCallback  
Annot Annot is a base class for different types of annotations. 
Annot.BorderStyle BorderStyle structure specifies the characteristics of the annotation's border. 
AnnotsCompat Compatibility layer for older API. 
AnnotsCompat.Caret  
AnnotsCompat.Circle  
AnnotsCompat.FileAttachment  
AnnotsCompat.FreeText  
AnnotsCompat.Highlight  
AnnotsCompat.Ink  
AnnotsCompat.Line  
AnnotsCompat.Link  
AnnotsCompat.Markup  
AnnotsCompat.Movie  
AnnotsCompat.Polygon  
AnnotsCompat.PolyLine  
AnnotsCompat.Popup  
AnnotsCompat.Redaction  
AnnotsCompat.RubberStamp  
AnnotsCompat.Screen  
AnnotsCompat.Sound  
AnnotsCompat.Square  
AnnotsCompat.Squiggly  
AnnotsCompat.StrikeOut  
AnnotsCompat.Text  
AnnotsCompat.TextMarkup  
AnnotsCompat.Underline  
AnnotsCompat.Watermark  
AnnotsCompat.Widget  
ASCII85Encode ASCII85Encode filter can be used to encode any data stream into a stream that does not contain any binary characters. 
AssertHandlerCallback  
AttrObj An application or plug-in extension that processes logical structure can attach additional information, called attributes, to any structure element. 

B

BitmapHelper  
BitmapHelper.CustomBitmap  
BlackBoxContext The class BlackBoxContext. 
Bookmark 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. 

C

CADConvertOptions  
CADModule The class CADModule. 
Caret A Caret annotation (PDF 1.5) is a visual symbol that indicates the presence of text edits. 
CharData CharData is a data structure returned by CharIterator that is used to provide extra information about a character within a text run. 
CharIterator CharIterator is an iterator type that can be used to traverse CharData in the current e_text element. 
CheckBoxWidget An object representing a check box used in a PDF Form. 
Circle Square and circle annotations (PDF 1.3) shall display, respectively, a rectangle or an ellipse on the page. 
ClassMap The Class ClassMap. 
ColorPt ColorPt is an array of colorants (or tint values) representing a color point in an associated color space. 
ColorSpace This abstract class is used to serve as a color space tag to identify the specific color space of a Color object. 
ComboBoxWidget An object representing a Combo Box used in a PDF Form. 
CommonCompat Compatibility layer for older API. 
CommonCompat.Matrix2D  
CommonCompat.PDFNetIterator  
CommonCompat.RecentlyUsedCache  
Config The OCG::Config object represents an optional-content (OC) configuration structure (see section 4.10.3 in PDF Reference), used to persist a set of visibility states and other optional-content information in a PDF file A document has a default configuration, saved in the D entry in the 'OCProperties' dictionary (that can be obtained using pdfdoc.GetOCConfig()), and can have a list of other configurations, saved as an array in the 'Configs' entry in the OCProperties dictionary. 
ContentItem Content items are graphical objects that exist in the document independently of the structure tree but are associated with structure elements. 
ContentReplacer ContentReplacer is a utility class for replacing content (text and images) in existing PDF (template) documents. 
Context

The OCG::Context object represents an optional-content context in a document, within which document objects such as words or annotations are visible or hidden. 

ConversionOptions  
Convert Converter is a utility class used to convert documents and files to PDF. 
Convert.EPUBOutputOptions A class containing options common to ToEpub functions  
Convert.HTMLOutputOptions A class containing options common to ToHtml and ToEpub functions  
Convert.SVGOutputOptions A class containing options for ToSvg functions  
Convert.TiffOutputOptions A class containing options common to ToTiff functions  
Convert.XODOutputOptions A class containing options for ToXod functions  
Convert.XPSOutputCommonOptions A class containing options common to ToXps and ToXod functions  
Convert.XPSOutputOptions A class containing options for ToXps functions  
ConvertPrinter The ConvertPrinter class contains static member functions for installing and uninstalling a Windows OS printer for conversion of document formats by the Convert class. 
CubicCurveBuilder The class CubicCurveBuilder. 
CurrentPageProc The Interface CurrentPageProc. 
CustomFilter

CustomFilter allows for customizing the reading and writing process. 

D

Date The Date class is a utility class used to simplify work with PDF date objects. 
Destination 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. 
DictIterator DictIterator is used to traverse key/value pairs in a dictionary. 
DiffOptions  
DigestAlgorithm  
DigitalSignatureField The class DigitalSignatureField. 
DigitalSignatureField.DocumentPermissions  
DigitalSignatureField.FieldPermissions  
DigitalSignatureField.SubFilterType  
DigitalSignatureFieldIterator DigitalSignatureFieldIterator is an iterator type that can be used to traverse a list of form fields in a PDF document. 
DisallowedChange The class DisallowedChange. 
DisallowedChange.Type  
Doc The Class Doc. 
DocSnapshot The class DocSnapshot. 
DocumentConversion The class DocumentConversion. 

E

Element Element is the abstract interface used to access graphical elements used to build the display list. 
ElementBuilder ElementBuilder is used to build new PDF.Elements (e.g. 
ElementReader ElementReader can be used to parse and process content streams. 
ElementWriter 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. 
ErrorReportProc ErrorReportProc is an interface for a custom handler that that can be used to report potential rendering errors in PDFViewCtrl, PDFDraw, or PDFRasterizer. 
ExternalAnnotManager The class ExternalAnnotManager. 

F

FDFCompat Compatibility layer for older API. 
FDFCompat.FDFDoc  
FDFCompat.FDFField  
FDFDoc FDFDoc is a class representing Forms Data Format (FDF) documents. 
FDFField TODO: need description FDFField represents FDFField  
FDFFieldIterator FDFFieldIterator is an iterator type used to traverse interactive form fields in a FDF document. 
Field An interactive form (sometimes referred to as an AcroForm) is a collection of fields for gathering information interactively from the user. 
FieldIterator FieldIterator is an iterator type that can be used to traverse a list of form fields in a PDF document. 
FileAttachment A file attachment annotation (PDF 1.3) contains a reference to a file, which typically shall be embedded in the PDF file. 
FileDescriptorFilter  
FileDescriptorReadOnlyFilter  
FileSpec FileSpec corresponds to the PDF file specification object. 
Filter Provides a generic view of a sequence of bytes. 
FilterReader FilterReader is a utility class providing a convenient way to read data from an input filter (using Filter directly is not very intuitive). 
FiltersCompat Compatibility layer for older API. 
FiltersCompat.ASCII85Encode  
FiltersCompat.CustomFilter  
FiltersCompat.Filter  
FiltersCompat.FilterReader  
FiltersCompat.FilterWriter  
FiltersCompat.FlateEncode  
FiltersCompat.MappedFile  
FiltersCompat.MemoryFilter  
FilterWriter FilterWriter is a utility class providing a convenient way to write data to an output filter (using Filter directly is not very intuitive). 
FindTextProc The Interface FindTextProc. 
FlateEncode FlateEncode filter can be used to compress any data stream using Flate (i.e. 
Flattener 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. 
Font A font that is used to draw text on a page. 
FontCharCodeIterator FontCharCodeIterator is an iterator type that can be used to traverse a list of visible char codes in a font embedded in PDF. 
FreeText A free text annotation (PDF 1.3) displays text directly on the page. 
Function 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. 

G

GeometryCollection The class GeometryCollection. 
GeometryCollection.SnappingMode  
Group The OCG::Group object represents an optional-content group. 
GSChangesIterator GSChangesIterator is an iterator type that can be used to traverse a list of changes in the graphics state between subsequnet graphical elements on the page. 
GState GState is a class that keeps track of a number of style attributes used to visually define graphical Elements. 

H

Highlight Text markup annotations shall appear as highlights, underlines, strikeouts (all PDF 1.3), or jagged ("squiggly") underlines (PDF 1.4) in the text of a document. 
Highlights

Highlights is used to store the necessary information and perform certain tasks in accordance with Adobe's Highlight standard, whose details can be found at http://partners.adobe.com/public/developer/en/pdf/HighlightFileFormat.pdf

HTML2PDF 'pdftron.PDF.HTML2PDF' is an optional PDFNet Add-On utility class that can be used to convert HTML web pages into PDF documents by using an external module (html2pdf). 
HTML2PDF.Proxy Proxy settings to be used when loading content from web pages. 
HTML2PDF.TOCSettings Settings for table of contents. 
HTML2PDF.WebPageSettings Settings that control how a web page is opened and converted to PDF. 

I

Image Image class that provides common methods for working with PDF images. 
Image.Compat Compatibility layer for older API. 
Image2RGB Image2RGB is a filter that can decompress and normalize any PDF image stream (e.g. 
Image2RGBA Image2RGBA is a filter that can decompress and normalize any PDF image stream (e.g. 
Ink An ink annotation (PDF 1.3) represents a freehand "scribble" composed of one or more disjoint paths. 
Ink.BlendMode  

J

JavaScriptEventProc The Interface JavaScriptEventProc  

K

KeyStrokeActionResult A class that contains information from a KeyStrokeAction  
KeyStrokeEventData KeyStokeEventData contains information for executing KeyStrokeAction. 

L

Line The purpose of a line annotation (PDF 1.3) is to display a single straight line on the page. 
Link A link annotation represents either a hypertext link to a destination elsewhere in the document or an action to be performed. 
ListBoxWidget An object representing a List Box used in a PDF Form. 
LogMessageHandlerCallback  

M

MappedFile MappedFile is a utility class to read files on a file system. 
Markup The meaning of an annotation's Contents entry varies by annotation type. 
Matrix2D A Matrix2D object represents a 3x3 matrix that, in turn, represents an affine transformation. 
MemoryFilter MemoryFilter is a memory buffer that can be used as a source or a sink Filter in the Filter pipeline. 
Movie The Class Movie. 

N

NameTree A NameTree is a common data structure in PDF. 
NameTreeIterator NameTreeIterator is used to traverse key/value pairs in a NameTree. 
NumberTree A NumberTree is a common data structure in PDF. 
NumberTreeIterator NumberTreeIterator is used to traverse key/value pairs in a NumberTree. 

O

Obj Obj is a concrete class for all SDF/Cos objects. 
ObjSet ObjSet is a lightweight container that can hold a collection of SDF objects. 
OCGCompat Compatibility layer for older API. 
OCGCompat.Config  
OCGCompat.Context  
OCGCompat.Group  
OCGCompat.OCMD  
OCMD The OCMD object represents an Optional Content Membership Dictionary (OCMD) that allows the visibility of optional content to depend on the states in a set of optional-content groups (OCG::Group). 
OCRModule The class OCRModule. 
OCROptions  
OfficeToPDFOptions  
Optimizer  
Optimizer.ImageSettings A class that stores downsampling/recompression settings for color and grayscale images. 
Optimizer.MonoImageSettings A class that stores image downsampling/recompression settings for monochrome images. 
Optimizer.OptimizerSettings A class that stores settings for the optimizer  
Optimizer.TextSettings A class that stores text optimization settings. 
OptionsBase  

P

Page Page is a high-level class representing PDF page object (see 'Page Objects' in Section 3.6.2, 'Page Tree,' in PDF Reference Manual). 
PageIterator PageIterator is an iterator type that can be used to traverse a list pages in a PDF document. 
PageLabel PDF page labels can be used to describe a page. 
PageSet PageSet is a container of page numbers ordered following a linear sequence. 
PathData Contains the information required to draw the path. 
PatternColor 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. 
PDFACompat Compatibility layer for older API. 
PDFACompat.PDFACompliance  
PDFACompliance PDFACompliance class is used to validate PDF documents for PDF/A (ISO 19005:1/2/3) compliance or to convert existing PDF files to PDF/A compliant documents. 
PDFCompat Compatibility layer for older API. 
PDFCompat.Action  
PDFCompat.Annot  
PDFCompat.Bookmark  
PDFCompat.CharData  
PDFCompat.ColorPt  
PDFCompat.ColorSpace  
PDFCompat.ContentReplacer  
PDFCompat.Convert  
PDFCompat.ConvertPrinter  
PDFCompat.Date  
PDFCompat.Destination  
PDFCompat.Element  
PDFCompat.ElementBuilder  
PDFCompat.ElementReader  
PDFCompat.ElementWriter  
PDFCompat.Field  
PDFCompat.FileSpec  
PDFCompat.Flattener  
PDFCompat.Font  
PDFCompat.Function  
PDFCompat.GState  
PDFCompat.Highlights  
PDFCompat.HTML2PDF  
PDFCompat.Image  
PDFCompat.Image2RGB  
PDFCompat.Image2RGBA  
PDFCompat.Optimizer  
PDFCompat.Page  
PDFCompat.PageLabel  
PDFCompat.PageSet  
PDFCompat.PatternColor  
PDFCompat.PDFDoc  
PDFCompat.PDFDocInfo  
PDFCompat.PDFDocViewPrefs  
PDFCompat.PDFDraw  
PDFCompat.PDFNet  
PDFCompat.PDFRasterizer  
PDFCompat.PDFViewCtrl  
PDFCompat.Print  
PDFCompat.Rect  
PDFCompat.Redactor  
PDFCompat.Shading  
PDFCompat.Stamper  
PDFCompat.TextExtractor  
PDFCompat.TextSearch  
PDFDoc PDFDoc is a high-level class describing a single PDF (Portable Document Format) document. 
PDFDoc.ActionTriggerMode  
PDFDoc.FlattenMode  
PDFDoc.InsertBookmarkMode  
PDFDocGenerator The class PDFDocGenerator. 
PDFDocInfo PDFDocInfo is a high-level utility class that can be used to read and modify document's metadata. 
PDFDocViewPrefs 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. 
PDFDraw PDFDraw contains methods for converting PDF pages to images and to Bitmap objects. 
PDFDraw.IntBufferData  
PDFNet PDFNet contains global library initialization, registration, configuration, and termination methods. 
PDFNetException PDFNetException is derived from the standard exception class and it is a superclass for all PDFNet library exceptions. 
PDFNetInternalTools The class PDFNetInternalTools. 
PDFNetIterator<T> Supports a simple iteration over a non-generic collection. 
PDFRasterizer PDFRasterizer is a low-level PDF rasterizer. 
PDFViewCtrl PDFViewCtrl is a utility class that can be used for interactive rendering of PDF documents. 
PDFViewCtrl.ColorPostprocessMode  
PDFViewCtrl.LinkInfo A class that holds information for a link. 
PDFViewCtrl.PagePresentationMode PagePresentationMode lists common modes of presenting PDF pages. 
PDFViewCtrl.PageViewMode PageViewMode lists common modes of viewing PDF pages. 
PDFViewCtrl.Selection A class representing the current text selection. 
PDFViewScrollPane A scrolling panel. 
Point The Class Point. 
Polygon The Polygon class. 
PolyLine Polyline annotations (PDF 1.5) display (open or closed) shapes of multiple edges on the page. 
Popup A pop-up annotation (PDF 1.3) displays text in a pop-up window for entry and editing. 
Print Print is a utility class used to print PDF documents. 
PrinterMode PrinterMode is a utility class used to set printer options for printing PDF documents. 
ProgressMonitor ProgressMonitor is an interface that an application can use to indicate the progress of a lengthy operation (such as PDFDoc.Save()). 
PushButtonWidget An object representing a push button used in a PDF Form. 

Q

QuadPoint The Class QuadPoint. 

R

RadioButtonGroup An object representing a Group of Radio Buttons that can be used to create new Radio Buttons. 
RadioButtonWidget An object representing a Radio Button used in a PDF Form. 
RecentlyUsedCache RecentlyUsedCache is a persistent cache that provides thumbnails for recently used documents in PDFNet. 
Rect Rect is a utility class used to manipulate PDF rectangle objects (refer to section 3.8.3 of the PDF Reference Manual). 
RectCollection  
Redaction A redaction annotation (PDF 1.7) identifies content that is intended to be removed from the document. 
Redactor PDF Redactor is a separately licensable Add-on that offers options to remove (not just covering or obscuring) content within a region of PDF. 
Redactor.Appearance Class used to customize the appearance of the optional redaction overlay. 
Redactor.Redaction  
RequestRenderInWorkerThreadProc RequestRenderInWorkerThreadProc is an interface for a custom handler that issues a rendering request from the UI thread. 
ResultSnapshot The class ResultSnapshot. 
RoleMap RoleMap is a dictionary that maps the names of structure types used in the document to their approximate equivalents in the set of standard structure types. 
RubberStamp A rubber stamp annotation (PDF 1.3) displays text or graphics intended to look as if they were stamped on the page with a rubber stamp. 

S

Screen A screen annotation (PDF 1.5) specifies a region of a page upon which media clips may be played. 
SDFCompat Compatibility layer for older API. 
SDFCompat.DictIterator  
SDFCompat.NameTree  
SDFCompat.NumberTree  
SDFCompat.Obj  
SDFCompat.ObjSet  
SDFCompat.SDFDoc  
SDFCompat.SecurityHandler  
SDFDoc SDFDoc is a low-level document representing a graph of SDF.Obj nodes that can be used to build higher-level document models such as PDF (Portable Document Format) or FDF (Forms Document Format). 
SDFDoc.SaveMode  
SecondaryFileFilter This class is used for creating a PDFDoc from Android content Uri. 
SecurityHandler Standard Security Handler is a built-in password-based security handler. 
SElement SElement represents PDF structural elements, which are nodes in a tree structure, defining a PDF document's logical structure. 
Separation Separation contains a memory buffer and CMYK components' information about rasterized separations used in PDFDraw.getSeparationBitmaps() and PDFRasterizer.rasterizeSeparations()

Note: This class is available on all platforms supported by PDFNet. 

Shading 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. 
SignatureHandler A base class for SignatureHandler. 
SignatureWidget An object representing a Signature used in a PDF Form. 
Sound A sound annotation (PDF 1.2) shall analogous to a text annotation except that instead of a text note, it contains sound recorded from the computer's microphone or imported from a file. 
Square Square and circle annotations (PDF 1.3) shall display, respectively, a rectangle or an ellipse on the page. 
Squiggly TextMarkup annotations shall appear as highlights, underlines, strikeouts (all PDF 1.3), or jagged ("squiggly") underlines (PDF 1.4) in the text of a document. 
Stamper Stamper is a utility class that can be used to PDF pages with text, images, or with other PDF content in only a few lines of code. 
STree STree is the root of the structure tree, which is a central repository for information related to a PDF document's logical structure. 
StrikeOut TextMarkup annotations shall appear as highlights, underlines, strikeouts (all PDF 1.3), or jagged ("squiggly") underlines (PDF 1.4) in the text of a document. 
StrokeOutlineBuilder StrokeOutlineBuilder is a class used to generate a stroke outline. 
StrokeOutlineBuilder.TipOptions  
StructCompat Compatibility layer for older API. 
StructCompat.AttrObj  
StructCompat.ClassMap  
StructCompat.ContentItem  
StructCompat.RoleMap  
StructCompat.SElement  
StructCompat.STree  

T

Text A text annotation represents a "sticky note" attached to a point in the PDF document. 
Text2PDFOptions  
TextExtractor TextExtractor is used to analyze a PDF page and extract words and logical structures that are visible within a given region. 
TextExtractor.Compat Compatibility layer API. 
TextExtractor.Line  
TextExtractor.Style A class representing predominant text style associated with a given Line, a Word, or a Glyph. 
TextExtractor.Word  
TextMarkup Text markup annotations shall appear as highlights, underlines, strikeouts (all PDF 1.3), or jagged ("squiggly") underlines (PDF 1.4) in the text of a document. 
TextSearch

TextSearch searches through a PDF document for a user-given search pattern. 

TextSearchResult TextSearchResult is used by the TextSearch class for returning a search result. 
TextWidget An object representing a Text Box used in a PDF Form. 
ThumbAsyncHandler ThumbAsyncHandler is an interface for a custom handler that that can be passed into GetThumbAsync. 
TrustVerificationResult The class TrustVerificationResult. 

U

Underline Text markup annotations shall appear as highlights, underlines, strikeouts (all PDF 1.3), or jagged ("squiggly") underlines (PDF 1.4) in the text of a document. 
UndoManager The class UndoManager. 

V

VerificationOptions The class VerificationOptions. 
VerificationOptions.SecurityLevel  
VerificationOptions.TimeMode  
VerificationResult The class VerificationResult. 
VerificationResult.DigestStatus  
VerificationResult.DocumentStatus  
VerificationResult.ModificationPermissionsStatus  
VerificationResult.TrustStatus  
ViewChangeCollection Class for collecting changes to a PDFDoc and/or viewer, which can then be passed to various functions to act on. 
ViewerOptimizedOptions A class containing ViewerOptimizedOptions  

W

Watermark A watermark annotation (PDF 1.6) shall be used to represent graphics that shall be printed at a fixed size and position on a page, regardless of the dimensions of the printed page. 
WebFontDownloader The class WebFontDownloader. 
Widget Interactive forms use widget annotations (PDF 1.2) to represent the appearance of fields and to manage user interactions. 
WordToPDFOptions