Enumerations

All enumerations in Modern C++ API

datalogics_interface

AcroFormExportType

AcroForm Data Export types.

AcroFormImportType

AcroForm Data Import types.

AddPageFlags

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

AFRelationship

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

AnnotationFlags

Bitfield flags controlling the display and behavior of annotations.

HorizontalAlignment

Specifies horizontal alignment (quadding) for text layout.

LineEndingStyle

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

BlendMode

The blend mode used for painting objects.

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.

LineJoin

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

RenderIntent

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

BookmarkFlags

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

ElementType

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

CollectionSplitType

Controls how the navigator and preview panes are arranged when displaying a PDF collection.

CollectionViewType

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

ColorConvertActionType

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

ColorConvertObjAttrs

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

ColorConvertSpaceType

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

ColorProfile

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

CompressionCode

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

CredentialDataFormat

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

CredentialStorageFormat

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

DigestCategory

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

DisplayTraits

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

PageRotation

Used by Page.Rotation to get or set the display and print rotation of a page.

DrawFlags

These flags can be OR'd together to control various rendering behaviors.

SmoothFlags

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

ElementCloneFlags

Flags that control how an Element is cloned.

FontCreateFlags

Flags for creating fonts.

FontFlags

Font descriptor flags.

EncryptionType

Encryption types for securing a PDF document.

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.

HighlightStyle

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

ImageType

Specifies the format of the raster image file to import or export.

InkType

Specifies the ink type used for trapping purposes.

LibraryFlags

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

LogOutputFlags

Multiple flags can be combined using bitwise OR to send log output to more than one destination simultaneously.

MirrorOption

Options for mirroring output in the PostScript stream.

NumberStyle

Specifies the numbering style for page labels in a document.

OCDrawingPolicy

The policy for drawing optional content within the document.

OCRLanguage

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

OCRMissingFontStrategy

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

OCRPageSegmentationMode

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

OCRPerformance

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

OptimizerCompressionType

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

OptimizerCompressQuality

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

OptimizerImageType

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

OptimizerObjectCompression

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

These values determine the default ON/OFF state applied to optional content groups when an OptionalContentConfig is used to initialize an OptionalContentContext.

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.

PageMode

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

PageInsertFlags

Insertion flags used by InsertPages().

PageMarkFlags

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

PageSpec

Specifies which pages a watermark targets.

PathPaintOp

These flags control whether a path is stroked, filled, or both, and which fill rule is used.

PDFAConvertType

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

PDFObjectType

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

PDFXConvertType

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

PermissionFlags

Permissions mask, for Save.

PermissionRequestOperation

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

QRErrorCorrectionLevel

The Error Correction Level of the QR Code.

SaveFlags

Flags for saving documents.

SchemaFieldSubtype

The data type of a collection schema field.

SeparationFontOption

Options controlling how fonts are emitted in separation output.

SeparationPreviewOption

Specifies how a colorant is handled during a separation preview.

SignatureFieldID

Digital signature field options.

SignatureType

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

StructKidType

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

TempStoreType

Controls whether temporary files are stored on disk or in memory.

TextFlags

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

TextRenderMode

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

TIFFByteOrder

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

VerticalAlignment

Specification of vertical alignment options.

VisibilityPolicy

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

WatermarkDrawOption

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

WordFinderVersion

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

WordAttributeFlags

Flags returned by Word::GetAttributes.

WritingMode

Writing direction for text.

XFAFormExportType

XFA Form Data Export types.