Opait.Pdf.Api Namespace Reference

Classes
class	CieHelper
class	ColorUtil
	Utility class for color conversion.
class	ExtGState
	Class defines extended graphics state parameters dictionary. Some of these, like line width and line cap, can also be set by regular graphics state operators. The only operations for which we use extended graphics state are: /CA - The alpha constant for stroking operations [0 - 1] => [transparent-opaque]. /ca - The alpha constant for non-stroking operations [0 - 1] => [transparent-opaque]. /BM - The current blend mode to be used in the transparent imaging model.
class	GdiUtil
	Utility functions using GDI classes More...
interface	IPdfConverter
	An interface for converting to/from PDF implemented by optional plugins. More...
class	PdfAxialShading
	Type 2 (axial) shadings define a color blend that varies along a linear axis between two endpoints and extends indefinitely perpendicular to that axis.
class	PdfBezier
	Represents a double precision cubic PdfBezier spline curve. More...
class	PdfBlend
class	PdfColor
	Class defines a PDF color value. More...
class	PdfColorSpace
	4.5.2 Color Space Families: Color spaces can be classified into color space families. Spaces within a family share the same general characteristics; they are distinguished by parameter values supplied at the time the space is specified. The families fall into three broad categories:
class	PdfColorSpaceCalGray
	A CalGray color space (PDF 1.1) 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. Color values in a CIE-based A space have a single component, arbitrarily named A.
class	PdfColorSpaceCalRgb
	A CalRGB color space 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.
class	PdfColorSpaceDeviceCmyk
	DeviceCMYK controls the concentrations of cyan, magenta, yellow, and black inks, the four subtractive process colors used in printing. Each component is specified by a number in the range 0.0 to 1.0, where 0.0 denotes the complete absence of a process colorant (absorbs none of the corresponding additive primary) and 1.0 denotes maximum concentration (absorbs as much as possible of the additive primary). Note that the sense of these numbers is opposite to that of RGB color components.
class	PdfColorSpaceDeviceGray
	DeviceGray controls the intensity of achromatic light, on a scale from black to white. Black, white, and intermediate shades of gray are special cases of full color. A grayscale value is represented by a single number in the range 0.0 to 1.0, where 0.0 corresponds to black, 1.0 to white, and intermediate values to different gray levels.
class	PdfColorSpaceDeviceN
	DeviceN color spaces (PDF 1.3) can contain an arbitrary number of color components. They can represent high fidelity or multitone colors such as PANTONE.
class	PdfColorSpaceDeviceRgb
	DeviceRGB controls the intensities of red, green, and blue light, the three additive primary colors used in displays. Each component is specified by a number in the range 0.0 to 1.0, where 0.0 denotes the complete absence of a primary component and 1.0 denotes maximum intensity.
class	PdfColorSpaceIccBased
	ICCBased color spaces (PDF 1.3) are based on a cross-platform color profile as defined by the International Color Consortium (ICC). Unlike the CalGray, CalRGB, and Lab color spaces, which are characterized by entries in the color space dictionary, an ICCBased color space is characterized by a sequence of bytes in a standard format.
class	PdfColorSpaceIndexed
	An Indexed color space allows a PDF content stream to use small integers as indices into a color map or color table of arbitrary colors in some other space. A PDF consumer application treats each sample value as an index into the color table and uses the color value it finds there. An Indexed color space is defined by a four-element array: [ /Indexed base hival lookup ]
class	PdfColorSpaceLab
	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 entry in the color space dictionary.
class	PdfColorSpacePattern
	A Pattern color space (PDF 1.2) enables a PDF content stream to paint an area with a pattern rather than a single color. The pattern may be either a tiling pattern(type 1) or a shading pattern (type 2).
class	PdfColorSpaceSeparation
	A Separation color space (PDF 1.2) provides a means for specifying the use of additional colorants or for isolating the control of individual color components of a device color space for a subtractive device. When such a space is the current color space, the current color is a single- component value, called a tint, that controls the application of the given colorant or color components only.
class	PdfCoonsShading
	Type 6 shadings (Coons patch meshes) are constructed from one or more color patches, each bounded by four cubic Bézier curves.
class	PdfDate
	Utility class to handle PDF formatted dates. More...
class	PdfExponentialFunction
	Exponential (type 2) functions (PDF 1.3) include a set of parameters that define an exponential interpolation of one input value and n output values.
class	PdfForm
	A form XObject is a PDF content stream that is a self-contained description of any sequence of graphics objects (including path objects, text objects, and sampled images). More...
class	PdfFunction
	PDF provides several types of function objects (PDF 1.2) 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.
class	PdfFunctionShading
	In type 1 (function-based) shadings, the color at every point in the domain is defined by a specified mathematical function. The function need not be smooth or continuous.
class	PdfGouraudShading
	Type 4 shadings (free-form Gouraud-shaded triangle meshes) 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.
class	PdfIdentityFunction
	A do-nothing function that maps from input to output.
class	PdfImage
	Class represents a multi-page image for embedding in PDF documents. More...
class	PdfImagePage
	Class represents a single image used in PDF documents. More...
class	PdfLatticeShading
	Type 5 shadings (lattice-form Gouraud-shaded triangle meshes) are similar to type 4, but instead of using free-form geometry, their vertices are arranged in a pseudorectangular lattice, which is topologically equivalent to a rectangular grid.
class	PdfMatrix
	Represents a double precision 3x3 affine transformation matrix. An affine matrix can be represented by 6 numbers in the first two columns. [A, C, 0] [B, D, 0] [E, F, 1] More...
class	PdfOptions
	Defines various PDF options. More...
class	PdfPatchShading
	Base class form patch shading (types 4, 5, 6, 7).
class	PdfPattern
	When operators such as S (stroke), f (fill), and Tj (show text) paint an area of the page with the current color, they ordinarily apply a single color that covers the area uniformly. However, it is also possible to apply “paint” that consists of a repeating graphical figure or a smoothly varying color gradient instead of a simple color. Such a repeating figure or smooth gradient is called a pattern. Patterns come in two varieties: Tiling patterns and Shading patterns.
class	PdfPoint
	Represents an ordered pair of x and y coordinates that defines a point in a PDF two-dimensional plane. More...
class	PdfPostscriptFunction
	Postscript calculator (type 4) function (PDF 1.3), is represented as a stream containing code written in a small subset of the PostScript language.
class	PdfQuadPoints
	Class represents a quadrilateral shape in PDF world coordinates. More...
class	PdfRadialShading
	Type 3 (radial) shadings define a color blend that varies between two circles. Shadings of this type are commonly used to depict three- dimensional spheres and cones.
class	PdfRectangle
	Class represents a rectangular region in PDF world coordinates. The rectangle is kept normalized. More...
class	PdfSamplingFunction
	Sampled (type 0) functions use a sequence of sample values (contained in a stream) to provide an approximation for functions whose domains and ranges are bounded. The samples are organized as an m-dimensional table in which each entry has n-components.
class	PdfShading
	A shading dictionary specifies details of a particular gradient fill, including the type of shading to be used, the geometry of the area to be shaded, and the geometry of the gradient fill.
class	PdfShadingPattern
	Shading patterns define a gradient fill that produces a smooth transition between colors across the area. The color to use is specified as a function of position using any of a variety of methods.
class	PdfSize
	The class represents a size in PDF world coordinates. More...
class	PdfStitchingFunction
	Stitching (type 3) functions (PDF 1.3) define a stitching of the subdomains of several 1-input functions to produce a single new 1-input function.
class	PdfTensorShading
	Type 7 shadings (tensor-product patch meshes) are identical to type 6, 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.
class	PdfTextOptions
	Class represents the set of options that control the conversion of text files to PDF documents. More...
class	PdfTilingPattern
	Tiling patterns consist of a small graphical figure (called a pattern cell) that is replicated at fixed horizontal and vertical intervals to fill the area to be painted. The graphics objects to use for tiling are described by a content stream.

Enumerations
enum	BinarizationMethod { FixedThreshold , StandardOtsu , AdaptiveOtsu }
	Binarization methods when converting images from grayscale to black-and-white. More...
enum	BlendMode {   Unknown , Color , ColorBurn , ColorDodge ,   Darken , Difference , Exclusion , HardLight ,   Hue , Lighten , Luminosity , Multiply ,   Normal , Overlay , Saturation , Screen ,   SoftLight }
	Blend modes are named functions used in compositing formulas to control the blending operation. More...
enum	ImageCompression {   None , Flate , Jpeg , CcittG3 ,   CcittG3F , CcittG3F2 , CcittG4 , Rle ,   Lzw , Jbig2 , Jpeg2000 , Default }
	Image compression methods. More...
enum	LayoutMode {   SinglePage , OneColumn , TwoColumnLeft , TwoColumnRight ,   TwoPageLeft , TwoPageRight }
	Page layout mode to be used when the document is opened. More...
enum	PdfActionType {   Unknown , GoTo , GoToR , GoToE ,   Launch , Thread , URI , Sound ,   Movie , Hide , Named , SubmitForm ,   ResetForm , ImportData , JavaScript , SetOCGState ,   Rendition , Trans , GoTo3DView }
	Standard PDF action types More...
enum	PdfAnnotAppearance { Normal , Rollover , Down }
	An annotation can define as many as three separate appearances. More...
enum	PdfAnnotBorder {   Solid , Dashed , Beveled , Inset ,   Underline }
	Annotation border styles defined by the S entry in the border style (BS) dictionary. More...
enum	PdfAnnotFlags {   None = 0x0000 , Invisible = 0x0001 , Hidden = 0x0002 , Print = 0x0004 ,   NoZoom = 0x0008 , NoRotate = 0x0010 , NoView = 0x0020 , ReadOnly = 0x0040 ,   Locked = 0x0080 , ToggleNoView = 0x0100 , LockedContents = 0x0200 }
	Annotation Flags: the value of the annotation dictionary’s F entry is an unsigned 32-bit integer containing flags specifying various characteristics of the annotation. More...
enum	PdfAnnotState {   Marked , Unmarked , Accepted , Rejected ,   Canceled , Comleted , None }
	Annotations can have author-specific state associated with them. More...
enum	PdfAnnotType {   Unknown , Text , Link , FreeText ,   Line , Square , Circle , Polygon ,   PolyLine , Highlight , Underline , Squiggly ,   Strikeout , Stamp , Caret , Ink ,   Popup , FileAttachment , Sound , Movie ,   Screen , Widget , PrinterMark , TrapNet ,   Watermark , ThreeD , Redact }
	The type of annotations that can appear on a PDF page. More...
enum	PdfBookmarkStyle { Regular = 0 , Italic = 1 , Bold = 2 , BoldItalic = 3 }
	Font display styles for bookmark (outline) text. More...
enum	PdfDestType {   Xyz , Fit , FitH , FitV ,   FitR , FitB , FitBh , FitBv }
	PDF destinations may be associated with outline items, annotations, or actions. A destination defines a particular view of a document, consisting of the following items: • 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 The following types of destinations are defined: More...
enum	PdfEncryptionAlgorithm { None , RC4 , AES }
	The following algorithms are used when encrypting data in a PDF file: More...
enum	PdfFilterType {   None , AsciiHexDecode , Ascii85Decode , LzwDecode ,   FlateDecode , RunLengthDecode , CcittFaxDecode , Jbig2Decode ,   DctDecode , JpxDecode , Crypt }
	PDF stream and image compression filters. More...
enum	PdfFontStyle {   Regular = 0 , Bold = 1 , Italic = 2 , Underline = 4 ,   Strikeout = 8 }
	Specifies style information applied to text. More...
enum	PdfFontType {   Link , Subset , Embed , Base14 ,   Glyphless }
	Enumerates options for linking or embedding fonts when generating PDF files. More...
enum	PdfInfoField {   Title , Author , Subject , Keywords ,   Creator , Producer , CreationDate , ModDate ,   Trapped }
	Entries in the document information dictionary. More...
enum	PdfLineCap { Flat = 0 , Round = 1 , Square = 2 }
	Line cap style in the graphics state (table 4.4) More...
enum	PdfLineJoin { Miter = 0 , Round = 1 , Bevel = 2 }
	Specifies how to join consecutive line or curve segments in a figure or subpath (table 4.5). More...
enum	PdfPageMode {   UseNone = 0 , UseOutlines = 1 , UseThumbs = 2 , FullScreen = 3 ,   UseOC = 4 , UseAttachments = 5 }
	PDF page mode when the document is first displayed. More...
enum	PdfPageSize {   A0 = (2380 << 16) + 3368 , A1 = (1684 << 16) + 2380 , A2 = (1190 << 16) + 1684 , A3 = (842 << 16) + 1190 ,   A4 = (595 << 16) + 842 , A5 = (421 << 16) + 595 , A6 = (297 << 16) + 421 , B5 = (501 << 16) + 709 ,   Letter = (612 << 16) + 792 , Legal = (612 << 16) + 1008 , Ledger = (1224 << 16) + 792 , Tabloid = (1224 << 16) + 792 }
	Common PDF page sizes. Page width/height are in the high/low word. More...
enum	PdfPixelFormat {   Automatic , Color , Grayscale , Dithered ,   Threshold }
	Enumerates pixel formats when PDF pages are converted to images. More...
enum	PdfRendering {   Fill , Stroke , FillStroke , Hide ,   FillClip , StrokeClip , FillStrokeClip , Clip }
	PDF text rendering modes. More...
enum	PdfSaveFormat {   VectorPdf , RasterPdf , SearchablePdf , TextPdf ,   Tiff , Png , Jpeg , Text }
	Options used when a PDF document is saved as a new file. More...
enum	PdfVersion {   Unknown = 0 , Version10 = 10 , Version11 = 11 , Version12 = 12 ,   Version13 = 13 , Version14 = 14 , Version15 = 15 , Version16 = 16 ,   Version17 = 17 }
	Supported PDF file versions: 14 for 1.4, 15 for 1.5, etc. More...
enum	TiffSaveFormat {   CcittG4 , CcittDitheredG4 , GrayscalePng , ColorPng ,   ColorJpeg }
	Compression formats for TIFF or rasterized PDF pages. More...

Enumeration Type Documentation

BinarizationMethod

enum Opait.Pdf.Api.BinarizationMethod

Binarization methods when converting images from grayscale to black-and-white.

Enumerator
FixedThreshold	Use a single fixed threshold.
StandardOtsu	Dynamically compute a single threshold using standard OTSU method.
AdaptiveOtsu	Compute adaptive OTSU thresholds for tiled regions of the image.

BlendMode

enum Opait.Pdf.Api.BlendMode

Blend modes are named functions used in compositing formulas to control the blending operation.

Enumerator
Unknown	The blending mode is unknown or invalid.
Color	Creates a color with the hue and saturation of the source color and the luminosity of the backdrop color. This preserves the gray levels of the backdrop and is useful for coloring monochrome images or tinting color images.
ColorBurn	Darkens the backdrop color to reflect the source color.
ColorDodge	Brightens the backdrop color to reflect the source color.
Darken	Selects the darker of the backdrop and source colors
Difference	Subtracts the darker of the two constituent colors from the lighter color.
Exclusion	Produces an effect similar to that of the |Difference| mode but lower in contrast.
HardLight	Multiplies or screens the colors, depending on the source color value. The effect is similar to shining a harsh spotlight on the backdrop.
Hue	Creates a color with the hue of the source color and the saturation and luminosity of the backdrop color.
Lighten	Selects the lighter of the backdrop and source colors.
Luminosity	Creates a color with the luminosity of the source color and the hue and saturation of the backdrop color. This produces an inverse effect to that of the |Color| mode.
Multiply	Multiplies the backdrop and source color values.
Normal	Selects the source color, ignoring the backdrop.
Overlay	Multiplies or screens the colors, depending on the backdrop color value. Source colors overlay the backdrop while preserving its highlights and shadows. The backdrop color is not replaced but is mixed with the source color to reflect the lightness or darkness of the backdrop.
Saturation	Creates a color with the saturation of the source color and the hue and luminosity of the backdrop color.
Screen	Multiplies the complements of the backdrop and source color values, then complements the result.
SoftLight	Darkens or lightens the colors, depending on the source color value. The effect is similar to shining a diffused spotlight on the backdrop.

ImageCompression

enum Opait.Pdf.Api.ImageCompression

Image compression methods.

Enumerator
None	Image is not compressed.
Flate	Flate compression as in PNG files.
Jpeg	JPEG compression using DCT (discrete cosine transform).
CcittG3	CCITT compression group 3 for monochrome images stored in TIFF files.
CcittG3F	CCITT compression group 3 fax for monochrome images stored in TIFF files.
CcittG3F2	CCITT compression group 3 fax with mixed 1 and 2 dimensional encoding.
CcittG4	CCITT compression group 4 for monochrome images stored in TIFF files.
Rle	Run length encoding used in bitmap files.
Lzw	LZW compression as in GIF images. Read-only access, use Flate for new images.
Jbig2	JBIG2 compression for monochrome images.
Jpeg2000	JPEG2000 compression as in JPX files.
Default	Let the library decide the best algorithm.

LayoutMode

enum Opait.Pdf.Api.LayoutMode

Page layout mode to be used when the document is opened.

Enumerator
SinglePage	Display one page at a time. This is the default layout.
OneColumn	Display the pages in one column.
TwoColumnLeft	Display the pages in two columns, with odd-numbered pages on the left.
TwoColumnRight	Display the pages in two columns, with odd-numbered pages on the right.
TwoPageLeft	Display the pages two at a time, with odd-numbered pages on the left.
TwoPageRight	Display the pages two at a time, with odd-numbered pages on the right.

PdfActionType

enum Opait.Pdf.Api.PdfActionType

Standard PDF action types

Enumerator
Unknown	Catches all unknown action.
GoTo	Goes to a destination in the current document.
GoToR	Goes to a destination in another document.
GoToE	Goes to a destination in an embedded file.
Launch	Launches an application, usually to open a file.
Thread	Begins reading an article thread.
URI	Resolves a uniform resource identifier.
Sound	Plays a sound.
Movie	Plays a movie.
Hide	Sets an annotation's hidden flag.
Named	Executes a predefined named action.
SubmitForm	Sends data to a uniform resource locator.
ResetForm	Sets all fields to their default values.
ImportData	Imports field values from a file.
JavaScript	Executes a JavaScript script.
SetOCGState	Sets the states of optional content groups.
Rendition	Controls the playing of multimedia content.
Trans	Updates the display of a document, using a transition dictionary.
GoTo3DView	Sets the current view of a 3D annotation.

PdfAnnotAppearance

enum Opait.Pdf.Api.PdfAnnotAppearance

An annotation can define as many as three separate appearances.

Enumerator
Normal	The normal appearance is used when the annotation is not interacting with the user. This appearance is also used for printing the annotation.
Rollover	The rollover appearance is used when the user moves the cursor into the annotation’s active area without pressing the mouse button.
Down	The down appearance is used when the mouse button is pressed or held down within the annotation’s active area.

PdfAnnotBorder

enum Opait.Pdf.Api.PdfAnnotBorder

Annotation border styles defined by the S entry in the border style (BS) dictionary.

Enumerator
Solid	A solid rectangle surrounding the annotation.
Dashed	A dashed rectangle surrounding the annotation. The dash pattern is specified by the D entry in the border style dictionary.
Beveled	A simulated embossed rectangle that appears to be raised above the surface of the page.
Inset	A simulated engraved rectangle that appears to be recessed below the surface of the page.
Underline	A single line along the bottom of the annotation rectangle.

PdfAnnotFlags

enum Opait.Pdf.Api.PdfAnnotFlags

Annotation Flags: the value of the annotation dictionary’s F entry is an unsigned 32-bit integer containing flags specifying various characteristics of the annotation.

Enumerator
None	No flags set.
Invisible	If set, do not display the annotation if it does not belong to one of the standard annotation types and no annotation handler is available. If clear, display such an unknown annotation using an appearance stream specified by its appearance dictionary, if any.
Hidden	If set, do not display or print the annotation or allow it to interact with the user, regardless of its annotation type or whether an annotation handler is available.
Print	If set, print the annotation when the page is printed. If clear, never print the annotation, regardless of whether it is displayed on the screen.
NoZoom	If set, do not scale the annotation’s appearance to match the magnification of the page. The location of the annotation on the page (defined by the upper-left corner of its annotation rectangle) remains fixed, regardless of the page magnification.
NoRotate	If set, do not rotate the annotation’s appearance to match the rotation of the page. The upper-left corner of the annotation rectangle remains in a fixed location on the page, regardless of the page rotation.
NoView	If set, do not display the annotation on the screen or allow it to interact with the user. The annotation may be printed (depending on the setting of the Print flag) but should be considered hidden for purposes of on-screen display and user interaction.
ReadOnly	If set, do not allow the annotation to interact with the user. The annotation may be displayed or printed (depending on the settings of the NoView and Print flags) but should not respond to mouse clicks or change its appearance in response to mouse motions.
Locked	If set, do not allow the annotation to be deleted or its properties (including position and size) to be modified by the user. However, this flag does not restrict changes to the annotation’s contents, such as the value of a form field.
ToggleNoView	If set, invert the interpretation of the NoView flag for certain events. A typical use is to have an annotation that appears only when a mouse cursor is held over it
LockedContents	If set, do not allow the contents of the annotation to be modified by the user. This flag does not restrict deletion of the annotation or changes to other annotation properties, such as position and size.

PdfAnnotState

enum Opait.Pdf.Api.PdfAnnotState

Annotations can have author-specific state associated with them.

Enumerator
Marked	The annotation has been marked by the user.
Unmarked	The annotation has not been marked by the user.
Accepted	The user agrees with the change.
Rejected	The user disagrees with the change.
Canceled	The change has been canceled.
Comleted	The change has been completed.
None	The user has indicated nothing about the change.

PdfAnnotType

enum Opait.Pdf.Api.PdfAnnotType

The type of annotations that can appear on a PDF page.

Enumerator
Unknown	The type of the annotation is unknown.
Text	A text annotation represents a “sticky note” attached to a point in the PDF document. When closed, the annotation appears as an icon; when open, it displays a pop-up window containing the text of the note in a font and size chosen by the viewer application.
Link	A link annotation represents either a hypertext link to a destination elsewhere in the document or an action to be performed.
FreeText	A free text annotation (PDF 1.3) displays text directly on the page. Unlike an ordinary text annotation, a free text annotation has no open or closed state; instead of being displayed in a pop-up window, the text is always visible.
Line	A line annotation displays a single straight line on the page. When opened, it displays a pop-up window containing the text of the associated note.
Square	A square annotations display a rectangle on the page. When opened, it displays a pop-up window containing the text of the associated note.
Circle	A circle annotations display an ellipse on the page. When opened, it displays a pop-up window containing the text of the associated note.
Polygon	A polygon annotations displaya a closed polygon on the page. Such polygons may have any number of vertices connected by straight lines.
PolyLine	A polygon annotations displaya a polygon on the page, with any number of vertices connected by straight lines. Unlike a polygon annotation, the first and last vertex of a polyline annotation are not implicitly connected.
Highlight	A highlight annotation appeara as a highlighted text in a document. When opened, it displays a pop-up window containing the text of the associated note.
Underline	An underline annotation appeara as an underlined text in a document. When opened, it displays a pop-up window containing the text of the associated note.
Squiggly	A squiggly annotation appeara as a jagged underlined text in a document. When opened, it displays a pop-up window containing the text of the associated note.
Strikeout	A strikeout annotation appeara as a stricked-out text in a document. When opened, it displays a pop-up window containing the text of the associated note.
Stamp	A rubber stamp annotation displays text or graphics intended to look as if they were stamped on the page with a rubber stamp. When opened, it displays a pop-up window containing the text of the associated note.
Caret	A caret annotation is a visual symbol that indicates the presence of text edits.
Ink	An ink annotation represents a freehand “scribble” composed of one or more disjoint paths. When opened, it displays a pop-up window containing the text of the associated note.
Popup	A pop-up annotation displays text in a pop-up window for entry and editing. It typically does not appear alone but is associated with a markup annotation, its parent annotation, and is used for editing the parent’s text.
FileAttachment	A file attachment annotation contains a reference to a file, which typically is embedded in the PDF file.
Sound	A sound annotation is 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. When the annotation is activated, the sound is played.
Movie	A movie annotation contains animated graphics and sound to be presented on the computer screen and through the speakers. When the annotation is activated, the movie is played.
Screen	A screen annotation specifies a region of a page upon which media clips may be played. It also serves as an object from which actions can be triggered.
Widget	A widget annotation is used by interactive forms to represent the appearance of a field and to manage user interactions.
PrinterMark	A printer’s mark annotation represents a graphic symbol, such as a registration target, color bar, or cut mark, added to a page to assist production personnel in identifying components of a multiple-plate job and maintaining consistent output during production.
TrapNet	A trap network annotation defines the trapping characteristics for a page of a PDF document. Trapping is the process of adding marks to a page along color boundaries to avoid unwanted visual artifacts resulting from misregistration of colorants when the page is printed.
Watermark	A watermark annotation is used to represent graphics that are expected to be printed at a fixed size and position on a page, regardless of the dimensions of the printed page.
ThreeD	3D annotations are the means by which 3D artwork is represented in a PDF document.
Redact	A redaction annotation identifies content that is intended to be removed from the document.

PdfBookmarkStyle

enum Opait.Pdf.Api.PdfBookmarkStyle

Font display styles for bookmark (outline) text.

Enumerator
Regular	Regular font style.
Italic	Italic font style.
Bold	Bold font style.
BoldItalic	Bold and italic font style.

PdfDestType

enum Opait.Pdf.Api.PdfDestType

PDF destinations may be associated with outline items, annotations, or actions. A destination defines a particular view of a document, consisting of the following items: • 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 The following types of destinations are defined:

Enumerator
Xyz	Left, Top, Zoom specified.
Fit	Fit the page.
FitH	Fit to width, top specified.
FitV	Fit to height, left specified.
FitR	Fit to rectangle: left, bottom, right, top.
FitB	Fit bounding box to page.
FitBh	Fit bounding box to width, top specified.
FitBv	Fit bounding box to height, left specified.

PdfEncryptionAlgorithm

enum Opait.Pdf.Api.PdfEncryptionAlgorithm

The following algorithms are used when encrypting data in a PDF file:

A proprietary encryption algorithm known as RC4. RC4 is a symmetric stream cipher: the same algorithm is used for both encryption and decryption, and the algorithm does not change the length of the data.

The AES (Advanced Encryption Standard) algorithm (beginning with PDF 1.6). AES is a symmetric block cipher: the same algorithm is used for both encryption and decryption, and the length of the data when encrypted is rounded up to a multiple of the block size, which is fixed in this implementation to always be 16 bytes.

Enumerator
None	Do not encrypt, or let application perform custom encryption.
RC4	RC4 algorithm with 40-bit or 128-bit keys.
AES	AES algorithm with a 128-bit or 256-bit keys.

PdfFilterType

enum Opait.Pdf.Api.PdfFilterType

PDF stream and image compression filters.

Enumerator
None	Data is not filtered.
AsciiHexDecode	Decodes data encoded in an ASCII hexadecimal representation, reproducing the original binary data.
Ascii85Decode	Decodes data encoded in an ASCII base-85 representation, reproducing the original binary data.
LzwDecode	Decompresses data encoded using the LZW (Lempel-Ziv-Welch) adaptive compression method, reproducing the original text or binary data.
FlateDecode	Decompresses data encoded using the zlib/deflate compression method, reproducing the original text or binary data.
RunLengthDecode	Decompresses data encoded using a byte-oriented run-length encoding algorithm, reproducing the original text or binary data (typically monochrome image data, or any data that contains frequent long runs of a single byte value).
CcittFaxDecode	Decompresses data encoded using the CCITT facsimile standard, reproducing the original data (typically monochrome image data at 1 bit per pixel).
Jbig2Decode	Decompresses data encoded using the JBIG2 standard, reproducing the original monochrome (1 bit per pixel) image data (or an approximation of that data).
DctDecode	Decompresses data encoded using a DCT (discrete cosine transform) technique based on the JPEG standard, reproducing image sample data that approximates the original data.
JpxDecode	Decompresses data encoded using the wavelet-based standard, reproducing the original image data.
Crypt	Decrypts data encrypted by a security handler, reproducing the original data as it was before encryption.

PdfFontStyle

enum Opait.Pdf.Api.PdfFontStyle

Specifies style information applied to text.

Flags have the same values as System.Drawing.FontStyle

Enumerator
Regular	Normal text.
Bold	Bold text.
Italic	Italic text.
Underline	Underlined text.
Strikeout	Text with a line through the middle.

PdfFontType

enum Opait.Pdf.Api.PdfFontType

Enumerates options for linking or embedding fonts when generating PDF files.

The PdfFontType.Link member specifies that all fonts should be linked. This option will produce the smallest PDF document because the font program required to render individual glyphs is not embedded in the PDF document.

1. Only characters in the WinAnsi character encoding are supported (i.e. Latin)
2. The PDF document will not render correctly if the linked font is not installed.

The PdfFontType.Subset option will only copy the glyphs that are actually referenced in the PDF document. This option will ensure that a PDF document is rendered correctly on any system, but does incur a slight processing overhead to subset the font.

The PdfFontType.Embed option will copy the contents of the entire font program into the PDF document. This will guarantee correct rendering of the document on any system, however certain fonts - especially CJK fonts - are extremely large.

Enumerator
Link	Link a TrueType font program.
Subset	A subset of a CID font program is embedded.
Embed	Entire CID font program is embedded.
Base14	Use a standard base 14 font.
Glyphless	Use a compact glyph-less CID font for hidden text.

PdfInfoField

enum Opait.Pdf.Api.PdfInfoField

Entries in the document information dictionary.

Enumerator
Title	The document’s title.
Author	The name of the person who created the document.
Subject	The subject of the document.
Keywords	Keywords associated with the document.
Creator	If the document was converted to PDF from another format, the name of the application that created the original document from which it was converted.
Producer	If the document was converted to PDF from another format, the name of the application that converted it to PDF.
CreationDate	The date and time the document was created, in human-readable form.
ModDate	The date and time the document was most recently modified, in human-readable form.
Trapped	A named object indicating whether the document has been modified to include trapping information True: The document has been fully trapped; no further trapping is needed. (This is the name True, not the boolean value true.) False: The document has not yet been trapped; any desired trapping must still be done. (This is the name False, not the boolean value false.) Unknown: Either it is unknown whether the document has been trapped or it has been partly but not yet fully trapped; some additional trapping may still be needed. This is the default. The value of this entry may be set automatically by the software creating the document’s trapping information, or it may be known only to a human operator and entered manually.

PdfLineCap

enum Opait.Pdf.Api.PdfLineCap

Line cap style in the graphics state (table 4.4)

Enumerator
Flat	The stroke is squared off at the endpoint of the path. There is no projection beyond the end of the path.
Round	A semicircular arc with a diameter equal to the line width is drawn around the endpoint and filled in.
Square	The stroke continues beyond the endpoint of the path for a distance equal to half the line width and is squared off.

PdfLineJoin

enum Opait.Pdf.Api.PdfLineJoin

Specifies how to join consecutive line or curve segments in a figure or subpath (table 4.5).

Enumerator
Miter	Specifies a mitered join. This produces a sharp corner or a clipped corner, depending on whether the length of the miter exceeds the miter limit
Round	Specifies a circular join. This produces a smooth, circular arc between the lines.
Bevel	Specifies a beveled join. This produces a diagonal corner.

PdfPageMode

enum Opait.Pdf.Api.PdfPageMode

PDF page mode when the document is first displayed.

Enumerator
UseNone	Neither document outline nor thumbnail images visible.
UseOutlines	Document outline visible.
UseThumbs	Thumbnail images visible
FullScreen	Full-screen mode, with no menu bar or toolbar visible.
UseOC	Optional content group panel visible.
UseAttachments	Attachments panel visible.

PdfPageSize

enum Opait.Pdf.Api.PdfPageSize

Common PDF page sizes. Page width/height are in the high/low word.

Enumerator
A0	A0 size: 841 x 1189 mm.
A1	A1 size: 594 x 841 mm.
A2	A2 size: 420 x 594 mm.
A3	A3 size: 297 x 420 mm.
A4	A4 size: 210 x 297 mm.
A5	A5 size: 148 x 210 mm.
A6	A6 size: 105 x 148 mm.
B5	B5 size: 176 x 250 mm.
Letter	Letter size: 8.5 x 11 inches.
Legal	Legal size: 8.5 x 14 inches.
Ledger	Ledger size: 17 x 11 inches.
Tabloid	Tabloid size: 11 x 17 inches.

PdfPixelFormat

enum Opait.Pdf.Api.PdfPixelFormat

Enumerates pixel formats when PDF pages are converted to images.

Enumerator
Automatic	Automatically determine the color depth.
Color	Digitize in full 24-bit color.
Grayscale	Convert to 8-bit grayscale.
Dithered	Convert to dithered monochrome images.
Threshold	Convert to monochrome images using color thresholding.

PdfRendering

enum Opait.Pdf.Api.PdfRendering

PDF text rendering modes.

Enumerator
Fill	Fill text (default).
Stroke	Stroke text.
FillStroke	Fill then stoke text.
Hide	Neither fill nor stroke text (invisible).
FillClip	Fill text and add to the path for clipping.
StrokeClip	Stroke text and add to the path for clipping.
FillStrokeClip	Fill then stoke text, and add to the path for clipping.
Clip	Add to the path for clipping (invisible).

PdfSaveFormat

enum Opait.Pdf.Api.PdfSaveFormat

Options used when a PDF document is saved as a new file.

Enumerator
VectorPdf	Save as a vector PDF document.
RasterPdf	Rasterize pages and save as an image only PDF file.
SearchablePdf	Save with hidden text placed behind a single visible image per page. Used for image source documents and to redact data.
TextPdf	Format text as PDF pages, including hidden text, and save as a vector PDF files.
Tiff	Rasterize pages and save as a multi-page TIFF file.
Png	Rasterize each page and save as a separate PNG file.
Jpeg	Rasterize each page and save as a separate JPEG file.
Text	Save the text content of the document pages in an ASCII file.

PdfVersion

enum Opait.Pdf.Api.PdfVersion

Supported PDF file versions: 14 for 1.4, 15 for 1.5, etc.

Enumerator
Unknown	PDF file version is unknown.
Version10	PDF file version 1.0
Version11	PDF file version 1.1
Version12	PDF file version 1.2
Version13	PDF file version 1.3
Version14	PDF file version 1.4
Version15	PDF file version 1.5
Version16	PDF file version 1.6
Version17	PDF file version 1.7

TiffSaveFormat

enum Opait.Pdf.Api.TiffSaveFormat

Compression formats for TIFF or rasterized PDF pages.

Enumerator
CcittG4	Monochrome CCITT group 4.
CcittDitheredG4	Dithered CCITT group 4.
GrayscalePng	Grayscale embedded PNG (deflate).
ColorPng	Full color embedded PNG (deflate).
ColorJpeg	Full color embedded JPEG.