FoxitPDFSDKforWeb  v10.0.0
Foxit PDF SDK for Web
constant

Modules

 constant
 

Enumerations

enum  Action_Trigger {
  click =-1, keyStroke =7, format =8, validate =9,
  calculate =10, mouseEnter =11, mouseExit =12, mouseDown =13,
  mouseUp =14, onFocus =15, onBlur =16
}
 Enumeration for action trigger. Values of this enumeration should be used alone. More...
 
enum  Action_Type {
  goto ="TypeGoto", launch ="TypeLaunch", uri ="TypeURI", named ="TypeNamed" ,
  submitForm ="TypeSubmitForm", resetForm ="TypeResetForm", javaScript ="TypeJavaScript", importData ="TypeImportData",
  hide ="TypeHide", gotoE ="TypeGoToE"
}
 Enumeration for action type. Values of this enumeration should be used alone. More...
 
enum  Additional_Permission { download = 1 }
 Enumeration for additional permission. More...
 
enum  Alignment { left, center, right }
 Enumeration for text alignment. Values of this enumeration should be used alone. More...
 
enum  AnnotUpdatedType {
  contentUpdated ="content-updated", borderInfoUpdated ="borderInfo-updated", borderStyleUpdated ="borderStyle-updated", borderWidthUpdated ="borderWidth-updated",
  borderColorUpdated ="borderColor-updated", captionColorUpdated ="captionColor-updated", modifiedDateTimeUpdated ="modifiedDateTime-updated", uniqueIDUpdated ="uniqueID-updated",
  flagsUpdated ="flags-updated", rectUpdated ="rect-updated", innerRectUpdated ="innerRect-updated", iconNameUpdated ="iconName-updated",
  rotationUpdated ="rotation-updated", defaultAppearanceUpdated ="defaultAppearance-updated", calloutLineEndingStyleUpdated ="calloutLineEndingStyle-updated", calloutLinePointsUpdated ="calloutLinePoints-updated",
  fillColorUpdated ="fillColor-updated", textColorUpdated ="textColor-updated", alignmentUpdated ="alignment-updated", inkListUpdated ="inkList-updated",
  endPointUpdated ="endPoint-updated", startPointUpdated ="startPoint-updated", endingStyleUpdated ="endingStyle-updated", enableCaptionUpdated ="enableCaption-updated",
  leaderCaptionOffsetUpdated ="leaderCaptionOffset-updated", styleFillColorUpdated ="styleFillColor-updated", leaderLineLengthUpdated ="leaderLineLength-updated", leaderLineExtendUpdated ="leaderLineExtend-updated",
  leaderLineOffsetUpdated ="leaderLineOffset-updated", measureRatioUpdated ="measureRatio-updated", measureUnitUpdated ="measureUnit-updated", measureConversionFactorUpdated ="measureConversionFactor-updated",
  removeAction ="remove-action", actionDataUpdated ="actionData-updated", addAction ="add-action", moveAction ="move-action",
  highlightingModeUpdated ="highlightingMode-updated", subjectUpdated ="subject-updated", titleUpdated ="title-updated", createDateTimeUpdated ="createDateTime-updated",
  opacityUpdated ="opacity-updated", intentUpdated ="intent-updated", vertexesUpdated ="vertexes-updated", applyFillColorUpdated ="applyFillColor-updated",
  overlayTextUpdated = "overlayText-updated", overlayTexAlignmentUpdated = "overlayTextAlignment-updated", repeatUpdated = "repeat-updated", autoFontSizeUpdated = "autoFontSize-updated",
  redactDefaultAppearanceUpdated = "redactDefaultAppearance-update", redactOpacityUpdated = "redactOpacity-updated", quadPointsUpdated ="quadPoints-updated", reviewStateUpdated = 'review-state-updated',
  markedStateUpdated = 'marked-state-updated', statesCleared = 'state-cleared', replyAdded = 'add-replies', richTextUpdated = 'rich-text-updated',
  richTextRemoved = 'rich-text-removed', addDictionary = 'add-dictionary', imageUpdated ='image-updated', formFieldValueUpdated = 'form-field-value',
  formFieldsMaxLengthUpdated = 'maxLength', formFieldItemsUpdated = 'setItems', formFieldIconUpdated = 'icon', formFieldInsertedItem = 'insertItemAt',
  formFieldExportValueUpdated = 'form-field-export-value', formFieldMKPropertyUpdated = 'form-field-mk-property', formFieldAlternateName = 'form-field-alternate-name', formFieldMappingName = 'form-field-mapping-name',
  formFieldActionUpdated = 'form-field-action'
}
 The type of the annot attribute update. More...
 
enum  Border_Style {
  solid = 0, dashed = 1, underline = 2, beveled = 3,
  inset = 4, cloudy = 5, noBorder = 6
}
 Enumeration for border style. Values of this enumeration should be used alone. More...
 
enum  Box_Type {
  MediaBox = 0, CropBox = 1, TrimBox = 2, ArtBox = 3,
  BleedBox = 4
}
 Enumeration for page box type. More...
 
enum  Calc_Margin_Mode { CalcContentsBox =0, CalcDetection =1 }
 Enumeration for calculating margin mode. More...
 
enum  Cipher_Type { cipherNone = 0, cipherRC4 = 1, cipherAES = 2 }
 Enumeration for Encryption Algorithm. More...
 
enum  DataEvents {
  annotationUpdated = 'annotation-updated' , annotationAppearanceUpdated = 'annotation-appearance-updated' , annotationReplyAdded = 'annotation-reply-add' , annotationReviewStateAnnotAdded = 'annotation-review-state-annot-add' ,
  annotationMarkedStateAnnotAdded = 'annotation-marked-state-annot-add', annotationStatesCleared = 'annotation-states-cleared', annotationRemoved = 'annotation-removed' , annotationPositionMoved = 'annotation-moved-position',
  annotationOrderChanged = 'annotation-order-changed', annotationAdded = 'annotation-add' , annotationImported = 'annotation-imported' , actionUpdated ='action-updated' ,
  actionAdded ='action-add' , layerVisibleChanged = 'layer-visible-change' , stateAnnotNameUpdated = 'state-annot-name-updated' , pageInfoChanged = 'page-info-change' ,
  pageRotationChanged = 'page-rotation-change', imageAdded ="image-added", watermarkAdded ="watermark-added", watermarkRemoved ="watermark-removed",
  graphicsUpdated ="graphics-updated" , docPasswordChanged = "doc-password-changed" , drmEncryptSucceeded = "drm-encrypt-success", drmEncryptFailed = "drm-encrypt-failed" ,
  pwdAndPermRemoved = "remove-password-and-permission" , pageMoved = "page-moved", pageRemoved = "page-removed", pageAdded = "page-added" ,
  pagesInserted ="import-pages" , redactionApplied ="apply-redaction" , reviewStateRemoved ="remove-review-state" , formValueChanged = "form-value-changed",
  metaDataChanged = "meta-data-changed", docModified = "doc-modified", flattened = "flattened", headerFooterUpdated ="headerFooterUpdated",
  headerFooterAdded ="headerFooterAdded" , pagesMoved ="pages-moved", pagesRemoved ="pages-removed", pagesRotated ="pages-rotated",
  pageMeasureScaleRatioChanged =" page-measure-scale-ratio-changed" , pagesBoxChanged = 'pages-box-changed' , objectStartEdit = 'object-start-edit', objectEndEdit = 'object-end-edit',
  objectSelectionChanged = 'object-selection-changed', objectAdded = 'object-added', objectPropertyChanged = 'object-property-changed' , paragraphTextOnActivate = 'paragraph-text-on-activate',
  paragraphTextOnDeactivate = 'paragraph-text-on-deactivate', paragraphTextEnterEdit = 'paragraph-text-enter-edit', paragraphTextExitEdit = 'paragraph-text-exit-edit', paragraphTextOnChar = 'paragraph-text-on-char',
  findSuccess = 'find-success', replaceSuccess = 'replace-success', replaceAllSuccess = 'replace-all-success' , formFieldImported = 'form-field-imported'
}
 PDF data engine's event type. More...
 
enum  date_Format {
  MSlashD = 0, MSlashDSlashYY = 1, MSlashDSlashYYYY = 2, MMSlashDDSlashYY = 3,
  MMSlashDDSlashYYYY = 4, DSlashMSlashYY = 5, DSlashMSlashYYYY = 6, DDSlashMMSlashYY = 7,
  DDSlashMMSlashYYYY = 8, MMSlashYY = 9, MMSlashYYYY = 10, MDotDDotYY = 11,
  MDotDDotYYYY = 12, MMDotDDDotYY = 13, MMDotDDDotYYYY = 14, MMDotYY = 15,
  DDotMDotYYYY = 16, DDDotMMDotYY = 17, DDDotMMDotYYYY = 18, YYHyphenMMHyphenDD = 19,
  YYYYHyphenMMHyphenDD = 20
}
 Enumeration for date format type. More...
 
enum  Ending_Style {
  None, Square, Circle, Diamond,
  OpenArrow, ClosedArrow, Butt, ReverseOpenArrow,
  ReverseClosedArrow, Slash
}
 Enumeration for line ending style. Values of this enumeration should be used alone. More...
 
enum  Error_Code {
  success =0, file =1, format =2, password =3,
  handle =4, certificate =5, unknown =6, invalidLicense =7,
  param =8, unsupported =9, outOfMemory =10, securityHandler =11,
  notParsed =12, notFound =13, invalidType =14, conflict =15,
  unknownState =16, dataNotReady =17, invalidData =18, xFALoadError =19,
  notLoaded =20, invalidState =21, notCDRM =22, canNotConnectToServer =23,
  invalidUserToken =24, noRights =25, rightsExpired =26, deviceLimitation =27,
  canNotRemoveSecurityFromServer =28, canNotGetACL =29, canNotSetACL =30, isAlreadyCPDF =31,
  isAlreadyCDRM =32, canNotUploadDocInfo =33, canNotUploadCDRMInfo =34, invalidWrapper =35,
  canNotGetClientID =36, canNotGetUserToken =37, invalidACL =38, invalidClientID =39,
  OCREngineNotInit =40, diskFull =41, OCRTrialIsEnd =42, filePathNotExist =43,
  complianceEngineNotInit =44, complianceEngineInvalidUnlockCode =45, complianceEngineInitFailed =46, timeStampServerMgrNotInit =47,
  LTVVerifyModeNotSet =48, LTVRevocationCallbackNotSet =49, LTVCannotSwitchVersion =50, LTVCannotCheckDTS =51,
  LTVCannotLoadDSS =52, LTVCannotLoadDTS =53, needSigned =54, complianceResourceFile =55,
  timeStampServerMgrNoDefaltServer =56, defaultTimeStampServer =57, noConnectedPDFModuleRight =58, noXFAModuleRight =59,
  noRedactionModuleRight =60, noRMSModuleRight =61, noOCRModuleRight =62, noComparisonModuleRight =63,
  noComplianceModuleRight =64, noOptimizerModuleRight =65, noConversionModuleRight =66
}
 Enumeration for error code. More...
 
enum  File_Type {
  fdf = 0, xfdf = 1, xml = 2, csv = 3,
  txt = 4, json = 5
}
 Enumeration for file type. Values of this enumeration should be used alone. More...
 
enum  FileAttachment_Icon { graph ="Graph", pushPin ="PushPin", paperclip ="Paperclip", tag ="Tag" }
 Enumeration for file attachment annot icons. Values of this enumeration should be used alone. More...
 
enum  Flatten_Option { all =0x0000, field =0x0001, annot =0x0002 }
 Enumeration for flatten option. Values of this enumeration can be used alone or in combination. More...
 
enum  Font_Charset {
  ANSI = 0, Default = 1, Symbol =12, Shift_JIS = 128,
  Hangeul = 129, GB2312 = 134, ChineseBig5 = 136, Thai = 222,
  EastEurope = 238, Russian = 204, Greek = 161, Turkish = 162,
  Hebrew = 177, Arabic = 178, Baltic = 186
}
 Enumeration for font charset. More...
 
enum  Font_CIDCharset {
  Unknown = 0, GB1 = 1, CNS1 = 2, JAPAN1 = 3,
  KOREA1 = 4, UNICODE = 5
}
 Enumeration for CID font charset. More...
 
enum  Font_Descriptor_Flags {
  FixedPitch = 1, Serif = 2, Symbolic = 4, Script = 8,
  Nonsymbolic = 32, Italic = 64, AllCap = 65536, SmallCap = 131072,
  ForceBold = 262144
}
 Enumeration for page number format type. More...
 
enum  Font_StandardID {
  Courier =0, CourierB =1, CourierBI =2, CourierI =3,
  Helvetica =4, HelveticaB =5, HelveticaBI =6, HelveticaI =7,
  Times =8, TimesB =9, TimesBI =10, TimesI =11,
  Symbol =12, ZapfDingbats =13
}
 Enumeration for standard font ID. More...
 
enum  Font_Style { normal = 0, italic = 1, bold = 2 }
 Enumeration for font style. More...
 
enum  Font_Styles {
  FixedPitch = 1, Serif = 2, Symbolic = 4, Script = 8,
  NonSymbolic = 0x0020, Italic = 64, AllCap = 65536, SmallCap = 131072,
  Bold = 0x40000
}
 Enumeration for font styles. More...
 
enum  Graphics_FillMode { None = 0, Alternate = 1, Winding = 2 }
 Enumeration for filling mode type, mainly for path graphics object. More...
 
enum  Graphics_ObjectType {
  All = 0, Text = 1, Path = 2, Image = 3,
  Shading = 4, FormXObject = 5
}
 Enumeration for PDF graphics object type. More...
 
enum  Highlight_Mode {
  none =0, invert =1, outline =2, push =3,
  toggle =4
}
 Enumeration for highlight mode. Values of this enumeration should be used alone. More...
 
enum  MK_Properties { borderColor ='borderColor', fillColor ='fillColor', normalCaption ='normalCaption' }
 Enumeration for PDF MK property. More...
 
enum  NewWindowFlag { NewWindowFlagFalse =0, NewWindowFlagTrue =1, NewWindowFlagNone =2 }
 Enumeration for new window flag. Values of this enumeration should be used alone. More...
 
enum  Note_Icon {
  Check ="Check", Circle ="Circle", Comment ="Comment", Cross ="Cross",
  Help ="Help", Insert ="Insert", Key ="Key", NewParagraph ="NewParagraph",
  Note ="Note", Paragraph ="Paragraph", RightArrow ="RightArrow", RightPointer ="RightPointer",
  Star ="Star", UpArrow ="UpArrow", UpLeftArrow ="UpLeftArrow"
}
 Enumeration for note annot icons. Values of this enumeration should be used alone. More...
 
enum  page_Number_Format {
  default = 0, numberOfCount = 1, numberSlashCount = 2, pageNumber = 3,
  pageNumberOfCount = 4
}
 Enumeration for font styles. More...
 
enum  Point_Type {
  moveTo = 1, lineTo = 2, lineToCloseFigure = 3, bezierTo = 4,
  bezierToCloseFigure = 5
}
 Enumeration for point type in path. Values of this enumeration should be used alone. More...
 
enum  POS_TYPE {
  FIRST =0, LAST =1, AFTER =2, BEFORE =3,
  NEXT =2, PREV =3
}
 Enumeration for PDF object position Type. More...
 
enum  Position {
  topLeft ="TopLeft", topCenter ="TopCenter", topRight ="TopRight", centerLeft ="CenterLeft",
  center ="Center", centerRight ="CenterRight", bottomLeft ="BottomLeft", bottomCenter ="BottomCenter",
  bottomRight ="BottomRight"
}
 Enumeration for position. Values of this enumeration should be used alone. More...
 
enum  PosType {
  first =0, last =1, after =2, before =3,
  next =2, prev =3
}
 Enumeration for PDF target object position Type. More...
 
enum  Range_Filter { all, even, odd }
 Enumeration for range filter. More...
 
enum  Relationship {
  firstChild =0, lastChild =1, previousSibling =2, nextSibling =3,
  firstSibling =4, lastSibling =5
}
 Enumeration for Relationship. Values of this enumeration should be used alone. More...
 
enum  Rendering_Content { page, annot, form }
 Enumeration for PDF rendering content. More...
 
enum  Rendering_Usage { print ='print', view ='view' }
 Enumeration for PDF rendering usage. More...
 
enum  Rotation { rotation0 =0, rotation1 =1, rotation2 =2, rotation3 =3 }
 Enumeration for rotation. Values of this enumeration should be used alone. More...
 
enum  Rotation_Degree { rotation0 =0, rotation90 =90, rotation180 =180, rotation270 =270 }
 Enumeration for rotation. Values of this enumeration should be used alone. More...
 
enum  Saving_Flag {
  normal = 0, incremental =0x0001, noOriginal =0x0002, XRefStream =0x0008,
  linearized =0x1000, removeRedundantObjects = 0x0010
}
 Enumeration for PDF document saving flags. More...
 
enum  Search_Flag { caseSensitive =1, wholeWord =2, consecutively =4 }
 Enumeration for search flag. Values of this enumeration can be used alone or in combination. More...
 
enum  Signature_Ap_Flags {
  showTagImage =1, showLabel =2, showReason =4, showDate =8,
  showDistinguishName =16, showLocation =32, showSigner =64, showBitmap =128,
  showText =256
}
 Enumeration for signature ap flag. More...
 
enum  Signature_State {
  VerifyErrorByteRange =64, verifyChange =128, verifyIncredible =256, verifyNoChange =1024,
  stateVerifyIssueUnknown = 2048, verifyIssueValid =4096, verifyIssueUnknown =8192, verifyIssueRevoke =16384,
  verifyIssueExpire =32768, verifyIssueUncheck =65536, verifyIssueCurrent =131072, verifyTimestampNone =262144,
  verifyTimestampDoc =524288, verifyTimestampValid =1048576, verifyTimestampInvalid =2097152, verifyTimestampExpire =4194304,
  verifyTimestampIssueUnknown =8388608, verifyTimestampIssueValid =16777216, verifyTimestampTimeBefore =33554432, verifyChangeLegal =134217728,
  verifyChangeIllegal =268435456
}
 Enumeration for signature state. More...
 
enum  Sound_Icon { speaker ="Speaker", mic ="Mic", ear ="Ear" }
 Enumeration for sound annot icons. Values of this enumeration should be used alone. More...
 
enum  STAMP_TEXT_TYPE {
  CUSTOM_TEXT = "type here to insert text", NAME = "author name", NAME_DATE_TIME = "author name, date and time", DATE_TIME = "date and time",
  DATE = "date"
}
 Enumeration for dynamic stamp text type. More...
 
enum  Standard_Font {
  courier =0, courierBold =1, courierBoldOblique =2, courierOblique =3,
  helvetica =4, helveticaBold =5, helveticaBoldOblique =6, helveticaOblique =7,
  timesRoman =8, timesBold =9, timesBoldItalic =10, timesItalic =11,
  symbol =12, zapfDingbats =13
}
 Enumeration for font id. Values of this enumeration should be used alone. More...
 
enum  Text_Mode {
  Fill = 0, Stroke = 1, FillStroke = 2, Invisible = 3,
  FillClip = 4, StrokeClip = 5, FillStrokeClip = 6, Clip = 7
}
 Enumeration for text mode. More...
 
enum  User_Permissions {
  print = 0b100, modify = 0b1000, extract = 0b10000, annotForm = 0b100000,
  fillForm = 0b100000000, extractAccess = 0b1000000000, assemble = 0b10000000000, printHigh = 0b100000000000
}
 Enumeration for user access permissions in a PDF document. More...
 
enum  Watermark_Flag {
  asContent =0, asAnnot =1, onTop =2, unprintable =4,
  display =8
}
 Enumeration for watermark flag. Values of this enumeration can be used alone or in combination. More...
 
enum  ZoomMode { ZoomXYZ ="ZoomXYZ", ZoomFitPage ="ZoomFitPage", ZoomFitHorz ="ZoomFitHorz", ZoomFitRect ="ZoomFitRect" }
 Enumeration for zoom mode. Values of this enumeration should be used alone. More...
 

Detailed Description

pdf related constants

Note
Access these objects by "PDFViewCtrl.PDF.constant.*".

Enumeration Type Documentation

◆ Action_Trigger

Enumeration for action trigger. Values of this enumeration should be used alone.

Since
7.4.0
Enumerator
click 

Trigger a JavaScript action to be performed when the user click a annotation or field.

This represents "A" entry in an annotation/field dictionary.

keyStroke 

Trigger a JavaScript action to be performed when the user types a keystroke into a text field or combo box or modifies the selection in a scrollable list box.

This represents "K" entry in a form field's additional-actions dictionary. Only applicable for additional action object constructed from PDF form field.
The triggered action can check the keystroke for validity and reject or modify it.

format 

Trigger a JavaScript action to be performed before the field is formatted to display its current value.

This represents "F" entry in a form field's additional-actions dictionary. Only applicable for additional action object constructed from PDF form field.
The triggered action can modify the field's value before formatting.

validate 

Trigger a JavaScript action to be performed when the field's value is changed.

This represents "V" entry in a form field's additional-actions dictionary. Only applicable for additional action object constructed from PDF form field.
The triggered action can check the new value for validity.

calculate 

Trigger a JavaScript action to be performed to recalculate the value of this field when that of another field changes.

This represents "C" entry in a form field's additional-actions dictionary. Only applicable for additional action object constructed from PDF form field.

mouseEnter 

Trigger an action to be performed when the cursor enters the annotation's active area.

This represents "E" entry in an annotation's additional-actions dictionary. Only applicable for additional action object constructed from PDF annotation.

mouseExit 

Trigger an action to be performed when the cursor exits the annotation's active area.

This represents "X" entry in an annotation's additional-actions dictionary. Only applicable for additional action object constructed from PDF annotation.

mouseDown 

Trigger an action to be performed when the mouse button is pressed inside the annotation's active area.

This represents "D" (stands for "Down") entry in an annotation's additional-actions dictionary. Only applicable for additional action object constructed from PDF annotation.

mouseUp 

Trigger an action to be performed when the mouse button is released inside the annotation's active area.

This represents "U" (stands for "Up") entry in an annotation's additional-actions dictionary. Only applicable for additional action object constructed from PDF annotation.

onFocus 

(Applicable for widget annotation only) Trigger an action to be performed when the annotation receives the input focus.

This represents "Fo" entry in an annotation's additional-actions dictionary. Only applicable for additional action object constructed from a widget annotation.

onBlur 

(Applicable for widget annotation only) Trigger an action to be performed when the annotation loses the input focus.

This represents "Bl" (Uppercase B and lowercase L, which stands for "blurred") entry in an annotation's additional-actions dictionary. Only applicable for additional action object constructed from a widget annotation.

◆ Action_Type

Enumeration for action type. Values of this enumeration should be used alone.

Since
7.2.0
Enumerator
goto 

Goto action.

launch 

Launch action.

uri 

URI action.

named 

Named action.

submitForm 

SubmitForm action.

resetForm 

ResetForm action.

javaScript 

JavaScript action.

importData 

ImportData action.

hide 

Hide action.

gotoE 

GotoE action.

◆ Additional_Permission

Enumeration for additional permission.

Since
7.2.0
Enumerator
download 

Download permission.

◆ Alignment

enum Alignment

Enumeration for text alignment. Values of this enumeration should be used alone.

Since
7.2.0
Enumerator
left 

Left alignment.

center 

Center alignment.

right 

Right alignment.

◆ AnnotUpdatedType

The type of the annot attribute update.

Since
7.3.0
Enumerator
contentUpdated 

Annotation's Content was updated.

borderInfoUpdated 

Annotation's borderInfo was updated.

borderStyleUpdated 

Annotation's borderStyle was updated.

borderWidthUpdated 

Annotation's borderWidth was updated.

borderColorUpdated 

Annotation's borderColor was updated.

captionColorUpdated 

Annotation's captionColor was updated.

Since
9.1.0
modifiedDateTimeUpdated 

Annotation's modifiedDateTime was updated.

uniqueIDUpdated 

Annotation's uniqueID was updated.

flagsUpdated 

Annotation's flags was updated.

rectUpdated 

Annotation's rect was updated.

innerRectUpdated 

Annotation's innerRect was updated.

iconNameUpdated 

Annotation's iconName was updated.

rotationUpdated 

Annotation's rotation was updated.

defaultAppearanceUpdated 

Annotation's defaultAppearance was updated.

calloutLineEndingStyleUpdated 

Annotation's calloutLineEndingStyle was updated.

calloutLinePointsUpdated 

Annotation's calloutLinePoints was updated.

fillColorUpdated 

Annotation's fillColor was updated.

textColorUpdated 

Annotation's fillColor was updated.

alignmentUpdated 

Annotation's alignment was updated.

inkListUpdated 

Annotation's inkList was updated.

endPointUpdated 

Annotation's endPoint was updated.

startPointUpdated 

Annotation's startPoint was updated.

endingStyleUpdated 

Annotation's endingStyle was updated.

enableCaptionUpdated 

Annotation's enableCaption was updated.

leaderCaptionOffsetUpdated 

Annotation's leaderCaptionOffset was updated.

styleFillColorUpdated 

Annotation's styleFillColor was updated.

leaderLineLengthUpdated 

Annotation's leaderLineLength was updated.

leaderLineExtendUpdated 

Annotation's leaderLineExtend was updated.

leaderLineOffsetUpdated 

Annotation's leaderLineOffset was updated.

measureRatioUpdated 

Annotation's measureRatio was updated.

measureUnitUpdated 

Annotation's measureUnit was updated.

measureConversionFactorUpdated 

Annotation's measureConversionFactor was updated.

removeAction 

Remove the action of the annotation.

actionDataUpdated 

Annotation's actionData was updated.

addAction 

Add the action of the annotation.

moveAction 

Add the action of the annotation.

highlightingModeUpdated 

Annotation's highlightingMode was updated.

subjectUpdated 

Annotation's subject was updated.

titleUpdated 

Annotation's title was updated.

createDateTimeUpdated 

Annotation's createDateTime was updated.

opacityUpdated 

Annotation's opacity was updated.

intentUpdated 

Annotation's intent was updated.

vertexesUpdated 

Annotation's vertexes was updated.

applyFillColorUpdated 

redaction's applyFillColor was updated

overlayTextUpdated 

redaction's overlayText was updated

overlayTexAlignmentUpdated 

redaction's overlay text alignment was updated

repeatUpdated 

redaction's repeat was updated

autoFontSizeUpdated 

redaction's auto font size was updated

redactDefaultAppearanceUpdated 

redaction's default appearance was updated

redactOpacityUpdated 

redaction's opacity was updated

quadPointsUpdated 

Annotation's quadPoints was updated.

reviewStateUpdated 

add/remove review state

markedStateUpdated 

add/remove marked state

statesCleared 

cleared review/marked states

replyAdded 

add reply annotation

richTextUpdated 

update rich text

richTextRemoved 

remove rich text

addDictionary 

add dictionary

imageUpdated 

image data was updated.

formFieldValueUpdated 

value of a form field changed

formFieldsMaxLengthUpdated 

MaxLength updated.

formFieldItemsUpdated 

items of a form field updated

formFieldIconUpdated 

Icon updated.

formFieldInsertedItem 

inserted new item to form field

formFieldExportValueUpdated 

export-value of a form field(radio button or checkbox) changed

formFieldMKPropertyUpdated 

MKProperty of a form field changed.

formFieldAlternateName 

Alternate name of a form field changed.

formFieldMappingName 

Mapping name of a form field changed.

Since
9.1.0
formFieldActionUpdated 

Action of a form field changed.

◆ Border_Style

Enumeration for border style. Values of this enumeration should be used alone.

Since
7.2.0
Enumerator
solid 

Solid border.

dashed 

Dashed border.

underline 

Underline border.

beveled 

Beveled border.

inset 

Inset border.

cloudy 

Cloudy border.

noBorder 

No border.

◆ Box_Type

enum Box_Type

Enumeration for page box type.

Values of this enumeration should be used alone.

Since
7.4.0
Enumerator
MediaBox 

Media Box for page boundary.

The boundary of the physical medium on which page is to be displayed or printed.

CropBox 

Crop Box for page boundary.

The region to which the contents of page are to be clipped (cropped) while displaying or printing.

TrimBox 

Trim Box for page boundary.

The region to which the contents of page should be clipped while outputting in a production environment.

ArtBox 

Art Box for page boundary.

The intended dimensions of a finished page after trimming.

BleedBox 

Bleed Box for page boundary.

The extent of page's meaningful content (including potential white space) as intended by page's creator.

◆ Calc_Margin_Mode

Enumeration for calculating margin mode.

Values of this enumeration should be used alone.

Since
7.5.0
Enumerator
CalcContentsBox 

Calculate margin according to bounding box of all contents.

CalcDetection 

Calculate margin by detecting paths or images.

◆ Cipher_Type

Enumeration for Encryption Algorithm.

Enumerator
cipherNone 

Not use encryption algorithm.

cipherRC4 

Use RC4 encryption algorithm, with the key length between 5 bytes and 16 bytes.

cipherAES 

Use AES encryption algorithm, with the key length be 16 bytes (as AES-128) or 32 bytes (as AES-256, only supported in PDF 2.0).

◆ DataEvents

enum DataEvents

PDF data engine's event type.

Enumerator
annotationUpdated 

If an annotation is updated, an event with this type will be triggered.

// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.annotationUpdated, (annots, PDFPage, AnnotUpdatedType) => {
//do something with annotations updated.
})
annotationAppearanceUpdated 

If an annotation's appearance is updated, an event with this type will be triggered.

// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.annotationAppearanceUpdated, (annots) => {
//do something with annotations updated.
})
annotationReplyAdded 

If an reply annotation is added, an event with this type will be triggered.

// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.annotationReplyAdded, (replyAnnot) => {
//do something with reply annot added.
})
Since
8.3
annotationReviewStateAnnotAdded 

This event will be triggered after an review state added.

// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.annotationReviewStateAnnotAdded, (stateAnnot, targetAnnot) => {
// do something after review state annot added
})
Since
8.3
annotationMarkedStateAnnotAdded 

This event will be triggered after an marked state added.

// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.annotationMarkedStateAnnotAdded, (stateAnnot, targetAnnot) => {
// do something after marked state annot added
})
Since
8.3
annotationStatesCleared 

This event will be triggered after all states removed.

// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.annotationStatesCleared, (targetAnnot) => {
// do something after all states removed
})
annotationRemoved 

If some annotations are removed, an event with this type will be triggered.

// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.annotationRemoved, (removedAnnots) => {
//do something with annotations removed.
})
annotationPositionMoved 

If annotations are moved, an event with this type will be triggered.

// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.annotationPositionMoved, (movedAnnots, page, trigger) => {
//do something with annotations moved.
})
Since
8.3
annotationOrderChanged 

If the annotation`order is changed, an event with this type will be triggered.

// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.annotationOrderChanged, (annots, page, orderType) => {
//do something with annotations changed.
})
Since
10.0.0
annotationAdded 

If an annotation is added, an event with this type will be triggered.

// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.annotationAdd, (annotations) => {
//do something with annotations added.
})
annotationImported 

If annotations are imported, an event with this type will be triggered.

Parameters
docPDFDoc
// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.annotationImported, (doc) => {
//do something.
})
actionUpdated 

If the action of the annotation is updated, an event with this type will be triggered.

// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.actionUpdated, (annot) => {
//do something with annotation.
})
actionAdded 

If annotation added an action, an event with this type will be triggered.

// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.actionAdded, (annot) => {
//do something with annotation.
})
Since
8.3
layerVisibleChanged 

If visibility of a layer node is changed, an event with this type will be triggered.

// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.layerVisibleChanged, (PDFDoc) => {
//do something.
})
Since
8.3
stateAnnotNameUpdated 

This event will be triggered when name of a state annotation been updated.

// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.stateAnnotNameUpdated, (PDFDoc) => {
//do something.
})
pageInfoChanged 

Triggered when the page info changes. eg: width, height, rotation.

// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.pageInfoChanged, (PDFPage) => {
//do something.
})
Since
8.3
pageRotationChanged 

Triggered when the page Angle changes.

// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.pageRotationChanged, (PDFPage, newRotaion, oldRotaion) => {
//do something.
})
Since
8.3
imageAdded 

Triggered after an image buffer adds to PDFPage.

See also
PDFPage.addImage
// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.imageAdded, (PDFPage) => {
//do something.
})
watermarkAdded 

Triggered after a page watermark added.

See also
PDFPage.addWatermark
// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.watermarkAdded, (PDFPage) => {
//do something.
})
watermarkRemoved 

Triggered after watermark removed.

See also
PDFDOC.removeAllWatermarks
graphicsUpdated 

Triggered when any changes on the property of a graphics object.

Parameters
PDFPagePDFPage
graphicsObjGraphicsObject
// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.graphicsUpdated, (PDFPage,graphicsObj) => {
//do something.
})
docPasswordChanged 

Triggered when the document password (ownerPassword or userPassword) changed success.

// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.docPasswordChanged, (PDFDoc) => {
//do something.
})
drmEncryptSucceeded 

Triggered when the document DRM encryption is successful.

// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.drmEncryptSucceeded, (PDFDoc) => {
//do something.
})
Since
8.3
drmEncryptFailed 

Triggered when the document DRM encryption is fail.

// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.drmEncryptFailed, (PDFDoc) => {
//do something.
})
pwdAndPermRemoved 

Triggered after the password and permission are removed from a document successfully.

// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.pwdAndPermRemoved, (PDFDoc) => {
// do something
})
Since
8.3
pageMoved 

Triggered after the page moved.

See also
PDFDoc.movePageTo
// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.pageMoved, (fromPageIndex, destPageIndex) => {
// do something
})
pageRemoved 

Triggered after page removed.

See also
PDFDoc.removePage
// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.pageRemoved, (removedPageIndex) => {
// do something
})
pageAdded 

Triggered after a page object inserted into the PDFDoc instance via PDFDoc.insertPage.

See also
PDFDoc.insertPage
// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.pageAdded, (page: PDFPage) => {
// do something
})
pagesInserted 

Triggered after pages inserted into PDFDoc instance via PDFDoc.insertPages API.

See also
PDFDoc.insertPages
// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.pagesInserted, (pages: Array<PDFPage>) => {
// do something
})
Since
8.3
redactionApplied 

Triggered after the redaction annotations are applied.

See also
PDFDoc.applyRedaction
// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.redactionApplied, (result: Array<{pageIndex, removedAnnots}>) => {
// do something
})
Since
8.3
reviewStateRemoved 

Triggered after a review state annotation of a MarkupAnnot is removed.

// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.reviewStateRemoved, (annot: MarkupAnnot) => {
// do something
})

.

Since
8.3
formValueChanged 

Triggerd after form property value changed.

// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.formValueChanged, () => {
// do something
})

.

metaDataChanged 

Triggered after any of the metadata value changed via PDFDoc.setMetadataValue API;.

See also
PDFDoc.setMetadataValue
// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.metaDataChanged, (doc: PDFDoc) => {
// do something
})
docModified 

Triggered when the document is modified all events in web-pdf-engine except drmEncryptFailed and layerVisibleChange.

// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.docModified, (PDFDoc) => {
//do something.
})
flattened 

Triggered when the document is flattened.

Note
DO NOT call modifying method in event callback. Or a crash will happend.
// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.flattened, (pageIndex) => {
//do something.
})
headerFooterUpdated 

Triggered when update header or footer.

// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.headerFooterUpdated, (pageRanges) => {
//do something.
})
headerFooterAdded 

Triggered when update header or footer.

// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.headerFooterAdded, (pageRanges) => {
//do something.
})
pagesMoved 

Triggered after pages moved via PDFDoc.movePagesTo API.

See also
PDFDoc.movePagesTo
// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.pagesMoved, (pageRange, destPageIndex) => {
// do something
})
pagesRemoved 

Triggered after pages removed via PDFDoc.removePages API.

See also
PDFDoc.removePages
// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.pagesRemoved, (pageRange) => {
// do something
})
pagesRotated 

Triggered after pages rotated via PDFDoc.rotatePages API.

See also
PDFDoc.rotatePages
// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.pagesRotated, (pages: Array<PDFPage>, newRotaion, oldRotaions:Array<number>) => {
// do something
})
pageMeasureScaleRatioChanged 

Triggered when the page measurement scale ratio changes.

See also
PDFPage.setMeasureScaleRatio
// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.pageMeasureScaleRatioChanged, (PDFPage) => {
//do something.
})
Since
8.4
pagesBoxChanged 

Triggered after the page box has been changed.

Parameters
pagesPDFPage[]
See also
PDFDoc.setPagesBox
// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.pagesBoxChanged, (pages) => {
// do something
})
Since
8.4.0
objectStartEdit 

Triggered when graphics object start edit. The relevant ui tool is Edit Object dropdown menu.

// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.objectStartEdit, () => {
//do something.
})
Since
9.2.0
objectEndEdit 

Triggered when graphics object end edit. The relevant ui tool is Edit Object dropdown menu.

// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.objectEndEdit, () => {
//do something.
})
Since
9.2.0
objectSelectionChanged 

Triggered when the selected graphics object changed.

Parameters
dataObject | undefined - The selected graphics object.
data.typenumber - The type of graphics object. 1|Text, 2|Path, 3|Image, 4|Shading.
data.widthnumber - The width of graphics object.
data.heightnumber - The height of graphics object.
data.xPositionnumber - The x position of graphics object.
data.yPositionnumber - The y position of graphics object.
data.opacitynumber - The opacity of graphics object.
[data.fontName]string - The font name of graphics object. Text object only.
[data.fontSize]number - The font size of graphics object. Text object only.
[data.text]string - The text of graphics object. Text object only.
[data.strokeColor]number - The stroke color of graphics object. Path object only.
[data.fillColor]number - The fill color of graphics object. Path object only.
[data.lineWidth]number - The line width of graphics object. Path object only.
[data.lineStyle]Array - The line style of graphics object. Path object only.
[data.lineCap]number - The line cap of graphics object. Path object only.
[data.lineJoin]number - The line join of graphics object. Path object only.
[data.miterLimit]number - The miter limit of graphics object. Path object only.
[data.gradientArray]number - The gradient array of graphics object. Shading object only.
// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.objectSelectionChanged, (data) => {
//do something.
})
Since
9.2.0
objectAdded 

Triggered when graphics object added. Only support adding image, path, shading. The relevant ui tools are Add Shapes dropdown menu and Add Image button.

Parameters
dataObject - Data.
data.pageIndexnumber - Page index.
data.graphicsObjectObject - Graphics object.
data.graphicsObject.typenumber - Graphics object type. 1|Text, 2|Path, 3|Image, 4|Shading.
data.graphicsObject.rectObject - Graphics object rect.
data.graphicsObject.rect.leftnumber - Graphics object rect left.
data.graphicsObject.rect.topnumber - Graphics object rect top.
data.graphicsObject.rect.rightnumber - Graphics object rect right.
data.graphicsObject.rect.bottomnumber - Graphics object rect bottom.
// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.objectAdded, (data) => {
//do something.
})
Since
9.2.0
objectPropertyChanged 

Triggered when graphics object property changed.

Parameters
dataObject - Data.
data.typenumber - Graphics object type. 1|Text, 2|Path, 3|Image, 4|Shading.
data.propertiesObject - Graphics object properties.
[data.properties.opacity][number] - Opacity.
[data.properties.shear][number] - Shear.
[data.properties.center][{type: 'PageCenterAlignmentType', value: number}] - Center. 0|Vertical, 1|Horizontal, 2|Both.
[data.properties.align][{type: 'GraphicsObjectAlignmentType', value: number}] - Align. 0|Left, 1|Right, 2|Top, 3|Bottom, 4|Vertical Center, 5|Horizontal Center.
[data.properties.distribute][boolean] - Distribute. true|Distribute Vertical, false|Distribute Horizontal.
[data.properties.rotate][number] - Rotate.
[data.properties.renderOrder][{type: 'RenderingOrder', value: number}] - RenderOrder. 0|Bring to Back, 1|Bring to Front.
[data.properties.font][string, boolean, boolean] - Font. Format: [FontName, IsBold, IsItalic]. Text object only.
[data.properties.fontSize][number] - FontSize. Text object only.
[data.properties.strokeColor][boolean, {type: 'Color', value: number; space: number;}, boolean] - StrokeColor. Path object only.
[data.properties.fillColor][boolean, {type: 'Color', value: number; space: number;}, boolean] - FillColor. space: 1|DeviceGray, 2|DeviceRGB, 3|DeviceCMYK. Path object only.
[data.properties.lineWidth][number] - LineWidth. Path object only.
[data.properties.lineStyle][{type: 'FloatArray', value: [number, number]}] - LineStyle. Path object only.
[data.properties.lineCap][{type: 'ineCap', value: number}] - LineCap. 0|Butt, 1|Round, 2|Projecting Square Cap. Path object only.
[data.properties.lineJoin][{type: 'ineJoin', value: number}] - LineJoin. 0|Miter, 1|Round, 2|Bevel. Path object only. Path object only.
[data.properties.miterLimit][number] - MiterLimit. Path object only.
[data.properties.gradientColor][{type: 'ShadingColorArray', value: [{fromColor: string; from: number; toColor: string; to: number;}]}] - GradientColor. Shading object only.
// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.objectPropertyChanged, (data) => {
//do something.
})
Since
9.2.0
paragraphTextOnActivate 

Triggered when activate paragraph text. The relevant ui tool is Edit Text button.

// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.paragraphTextOnActivate, () => {
//do something.
})
Since
9.2.0
paragraphTextOnDeactivate 

Triggered when deactivate paragraph text. The relevant ui tool is Edit Text button.

// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.paragraphTextOnDeactivate, () => {
//do something.
})
Since
9.2.0
paragraphTextEnterEdit 

Triggered when paragraph text enter edit mode. The relevant ui tool is Edit Text button.

// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.paragraphTextEnterEdit, () => {
//do something.
})
Since
9.2.0
paragraphTextExitEdit 

Triggered when paragraph text exit edit mode. The relevant ui tool is Edit Text button.

// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.paragraphTextExitEdit, () => {
//do something.
})
Since
9.2.0
paragraphTextOnChar 

Triggered when the character of a text paragraph is inputting. Not support Undo/Redo and Copy/Paste operation. The relevant ui tool is Edit Text button.

Parameters
dataObject - Data.
data.charstring - Characters.
// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.paragraphTextOnDeactivate, (data) => {
//do something.
})
Since
9.2.0
findSuccess 

Triggered when find text success.

Parameters
dataObject - Find result.
data.isFoundboolean - Indicates whether the text is matched.
data.pageIndexnumber - The page index where the text matches.
data.rectArrayArray<{left: number; right: number; top: number; bottom: number}> - The rects where the text matches. Is PDF coordinates.
Example:
// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.findSuccess, (data) => {
//do something.
})
Since
10.0.0
replaceSuccess 

Triggered when replace text success.

Example:
// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.replaceSuccess, () => {
//do something.
})
Since
10.0.0
replaceAllSuccess 

Triggered when replace all text success.

Parameters
countnumber - The number of replacements.
Example:
// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.replaceAllSuccess, (count) => {
//do something.
})
Since
10.0.0
formFieldImported 

If form field are imported, an event with this type will be triggered.

Parameters
docPDFDoc
Example:
// GET pdfViewer OBJECT FIRST
pdfViewer.eventEmitter.on(DataEvents.formFieldImported, (doc) => {
//do something.
})
Since
10.0.0

◆ date_Format

Enumeration for date format type.

Values of this enumeration can be used alone.

Enumerator
MSlashD 

If this is used, "m/d" would be used as the date format string.

MSlashDSlashYY 

If this is used, "m/d/yy" would be used as the date format string.

MSlashDSlashYYYY 

If this is used, "m/d/yyyy" would be used as the date format string.

MMSlashDDSlashYY 

If this is used, "mm/dd/yy" would be used as the date format string.

MMSlashDDSlashYYYY 

If this is used, "mm/dd/yyyy" would be used as the date format string.

DSlashMSlashYY 

If this is used, "d/m/yy" would be used as the date format string.

DSlashMSlashYYYY 

If this is used, "d/m/yyyy" would be used as the date format string.

DDSlashMMSlashYY 

If this is used, "dd/mm/yy" would be used as the date format string.

DDSlashMMSlashYYYY 

If this is used, "dd/mm/yyyy" would be used as the date format string.

MMSlashYY 

If this is used, "mm/yy" would be used as the date format string.

MMSlashYYYY 

If this is used, "mm/yyyy" would be used as the date format string.

MDotDDotYY 

If this is used, "m.d.yy" would be used as the date format string.

MDotDDotYYYY 

If this is used, "m.d.yyyy" would be used as the date format string.

MMDotDDDotYY 

If this is used, "mm.dd.yy" would be used as the date format string.

MMDotDDDotYYYY 

If this is used, "mm.dd.yyyy" would be used as the date format string.

MMDotYY 

If this is used, "mm.yy" would be used as the date format string.

DDotMDotYYYY 

If this is used, "d.m.yyyy" would be used as the date format string.

DDDotMMDotYY 

If this is used, "dd.mm.yy" would be used as the date format string.

DDDotMMDotYYYY 

If this is used, "dd.mm.yyyy" would be used as the date format string.

YYHyphenMMHyphenDD 

If this is used, "yy-mm-dd" would be used as the date format string.

YYYYHyphenMMHyphenDD 

If this is used, "yyyy-mm-dd" would be used as the date format string.

◆ Ending_Style

Enumeration for line ending style. Values of this enumeration should be used alone.

Since
7.2.0
Enumerator
None 

No special line ending.

Square 

A square filled with the annotation's interior color if any.

Circle 

A circle filled with the annotation's interior color if any.

Diamond 

A diamond filled with the annotation's interior color if any.

OpenArrow 

Two short lines meeting in an acute angle to form an open arrowhead.

ClosedArrow 

Two short lines meeting in an acute angle as in the OpenArrow style and connected by a third line to form a triangular closed arrowhead filled with the annotation's interior color if any.

Butt 

A short line at the endpoint perpendicular to the line itself.

ReverseOpenArrow 

Two short lines in the reverse direction from OpenArrow.

ReverseClosedArrow 

A triangular closed arrowhead in the reverse direction from ClosedArrow.

Slash 

A short line at the endpoint approximately 30 degrees clockwise from perpendicular to the line itself.

◆ Error_Code

enum Error_Code

Enumeration for error code.

Enumerator
success 

Success, and no error occurs.

file 

File cannot be found or could not be opened.

format 

Format is invalid. For files, this may also mean that file is corrupted.

password 

Invalid password. Usually, this error may occur when loading a PDF document with password. When meet this, user should load document again with correct password.

handle 

Error handle.

certificate 

Certificate error: PDF document is encrypted by digital certificate but current user does not have the correct certificate.

unknown 

Any unknown error occurs.

invalidLicense 

Invalid license is used to initialize Foxit PDF SDK library.

param 

Parameter error: value of any input parameter for a function is invalid.

unsupported 

Some types are not supported.

outOfMemory 

Out-of-memory error occurs.

securityHandler 

PDF document is encrypted by some unsupported security handler.

notParsed 

Content has not been parsed yet. Usually, this represents PDF page has not been parsed yet.

notFound 

Expected data or object is not found.

invalidType 

The type of input object or current object is invalid.

conflict 

New data conflicts with existed data.

unknownState 

Any unknown state occurs.

dataNotReady 

Data is not ready. Usually this is used as an exception error code when loading document in asynchronous way.

invalidData 

Data of current object is invalid.

xFALoadError 

XFA loading error.

notLoaded 

Current object has not been loaded yet.

invalidState 

Invalid or incorrect state.

notCDRM 

(For ConnectedPDF only) The loaded document is not a ConnectedPDF DRM document.

canNotConnectToServer 

(For ConnectedPDF only) Cannot connect to ConnectedPDF server.

invalidUserToken 

(For ConnectedPDF only) Input user token is invalid.

noRights 

(For ConnectedPDF only) Current user has no right to open the ConnectedPDF DRM document.

rightsExpired 

(For ConnectedPDF only) The rights of Current user has expired.

deviceLimitation 

(For ConnectedPDF only) Current device is limited to open the ConnectedPDF DRM document.

canNotRemoveSecurityFromServer 

(For ConnectedPDF only) Cannot remove the security from ConnectedPDF server.

canNotGetACL 

(For ConnectedPDF only) Cannot get the ACL from ConnectedPDF server.

canNotSetACL 

(For ConnectedPDF only) Cannot set the ACL to ConnectedPDF server.

isAlreadyCPDF 

(For ConnectedPDF only) Loaded document is already a ConnectedPDF document.

isAlreadyCDRM 

(For ConnectedPDF only) Loaded document is already a ConnectedPDF DRM document.

canNotUploadDocInfo 

(For ConnectedPDF only) Cannot upload ConnectedPDF document info to ConnectedPDF server.

canNotUploadCDRMInfo 

(For ConnectedPDF only) Cannot upload ConnectedPDF DRM document info to ConnectedPDF server.

invalidWrapper 

(For ConnectedPDF only) The input ConnectedPDF DRM wrapper document is invalid.

canNotGetClientID 

(For ConnectedPDF only) Cannot get client ID from ConnectedPDF server.

canNotGetUserToken 

(For ConnectedPDF only) Cannot get user token from ConnectedPDF server.

invalidACL 

(For ConnectedPDF only) Input ACL is invalid.

invalidClientID 

(For ConnectedPDF only) Input client ID is invalid.

OCREngineNotInit 

(For OCR only) OCR engine has not been initialized successfully.

diskFull 

(For OCR only) Not enough disk space.

OCRTrialIsEnd 

(For OCR only) The trial for OCR module is end.

filePathNotExist 

File or folder path does not exist.

complianceEngineNotInit 

(For compliance only) Compliance engine has not been initialized successfully.

complianceEngineInvalidUnlockCode 

(For compliance only) Invalid unlock code is used to initialize compliance engine.

complianceEngineInitFailed 

(For compliance only) Fail to initialize compliance engine.

timeStampServerMgrNotInit 

Time stamp server manager has not been initialized successfully.

LTVVerifyModeNotSet 

(For LTV only) LTV verify mode has not been set.

LTVRevocationCallbackNotSet 

(For LTV only) Revocation callback for LTV has not been set.

LTVCannotSwitchVersion 

(For LTV only) Fail to switch PDF verion.

LTVCannotCheckDTS 

(For LTV only) Fail to check DTS.

LTVCannotLoadDSS 

(For LTV only) Fail to load DSS.

LTVCannotLoadDTS 

(For LTV only) Fail to load DTS.

needSigned 

(For signature only) The signature being operated needs to be signed.

complianceResourceFile 

(For compliance only) Compliance resource file(s) cannot be found or opened. Please check if compliance resource folder and files in this folder are valid.

timeStampServerMgrNoDefaltServer 

No default server has been set to time stamp server manager yet.

defaultTimeStampServer 

Cannot use current default time stamp server. Please check if default time stamp server can be used.

noConnectedPDFModuleRight 

No "ConnectedPDF" module right.

noXFAModuleRight 

No "XFA" module right.

noRedactionModuleRight 

No "Redaction" module right.

noRMSModuleRight 

No "RMS" module right.

noOCRModuleRight 

No "OCR" module right.

noComparisonModuleRight 

No "Comparison" module right.

noComplianceModuleRight 

No "Compliance" module right.

noOptimizerModuleRight 

No "Optimizer" module right.

noConversionModuleRight 

No "Conversion" module right.

◆ File_Type

enum File_Type

Enumeration for file type. Values of this enumeration should be used alone.

Since
7.2.0
Enumerator
fdf 

FDF file.

xfdf 

XFDF file.

xml 

XML file.

csv 

CSV file.

txt 

TXT file.

json 

Json file.

Since
10.0.0

◆ FileAttachment_Icon

Enumeration for file attachment annot icons. Values of this enumeration should be used alone.

Since
7.2.0
Enumerator
graph 

Graph icon.

pushPin 

Push pin icon.

paperclip 

Paperclip icon.

tag 

Tag icon.

◆ Flatten_Option

Enumeration for flatten option. Values of this enumeration can be used alone or in combination.

Since
7.2.0
Enumerator
all 

Annotations and fields will be flattened.

field 

Fields will be flattened.

annot 

Annotations will be flattened.

◆ Font_Charset

Enumeration for font charset.

Values of this enumeration should be used alone.

Since
7.4.0
Enumerator
ANSI 

Font charset: ANSI (United States, Western Europe).

Default 

Font charset: System default, for unknown or mapping purpose.

Symbol 

Standard font: Symbol.

Font charset: Standard symbols.

Shift_JIS 

Font charset: Japanese (Shift-JIS).

Hangeul 

Font charset: Korean (Wansung).

GB2312 

Font charset: Simplified Chinese.

ChineseBig5 

Font charset: Traditional Chinese.

Thai 

Font charset: Thai.

EastEurope 

Font charset: Eastern European.

Russian 

Font charset: Russian.

Greek 

Font charset: Greek.

Turkish 

Font charset: Turkish.

Hebrew 

Font charset: Hebrew.

Arabic 

Font charset: Arabic.

Baltic 

Font charset: Baltic.

◆ Font_CIDCharset

Enumeration for CID font charset.

Values of this enumeration should be used alone.

Since
7.4.0
Enumerator
Unknown 

CID Font charset: Unknown.

GB1 

CID Font charset: Adobe-GB1.

CNS1 

CID Font charset: Adobe-CNS1.

JAPAN1 

CID Font charset: Adobe-Japan1.

KOREA1 

CID Font charset: Adobe-Korea1.

UNICODE 

CID Font charset: Unicode.

◆ Font_Descriptor_Flags

Enumeration for page number format type.

Values of this enumeration can be used alone or in combination.

Enumerator
FixedPitch 

All glyphs have the same width (as opposed to proportional or variablepitch fonts, which have different widths). Bit position: 1.

Font style: fixed pitch.

Serif 

Serif Glyphs have serifs, which are short strokes drawn at an angle on the top and bottom of glyph stems. (Sans serif fonts do not have serifs.). Bit position: 2.

Font style: serif.

Symbolic 

Symbolic Font contains glyphs outside the Standard Latin character set. This flag and the Nonsymbolic flag shall not both be set or both be clear. Bit position: 3.

Font style: symbolic.

Script 

Script Glyphs resemble cursive handwriting. Bit position: 4.

Font style: script.

Nonsymbolic 

Font uses the Standard Latin character set or a subset of it. This flag and the Symbolic flag shall not both be set or both be clear. Bit position: 6.

Italic 

Glyphs have dominant vertical strokes that are slanted. Bit position: 7.

Font style: italic.

AllCap 

Font contains no lowercase letters; typically used for display purposes, such as for titles or headlines. Bit position: 17.

Font style: all cap.

SmallCap 

Font contains both uppercase and lowercase letters. The uppercase letters are similar to those in the regular version of the same typeface family. The glyphs for the lowercase letters have the same shapes as the corresponding uppercase letters, but they are sized and their proportions adjusted so that they have the same size and stroke weight as lowercase glyphs in the same typeface family. Bit position: 18.

Font style: small cap.

ForceBold 

See description after Note 1 in this subclause. Bit position: 19.

◆ Font_StandardID

Enumeration for standard font ID.

Values of this enumeration should be used alone.

Since
7.4.0
Enumerator
Courier 

Standard font: Courier.

CourierB 

Standard font: Courier-Bold.

CourierBI 

Standard font: Courier-BoldOblique, Bold italic.

CourierI 

Standard font: Courier-Oblique, Italic.

Helvetica 

Standard font: Helvetica.

HelveticaB 

Standard font: Helvetica-Bold.

HelveticaBI 

Standard font: Helvetica-BoldOblique, Bold italic.

HelveticaI 

Standard font: Helvetica-Oblique, Italic.

Times 

Standard font: Times-Roman.

TimesB 

Standard font: Times-Bold.

TimesBI 

Standard font: Times-BoldItalic.

TimesI 

Standard font: Times-Italic.

Symbol 

Standard font: Symbol.

Font charset: Standard symbols.

ZapfDingbats 

Standard font: ZapfDingbats.

◆ Font_Style

enum Font_Style

Enumeration for font style.

Values of this enumeration should be used alone.

Since
7.4.0
Enumerator
normal 

Normal font style.

Save document normally, without using any special flag. This can only be used alone.

italic 

Italic font style.

bold 

Bold font style.

◆ Font_Styles

Enumeration for font styles.

Values of this enumeration can be used alone or in combination.

Since
7.4.0
Enumerator
FixedPitch 

All glyphs have the same width (as opposed to proportional or variablepitch fonts, which have different widths). Bit position: 1.

Font style: fixed pitch.

Serif 

Serif Glyphs have serifs, which are short strokes drawn at an angle on the top and bottom of glyph stems. (Sans serif fonts do not have serifs.). Bit position: 2.

Font style: serif.

Symbolic 

Symbolic Font contains glyphs outside the Standard Latin character set. This flag and the Nonsymbolic flag shall not both be set or both be clear. Bit position: 3.

Font style: symbolic.

Script 

Script Glyphs resemble cursive handwriting. Bit position: 4.

Font style: script.

NonSymbolic 

Font style: non-symbolic.

Italic 

Glyphs have dominant vertical strokes that are slanted. Bit position: 7.

Font style: italic.

AllCap 

Font contains no lowercase letters; typically used for display purposes, such as for titles or headlines. Bit position: 17.

Font style: all cap.

SmallCap 

Font contains both uppercase and lowercase letters. The uppercase letters are similar to those in the regular version of the same typeface family. The glyphs for the lowercase letters have the same shapes as the corresponding uppercase letters, but they are sized and their proportions adjusted so that they have the same size and stroke weight as lowercase glyphs in the same typeface family. Bit position: 18.

Font style: small cap.

Bold 

Font style: force bold.

◆ Graphics_FillMode

Enumeration for filling mode type, mainly for path graphics object.

Values of this enumeration should be used alone.

Since
7.4.0
Enumerator
None 

Fill mode: none.

Alternate 

Alternate fill mode, in which the system fills this area between odd-numbered and even-numbered polygon sides on each scan line.

Winding 

Winding fill mode, in which the system uses a direction in which a figure is drawn to determine whether to fill an area.

◆ Graphics_ObjectType

Enumeration for PDF graphics object type.

Values of this enumeration should be used alone.

Since
7.4.0
Enumerator
All 

Represents all graphics object types, only used as filter.

Text 

Text graphics object.

Path 

Path graphics object.

Image 

Image graphics object.

Shading 

Shading graphics object.

FormXObject 

Form XObject graphics object.

◆ Highlight_Mode

Enumeration for highlight mode. Values of this enumeration should be used alone.

Since
7.2.0
Enumerator
none 

No special highlight.

invert 

Invert highlight.

outline 

Outline highlight.

push 

Pushed highlight.

toggle 

Toggle highlight.

◆ MK_Properties

Enumeration for PDF MK property.

Values of this enumeration should be used alone.

Since
7.5.0
Enumerator
borderColor 

Border color entry. "BC" in MK dictionary. Not supported for barcode.

fillColor 

Background color entry. "BG" in MK dictionary. Not supported for barcode.

normalCaption 

Normal caption entry. "CA" in MK dictionary. Only applicable for widget annotation associated with pushbutton field, check box field or radio button field.

◆ NewWindowFlag

Enumeration for new window flag. Values of this enumeration should be used alone.

Since
9.1.0
Enumerator
NewWindowFlagFalse 

The destination document replaces current document in the same window.

NewWindowFlagTrue 

Open the destination document in a new window.

NewWindowFlagNone 

No such flag and the viewer application should behave in accordance with the current user preference.

◆ Note_Icon

enum Note_Icon

Enumeration for note annot icons. Values of this enumeration should be used alone.

Since
7.2.0
Enumerator
Check 

Check icon.

Circle 

Circle icon.

Comment 

Comment icon.

Cross 

Cross icon.

Help 

Help icon.

Insert 

Insert icon.

Key 

Key icon.

NewParagraph 

New paragraph icon.

Note 

Note icon.

Paragraph 

Paragraph icon.

RightArrow 

Right arrow icon.

RightPointer 

Right pointer icon.

Star 

Star icon.

UpArrow 

Up arrow icon.

UpLeftArrow 

Up left arrow icon.

◆ page_Number_Format

Enumeration for font styles.

Values of this enumeration can be used alone.

Enumerator
default 

If this is used, "1" would be used as the page number format string.

numberOfCount 

If this is used, "1 of n" would be used as the page number format string.

numberSlashCount 

If this is used, "1/n" would be used as the page number format string.

pageNumber 

If this is used, "Page 1" would be used as the page number format string.

pageNumberOfCount 

If this is used, "Page 1 of n" would be used as the page number format string.

◆ Point_Type

enum Point_Type

Enumeration for point type in path. Values of this enumeration should be used alone.

Since
7.2.0
Enumerator
moveTo 

Indicates that the point is the first point of a.

lineTo 

Indicates that a line is drawn from the previous point to this point.

lineToCloseFigure 

Indicates that a line is drawn from the previous point to this point, and this point will also be connected to the nearest POINT_TYPE.moveTo point before this point, in order to close current figure.

bezierTo 

Indicates that this point is a control point or ending point for a Bezier spline.

bezierToCloseFigure 

Indicates that this point is the ending point for a Bezier spline, and this point will also be connected to the nearest POINT_TYPE.bezierTo point before this point, in order to close current.

◆ POS_TYPE

enum POS_TYPE

Enumeration for PDF object position Type.

Values of this enumeration should be used alone.

Since
7.6.0
Enumerator
FIRST 

Moves to the front.

LAST 

Moves to the back.

AFTER 

Moves to the back of the target object.

Deprecated:
since 10.0 using NEXT instead.
BEFORE 

Moves to the front of the target object.

Deprecated:
since 10.0 using PREV instead.
NEXT 

Moves to the next of the target object.

PREV 

Moves to the previous of the target object.

◆ Position

enum Position

Enumeration for position. Values of this enumeration should be used alone.

Since
7.2.0
Enumerator
topLeft 

Top left position.

topCenter 

Top center position.

topRight 

Top right position.

centerLeft 

Center left position.

center 

Center position.

centerRight 

Center right position.

bottomLeft 

Bottom left position.

bottomCenter 

Bottom center position.

bottomRight 

Bottom right position.

◆ PosType

enum PosType

Enumeration for PDF target object position Type.

Values of this enumeration should be used alone.

Since
7.6.0
Enumerator
first 

Moves to the front.

last 

Moves to the back.

after 

Moves to the back of the target object.

Deprecated:
since 10.0 using NEXT instead.
before 

Moves to the front of the target object.

Deprecated:
since 10.0 using PREV instead.
next 

Moves to the next of the target object.

prev 

Moves to the previous of the target object.

◆ Range_Filter

Enumeration for range filter.

Values of this enumeration should be used alone.

Since
7.2.0
Enumerator
all 

All the indexes within a range will be used.

even 

Only even numbers in a range will be used (discards odd numbers).

odd 

Only odd numbers in a range will be used (discards even numbers).

◆ Relationship

Enumeration for Relationship. Values of this enumeration should be used alone.

Since
7.2.0
Enumerator
firstChild 

First child.

lastChild 

Last child.

previousSibling 

Previous sibling.

nextSibling 

Next sibling.

firstSibling 

First sibling.

lastSibling 

Last sibling.

◆ Rendering_Content

Enumeration for PDF rendering content.

Values of this enumeration can be used alone or in combination.

Since
7.2.0
Enumerator
page 

Render page.

annot 

Render annot.

form 

Render form.

◆ Rendering_Usage

Enumeration for PDF rendering usage.

Values of this enumeration should be used alone.

Since
7.2.0
Enumerator
print 

Render used for print.

view 

Render used for view.

◆ Rotation

enum Rotation

Enumeration for rotation. Values of this enumeration should be used alone.

Since
7.2.0
Enumerator
rotation0 

0 degree rotation.

rotation1 

90 degree rotation.

rotation2 

180 degree rotation.

rotation3 

270 degree rotation.

◆ Rotation_Degree

Enumeration for rotation. Values of this enumeration should be used alone.

Since
7.2.0
Enumerator
rotation0 

0 degree rotation.

rotation90 

90 degree rotation.

rotation180 

180 degree rotation.

rotation270 

270 degree rotation.

◆ Saving_Flag

Enumeration for PDF document saving flags.

Values of this enumeration can be used alone or in combination.

Since
7.2.0
Enumerator
normal 

Normal font style.

Save document normally, without using any special flag. This can only be used alone.

incremental 

Save document incrementally.

This can be used alone or be combined with other saving flags except PDFDoc::normal. Especially, if this is combined with PDFDoc::noOriginal, only the increment data will be saved.

noOriginal 

Save document without original data or unchanged objects.

This can be used alone or be combined with other saving flags except PDFDoc::Normal. Especially, if this is combined with PDFDoc::incremental, only the increment data will be saved.

XRefStream 

Save document by using XRef stream.

This can be used alone or be combined with other saving flags except PDFDoc::normal.

linearized 

Save document as a linearized file.

This should be used alone and cannot be used with other saving flags.

removeRedundantObjects 

Save document with removing redundant PDF objects.

This can be used alone or be combined with PDFDoc::noOriginal or PDFDoc::XRefStream.

◆ Search_Flag

Enumeration for search flag. Values of this enumeration can be used alone or in combination.

Since
7.2.0
Enumerator
caseSensitive 

If set, match the case of keyword when searching.

wholeWord 

If set, match the whole word of keyword when searching.

consecutively 

If set, match the key word consecutively when searching. For example, "CC" will be matched twice in "CCC".

◆ Signature_Ap_Flags

Enumeration for signature ap flag.

Values of this enumeration can be used alone or in combination.

Enumerator
showTagImage 

If set, show Foxit flag on signature appearance.

showLabel 

If set, show label on signature appearance.

showReason 

If set, show reason on signature appearance.

showDate 

If set, show signing time on signature appearance.

showDistinguishName 

If set, show distinguish name on signature appearance.

showLocation 

If set, show location on signature appearance.

showSigner 

If set, show signer on signature appearance.

showBitmap 

If set, show bitmap on signature appearance.

showText 

If set, show text content on signature appearance.

◆ Signature_State

Enumeration for signature state.

Values of this enumeration can be used alone or in combination.

Enumerator
VerifyErrorByteRange 

Non expected byte range.

verifyChange 

The document has been changed within the scope of the signature. (This indicates that signature is invalid.)

verifyIncredible 

Signature cannot be trusted (containing aggression).

verifyNoChange 

The document has not been changed within the scope of the signature.

stateVerifyIssueUnknown 

Verification state of the issuer is unknown.

verifyIssueValid 

Verification state of the issuer is valid.

verifyIssueUnknown 

Verification state of the issuer is unknown.

verifyIssueRevoke 

Certificate for verifying issuer is revoked.

verifyIssueExpire 

Certificate for verifying issuer is expired.

verifyIssueUncheck 

Not check the issuer.

verifyIssueCurrent 

The verified issue is current issuer.

verifyTimestampNone 

No time stamp or not check time stamp.

verifyTimestampDoc 

The signature is a time stamp signature.

verifyTimestampValid 

Verification state of the time stamp is valid.

verifyTimestampInvalid 

Verification state of the time stamp is invalid.

verifyTimestampExpire 

Verification state of the time stamp is expired.

verifyTimestampIssueUnknown 

Verification state of the time stamp issuer is unknown.

verifyTimestampIssueValid 

Verification state of the time stamp issuer is valid.

verifyTimestampTimeBefore 

Verification state of the time stamp time is valid, since the times is before the expiration date.

verifyChangeLegal 

The document has been changed outside of signature scope, but the changed is permitted.

verifyChangeIllegal 

The document has been changed outside of signature scope, and the changed invalidate the signature.

◆ Sound_Icon

enum Sound_Icon

Enumeration for sound annot icons. Values of this enumeration should be used alone.

Since
7.3.0
Enumerator
speaker 

Speaker icon.

mic 

Mic icon.

ear 

Ear icon.

◆ STAMP_TEXT_TYPE

Enumeration for dynamic stamp text type.

Values of this enumeration should be used alone.

Since
9.0.0
Enumerator
CUSTOM_TEXT 

Custom text.

NAME 

Author name.

NAME_DATE_TIME 

Author name, date and time.

DATE_TIME 

Date and time.

DATE 

Date.

◆ Standard_Font

Enumeration for font id. Values of this enumeration should be used alone.

Since
7.2.0
Enumerator
courier 

Standard font: Courier.

courierBold 

Standard font: Courier-Bold.

courierBoldOblique 

Standard font: Courier-BoldOblique, Bold italic.

courierOblique 

Standard font: Courier-Oblique, Italic.

helvetica 

Standard font: Helvetica.

helveticaBold 

Standard font: Helvetica-Bold.

helveticaBoldOblique 

Standard font: Helvetica-BoldOblique, Bold italic.

helveticaOblique 

Standard font: Helvetica-Oblique, Italic.

timesRoman 

Standard font: Times-Roman.

timesBold 

Standard font: Times-Bold.

timesBoldItalic 

Standard font: Times-BoldItalic.

timesItalic 

Standard font: Times-Italic.

symbol 

Standard font: Symbol.

zapfDingbats 

Standard font: ZapfDingbats.

◆ Text_Mode

enum Text_Mode

Enumeration for text mode.

Values of this enumeration should be used alone.

Since
7.4.0
Enumerator
Fill 

Text mode: fill text.

Stroke 

Text mode: stroke text.

FillStroke 

Text mode: fill and stroke text.

Invisible 

Text mode: neither fill nor stroke text, to make it invisible.

FillClip 

Text mode: fill text and add to path for clipping.

StrokeClip 

Text mode: stroke text and add to path for clipping.

FillStrokeClip 

Text mode: fill and stroke text, and add to path for clipping.

Clip 

Text mode: add text to path for clipping.

◆ User_Permissions

Enumeration for user access permissions in a PDF document.

Enumerator
print 

Print PDF document with normal mode. (Bit 3 in permission value)

modify 

Modify PDF contents. (Bit 4 in permission value)
If this value is set, user can modify contents of PDF document by operations other than those controlled by values User_Permissions::annotForm, User_Permissions::fillForm and User_Permissions::assemble.

extract 

Extract PDF contents. (Bit 5 in permission value)
If this value is set, user can copy or otherwise extract text and graphics from the document by operations other than that controlled by value User_Permissions::extractAccess.

annotForm 

Operate text annotations and fill in interactive form fields. (Bit 6 in permission value)
If value User_Permissions::modify is also set, user can create or modify interactive form fields (including signature fields).

fillForm 

Fill PDF form. (Bit 9 in permission value)
If this value is set, user can fill in interactive form fields (including signature fields), even if value User_Permissions::annotForm is not used.

extractAccess 

Disabilities support. (Bit 10 in permission value)
If this value is set, user can extract text and graphics in support of accessibility to users with disabilities or for other purposes.

assemble 

Assemble PDF document. (Bit 11 in permission value)
If this value is set, it enables to assemble the document (Insert, rotate, or delete pages and create bookmarks or thumbnail images), regardless if value User_Permissions::modify is set or not.

printHigh 

Print PDF document with higher qualities. (Bit 12 in permission value)
If this value is not set (and value User_Permissions::print is set), printing is limited to a low-level representation of the appearance, possibly of degraded quality.

◆ Watermark_Flag

Enumeration for watermark flag. Values of this enumeration can be used alone or in combination.

Since
7.2.0
Enumerator
asContent 

If set, the watermark will be a part of page content when inserted to a PDF page.

asAnnot 

If set, the watermark will be an annotation when inserted to a PDF page (Watermark_Flag.asContent will be disabled).

onTop 

If set, show watermark above other page content.

unprintable 

If set, do not print a watermark.

display 

If set, do not display a watermark.

◆ ZoomMode

enum ZoomMode

Enumeration for zoom mode. Values of this enumeration should be used alone.

Since
7.3.0
Enumerator
ZoomXYZ 

Display page with a specified position and a specified zoom factor.

ZoomFitPage 

Fit the entire page within the display area when display the page.

ZoomFitHorz 

Fit the entire width of the page within the display area when display the page.

ZoomFitRect 

Fit the page content in a specified rectangle entirely within the display area when display the page.

Foxit Software Corporation Logo
@2024 Foxit Software Incorporated. All rights reserved.