Package com.datalogics.PDFL

Class Summary

Class	Description
Action	When a user clicks a link or bookmark in a PDF, an action occurs, moving the reader to a new location.
Annotation	Associates an object with its location on a page of a PDF document.
AxialShadingPattern	A color blend that varies along an axis.
Bookmark	A bookmark on a page of a PDF document.
CalGrayColorSpace	A calibrated gray color space.
CalRGBColorSpace	A calibrated RGB color space.
CancelProc	A callback function used to abort an operation.
CircleAnnotation	A circle annotation is an annotation surrounded by a curved and possibly elliptical border.
Clip	A clipping path is used to mark an area within a page to be highlighted or removed.
ClosePath	An operator that completes a vector shape, drawing a line from the first point to the last point.
Collection	Allows for manipulation of PDF collections, or portfolios.
CollectionSchema	Provides for adding/removing/retrieving schema fields in a collection.
CollectionSchemaField	Allows for the creation of collection schema field objects.
CollectionSortItem	Stores data about fields that viewers use for sorting collection items.
Color	A color specified by values appropriate for its color space.
ColorConvertActions	Class that defines color conversion actions for an object described by certain attributes.
ColorConvertParams	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.
ColorSpace	Base class for all color spaces.
ColorValueConverter	This class contains methods used to convert sets of values from one Colorspace to another.
Container	A container class represents a group of elements on a page in a PDF file.
Content	Class that represents the collection of elements on a PDF page.
CurveTo	The curveto operator is used to draw a Bezier curve.
CurveToV	A curveto operator where the first control point matches the beginning.
CurveToY	A curveto operator where the second control point matches the end point.
DeviceNColorSpace	Represents a color space with an arbitrary number of color components.
DocTextFinder	A class used to extract words from a document using a regular expression.
DocTextFinderMatch	A phrase in the document that matched the supplied regular expression along with its associated quad bounding box(es).
DocTextFinderQuadInfo	A bounding box quad of a character in a PDF file that was part of a string that matched a given regular expression.
Document	The underlying PDF representation of a document.
DrawParams	Settings for rendering PDF pages as images.
Element	The base class for elements of the content of a page.
EncodingInfo	Represents a font's encoding data.
ExponentialFunction	An interpolation between two output values as input values vary across a domain.
ExtendedGraphicState	The extended graphic state, to supplement original graphic state.
FileAttachment	A file attachment. Any file can be attached to the PDF document.
FileSpecification	Refers to the location of a PDF file within a file system.
FlattenTransparencyParams	Represents control parameters for flattening transparencies within a PDF file.
Font	Represents a font. Defines the typeface, size, style (bold, italic), Unicode values, and other details.
Form	Represents a PDF form XObject.
FormsExtensionVersionRec	Structure to hold the version number retrieved by GetFormsExtensionVersion()
FreeTextAnnotation	The free text annotation allows a user to place text directly on a PDF page.
Function	A function is a process.
GoToAction	A go-to action can be executed in a PDF document.
GraphicState	The graphic state is an internal data structure in a PDF file.
Group	A set of elements to be used within a PDF document.
HighlightAnnotation	Allows the user to highlight text appearing on a PDF page.
ICCBasedColorSpace	Works with the ICC color space.
Image	An image resource can either be an image XObject or inline image found in a page's content stream.
ImageCollection	An image collection can hold multiple images, created from an image file.
ImageData	A class representing the decompressed Image Data.
ImageSaveParams	Class that defines parameters for saving an image to a graphics file.
IndexedColorSpace	Indexed color spaces are used to reduce the amount of memory used for processing images.
Ink	The ink object represents the color in the color space, CYMK or RGB.
InkAnnotation	A type of annotation allowing a user to edit a PDF document.
LabColorSpace	A Lab color space is a CIE-based ABC color space with two transformation stages.
LanguageSetting	Specify a language, along with any metadata about that language.
LaunchAction	A launch action launches an application or opens or prints a document.
Library	Used to create a new instance of a library object or change properties.
LineAnnotation	The line annotation displays a single straight line on a PDF page.
LineTo	A lineto operator, which draws a straight line.
LinkAnnotation	A link annotation, which features an embedded hyperlink.
LogParams	Defines the parameters for writing error messages to a log file.
Matrix	A transformation matrix in a PDF file is specified by six numbers.
MoveTo	An operator that creates a path by moving to a new current position.
NamedColorSpace	Class used to define the color space in use.
NamedFunction	Defines a function currently in use.
NameTree	The name tree is a common data structure in PDF files.
NumberTree	The number tree is a common data structure in PDF files.
OCREngine	Represents an OCR Engine and its configuration.
OCRParams
OptionalContentConfig	A structure used to store data related to layers in a PDF.
OptionalContentContext	Defines the context for optional content in a PDF.
OptionalContentGroup	A dictionary used to manage graphics images in a PDF.
OptionalContentMembershipDict	Attaches content to one or more optional content groups.
OptionalContentOrderArray	Array node class for items in the OptionalContentConfig Order array.
OptionalContentOrderLeaf	Leaf node class for items in the OptionalContentConfig Order array.
OptionalContentOrderNode	Base class for items in the OptionalContentConfig Order array.
Page	Represents a page within a PDF file.
PageImageParams	Used to manage converting a PDF page to an image.
PageLabel	Describes numbering labels for a range of pages.
PageRange	Specifies a range of pages in a document (page numbers begin with 0).
PaperSource	Defines a set of paper trays in a printer that can be used to select the paper source when printing.
Path	A path in a PDF file defines shapes.
Pattern	A pattern is used to fill an area to be painted.
PDFAConvertParams	Parameters for converting a document to PDF/A compliance.
PDFAConvertResult	Return the PDF/A compliant version of the document.
PDFArray	Represents an array of data elements within a PDF document.
PDFBoolean	Represents a boolean data element within a PDF document.
PDFDict	Represents an associative collection of data elements within a PDF document.
PDFInteger	Represents an integer data element within a PDF document.
PDFName	Represents a name data element within a PDF document.
PDFObject	Represents the underlying simple data element of an object in a PDF document.
PDFObjectEnumProc	Represents callback function for Document::EnumIndirectPDFObjects & PDFObject::Enum.
PDFOptimizer	Implementation of the PDF Optimizer function.
PDFReal	Represents a floating point data element within a PDF document.
PDFStream	Represents a stream of data within a PDF document.
PDFString	Represents an array of unsigned bytes within a PDF document.
PDFXConvertParams	Parameters for converting a document to PDF/X compliance.
PDFXConvertResult	Return the PDF/X compliant version of the document.
Point	Represents a discrete point or space in a PDF.
PolygonAnnotation	A polygon is a closed plane figure bounded by a finite number of line segments.
PolyLineAnnotation	A finite number of line segments in a PDF added as an annotation.
PostScript	An XObject stream with the subtype PostScript.
PostScriptCalculatorFunction	A function represented as a stream containing code written in a small subset of the PostScript language.
PrintCancelProc	Print cancellation callback function, a class used to cancel print operations.
PrintParams	Print settings, primarily used for PostScript printers or output.
PrintProgressProc	Print progress callback function, a class used to notify print client of the progress during print operations.
PrintUserParams	A structure used to set parameters for print jobs.
ProgressMonitor	Represents the progress of an operation.
Quad	Represents a quadrilateral in a program.
Rect	A rect holds four coordinates for a rectangle.
RectSegment	A rectangle path operator.
Redaction	Associates an object with its location on a page of a PDF document.
RemoteDestination	A view of a page contained in a separate document.
RemoteGoToAction	A remote go-to action is an action that includes a RemoteDestination object.
RenderProgressProc	Render progress callback function, a class used to notify client of the progress during rendering operations.
ReportProc	Represents the error reporting callback function.
RolledBackDocument	A class representing a Rolled back instance of a PDF document that was previously saved Incrementally.
Segment	Represents a segment, or a single line, within a path.
SeparationColorSpace	Defines the use of additional named colorants in a PDF document.
SeparationParams	Holds parameters for making color separations. Used with PostScript.
SeparationPlate	Represents a plate for making print separations. Used with PostScript.
Shading	Represents a region shaded with color, as defined by a shading dictionary.
ShadingPattern	A shading pattern consists of a smoothly varying gradient between two colors.
SquareAnnotation	The square annotation allows a user to display a rectangle on a PDF page.
Style	Provides access to data about fonts, font sizes, and colors used in a word.
StyleTransition	Represents a style change in a word.
Text	A container that represents a series of text elements and characters.
TextMarkupAnnotation	Annotations that appears as highlighted content when added to a PDF file.
TextRun	Represents one or more contiguous characters in a text object.
TextState	The text state includes parameters that affect text.
UnderlineAnnotation	A type of text markup annotation, for underlining text.
URIAction	A text string, typically a hyperlink.
ViewDestination	Represents a particular view of a page in a document.
WatermarkParams	Watermark settings control the appearance of a watermark in a PDF.
WatermarkTextParams	Watermark settings to control the appearance of text in a text-based watermark.
Word	A word in a PDF file.
WordFinder	A class used to extract words from a document.
WordFinderConfig	A word finder configuration that customizes the way the extraction is performed. In the default configuration, all options are false.
WordProc	Callback function class for EnumWords.
XPSConvertParams	Class that works with XPS conversion parameters.

Enum Summary

Enum	Description
AcroFormExportType
AcroFormImportType
AddPageFlags
AnnotationFlags
BlendMode	The blend mode used for painting objects.
BookmarkFlags
CollectionSplitType
CollectionViewType
ColorConvertActionType
ColorConvertCSpaceType
ColorConvertObjAttrs
ColorProfile
CompressImageType	Enumerator to allow the selection of image type to Set the values for resampling and recompression.
CompressionCode	Compression values for generating graphics files from PDF pages.
CompressionType	Enumerator used to select type of compression used when images are recompressed.
CompressQuality	Establish the compression quality to be used in compression schemas that allow variable quality.
DrawFlags
Duplex	Duplex values.
ElementCloneFlags
EmbedFlags
EncryptionType
FarEastFont	CJK font related option for PostScript printing.
FlattenerColorCompression	Enumeration for setting the compression scheme for the Flattened Color images.
FlattenerGrayCompression	Enumeration for setting the compression scheme for the Flattened Grayscale images.
FlattenerMonoCompression	Enumeration for setting the compression scheme for the Flattened Monochrome images.
FlattenerQualitySetting	Enumeration for setting the Quality setting for the JPEG or JPEG2000 images.
FontCreateFlags	Flags for creating fonts.
FontFlags	Defining bit masks for the font flags
FontRescanFlags
HighlightStyle
HorizontalAlignment
ImageType
Inclusion	Specifies how to include a resource in a file.
InkTypes
Language	Languages which may be selected.
LibraryFlags	Flags for initializing the library.
LineCap	The line cap style specifies the shape to be used at the ends of open subpaths (and dashes, if any) when they are stroked.
LineEndingStyle
LineJoin	The line join style specifies the shape to be used at the corners of paths that are stroked.
LogOutputFlags
MirrorOptions
NumberStyle
ObjectCompressionType	Enumerator to allow the selection of object compression type to Set the values for object compression type.
OptimizerOption	Select the optimization option to be set or obtained.
OptionalContentBaseState
OptionalContentDrawingPolicy	The policy for drawing optional content within the document.
OutputType	Specifies what kind of file to emit.
OverprintMode	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.
PageDeleteFlags
PageInsertFlags
PageMarkFlags	Bit flags indicating which page marks are emitted for color separations.
PageMode	An enumerated data type used to describe the page view mode of a Document.
PageRenderWarning
PageRotation
PageSegmentationMode	Specify how the OCR engine will view the page, and how it detects text segments.
PageSpec	Page range specifications
PageTilingMode	PageTilingMode
PathOperators
PathPaintOpFlags
PDDocFormsType
PDETextFlags
PDFAConvertType
PDFlattenerColorCompSet	Enumeration for setting the compression scheme for the Flattened Color images.
PDFlattenerGrayscaleCompSet	Enumeration for setting the compression scheme for the Flattened Grayscale images.
PDFlattenerMonochromeCompSet	Enumeration for setting the compression scheme for the Flattened Monochrome images.
PDFlattenerQualitySetting	Enumeration for setting the Quality setting for the JPEG or JPEG2000 images.
PDFObjectComparison	Comparisons between two PDFObjects.
PDFOptimizationCompressQuality
PDFOptimizerCompressImageType
PDFOptimizerCompressionType
PDFOptimizerObjectCompressionType
PDFOptimizerOption
PDFProcessorPDFAConversionOption
PDFProcessorPDFXConversionOption
PDFStreamOpenMode
PDFXConvertType
Performance	Specify the performance of the OCR engine in an abstract way.
PermissionFlags
PermissionRequestOperation
PrintProgressStage
PrintWhat	What portions of the document to print
PrintWhatAnnotFlags	Which annotations to print
RenderIntent
RenderProgressStage
ReportType	Type codes used for error reporting.
SaveFlags
SchemaFieldSubtype
SeparationFontOptions
SeparationPreviewOptions
SmoothFlags
TempStoreType
TextFlags
TextRenderMode	Text rendering mode determines whether text shown will have glyph outlines stroked, filled, used as a clipping path boundary, or feature some combination of those three values.
TIFFByteOrder	TIFF Byte Order values describing the byte order used within a file.
VerticalAlignment	Specification of vertical alignment options.
VisibilityPolicy
WatermarkDrawOption
WordAttributeFlags	Flags returned by Word::GetAttributes.
WordFinderVersion	This refers to versions of the WordFinder algorithm.
WritingMode	The direction of writing
XFAFormExportType

Exception Summary

Exception	Description
LibraryException	Exception thrown when there is an error processing a Library call.