Foxit PDF SDK
Enumerations

Enumerations

enum  FSActionCallbackAppInfoType {
  FSActionCallbackAppInfoTypeFormsVersion = 0x0, FSActionCallbackAppInfoTypeViewerType = 0x01, FSActionCallbackAppInfoTypeViewerVariation = 0x02, FSActionCallbackAppInfoTypeViewerVersion = 0x03,
  FSActionCallbackAppInfoTypeAppVersion = 0x04
}
 Enumeration for application's information type.
More...
 
enum  FSActionCallbackLanguage {
  FSActionCallbackLanguageUnknown = 0, FSActionCallbackLanguageCHS = 1, FSActionCallbackLanguageCHT = 2, FSActionCallbackLanguageDAN = 3,
  FSActionCallbackLanguageDEU = 4, FSActionCallbackLanguageENU = 5, FSActionCallbackLanguageESP = 6, FSActionCallbackLanguageFRA = 7,
  FSActionCallbackLanguageITA = 8, FSActionCallbackLanguageKOR = 9, FSActionCallbackLanguageJPN = 10, FSActionCallbackLanguageNLD = 11,
  FSActionCallbackLanguageNOR = 12, FSActionCallbackLanguagePTB = 13, FSActionCallbackLanguageSUO = 14, FSActionCallbackLanguageSVE = 15
}
 Enumeration for language.
More...
 
enum  FSActionCallbackMailType { FSActionCallbackMailTypeDoc = 0, FSActionCallbackMailTypeForm = 1, FSActionCallbackMailTypeMsg = 2 }
 Enumeration for data type to be mailed.
More...
 
enum  FSActionNewWindowFlag { FSActionNewWindowFlagFalse = 0, FSActionNewWindowFlagTrue = 1, FSActionNewWindowFlagNone = 2 }
 Enumeration for new window flag.
More...
 
enum  FSActionType {
  FSActionTypeUnknown = 0, FSActionTypeGoto = 1, FSActionTypeGoToR = 2, FSActionTypeGoToE = 3,
  FSActionTypeLaunch = 4, FSActionTypeThread = 5, FSActionTypeURI = 6, FSActionTypeSound = 7,
  FSActionTypeMovie = 8, FSActionTypeHide = 9, FSActionTypeNamed = 10, FSActionTypeSubmitForm = 11,
  FSActionTypeResetForm = 12, FSActionTypeImportData = 13, FSActionTypeJavaScript = 14, FSActionTypeSetOCGState = 15,
  FSActionTypeRendition = 16, FSActionTypeTrans = 17, FSActionTypeGoTo3DView = 18
}
 Enumeration for action type.
More...
 
enum  FSAdditionalActionTriggerEvent {
  FSAdditionalActionTriggerPageOpened = 0, FSAdditionalActionTriggerPageClosed = 1, FSAdditionalActionTriggerDocWillClose = 2, FSAdditionalActionTriggerDocWillSave = 3,
  FSAdditionalActionTriggerDocSaved = 4, FSAdditionalActionTriggerDocWillPrint = 5, FSAdditionalActionTriggerDocPrinted = 6, FSAdditionalActionTriggerFieldKeyStroke = 7,
  FSAdditionalActionTriggerFieldWillFormat = 8, FSAdditionalActionTriggerFieldValueChanged = 9, FSAdditionalActionTriggerFieldRecalculateValue = 10, FSAdditionalActionTriggerAnnotCursorEnter = 11,
  FSAdditionalActionTriggerAnnotCursorExit = 12, FSAdditionalActionTriggerAnnotMouseButtonPressed = 13, FSAdditionalActionTriggerAnnotMouseButtonReleased = 14, FSAdditionalActionTriggerAnnotReceiveInputFocus = 15,
  FSAdditionalActionTriggerAnnotLoseInputFocus = 16, FSAdditionalActionTriggerAnnotPageOpened = 17, FSAdditionalActionTriggerAnnotPageClosed = 18, FSAdditionalActionTriggerAnnotPageVisible = 19,
  FSAdditionalActionTriggerAnnotPageInvisible = 20
}
 Enumeration for trigger event.
More...
 
enum  FSAlignment { FSAlignmentLeft = 0, FSAlignmentCenter = 1, FSAlignmentRight = 2 }
 Enumeration for alignment (horizontal).
More...
 
enum  FSAnnotAppearanceType { FSAnnotAppearanceTypeNormal = 0, FSAnnotAppearanceTypeRollover = 1, FSAnnotAppearanceTypeDown = 2 }
 Enumeration for the type of annotation's appearance.
More...
 
enum  FSAnnotFlags {
  FSAnnotFlagInvisible = 0x0001, FSAnnotFlagHidden = 0x0002, FSAnnotFlagPrint = 0x0004, FSAnnotFlagNoZoom = 0x0008,
  FSAnnotFlagNoRotate = 0x0010, FSAnnotFlagNoView = 0x0020, FSAnnotFlagReadOnly = 0x0040, FSAnnotFlagLocked = 0x0080,
  FSAnnotFlagToggleNoView = 0x0100, FSAnnotFlagLockedContents = 0x0200
}
 Enumeration for PDF annotation flags.
More...
 
enum  FSAnnotHighlightingMode {
  FSAnnotHighlightingNone = 0, FSAnnotHighlightingInvert = 1, FSAnnotHighlightingOutline = 2, FSAnnotHighlightingPush = 3,
  FSAnnotHighlightingToggle = 4
}
 Enumeration for PDF annotation highlighting mode.
More...
 
enum  FSAnnotMKEntry {
  FSAnnotMKEntryRotation = 0, FSAnnotMKEntryBorderColor = 1, FSAnnotMKEntryBackgroundColor = 2, FSAnnotMKEntryNormalCaption = 3,
  FSAnnotMKEntryRolloverCaption = 4, FSAnnotMKEntryDownCaption = 5, FSAnnotMKEntryNormalIcon = 6, FSAnnotMKEntryRolloverIcon = 7,
  FSAnnotMKEntryDownIcon = 8, FSAnnotMKEntryIconFit = 9, FSAnnotMKEntryIconCaptionRelation = 10
}
 Enumeration for annotation's MK dictionary (an appearance characteristics) entry.
More...
 
enum  FSAnnotMKIconCaptionRelation {
  FSAnnotMKRelationNoIcon = 0, FSAnnotMKRelationNoCaption = 1, FSAnnotMKRelationCaptionBelowIcon = 2, FSAnnotMKRelationCaptionAboveIcon = 3,
  FSAnnotMKRelationCaptionRight = 4, FSAnnotMKRelationCaptionLeft = 5, FSAnnotMKRelationCaptionOvrlayOnIcon = 6
}
 Enumeration for icon and caption relative position in annotation's MK dictionary.
More...
 
enum  FSAnnotProperty { FSAnnotPropertyModifiedDate = 0, FSAnnotPropertyCreationDate = 1, FSAnnotPropertyBorderColor = 2, FSAnnotPropertyFillColor = 3 }
 Enumeration for some PDF annotation property.
More...
 
enum  FSAnnotType {
  FSAnnotUnknownType = 0, FSAnnotNote = 1, FSAnnotLink = 2, FSAnnotFreeText = 3,
  FSAnnotLine = 4, FSAnnotSquare = 5, FSAnnotCircle = 6, FSAnnotPolygon = 7,
  FSAnnotPolyLine = 8, FSAnnotHighlight = 9, FSAnnotUnderline = 10, FSAnnotSquiggly = 11,
  FSAnnotStrikeOut = 12, FSAnnotStamp = 13, FSAnnotCaret = 14, FSAnnotInk = 15,
  FSAnnotPSInk = 16, FSAnnotFileAttachment = 17, FSAnnotSound = 18, FSAnnotMovie = 19,
  FSAnnotWidget = 20, FSAnnotScreen = 21, FSAnnotPrinterMark = 22, FSAnnotTrapNet = 23,
  FSAnnotWatermark = 24, FSAnnot3D = 25, FSAnnotPopup = 26, FSAnnotRedact = 27
}
 Enumeration for PDF annotation type.
More...
 
enum  FSAppProviderCallbackAppInfo {
  FSAppProviderCallbackAppInfoVersion = 0x0, FSAppProviderCallbackAppInfoLanguage = 0x01, FSAppProviderCallbackAppInfoPlatform = 0x02, FSAppProviderCallbackAppInfoVariation = 0x03,
  FSAppProviderCallbackAppInfoName = 0x04, FSAppProviderCallbackAppInfoType = 0x05
}
 Enumeration for XFA application information type.
More...
 
enum  FSAppProviderCallbackBeepType {
  FSAppProviderCallbackBeepTypeError = 0, FSAppProviderCallbackBeepTypeWarning = 1, FSAppProviderCallbackBeepTypeQuestion = 2, FSAppProviderCallbackBeepTypeStatus = 3,
  FSAppProviderCallbackBeepTypeDefault = 4
}
 Enumeration for XFA beep type.
More...
 
enum  FSAppProviderCallbackMsgBoxButtonID { FSAppProviderCallbackMsgBtnIDOK = 1, FSAppProviderCallbackMsgBtnIDCancel = 2, FSAppProviderCallbackMsgBtnIDNo = 3, FSAppProviderCallbackMsgBtnIDYes = 4 }
 Enumeration for button ID of XFA message box.
More...
 
enum  FSAppProviderCallbackMsgBoxButtonType { FSAppProviderCallbackMsgBtnTypeOK = 0, FSAppProviderCallbackMsgBtnTypeOKCancel = 1, FSAppProviderCallbackMsgBtnTypeYesNo = 2, FSAppProviderCallbackMsgBtnTypeYesNoCancel = 3 }
 Enumeration for button type of XFA message box.
More...
 
enum  FSAppProviderCallbackMsgBoxIconType { FSAppProviderCallbackMsgBoxIconError = 0, FSAppProviderCallbackMsgBoxIconWarning = 1, FSAppProviderCallbackMsgBoxIconQuestion = 2, FSAppProviderCallbackMsgBoxIconStatus = 3 }
 Enumeration for icon type of XFA message box.
More...
 
enum  FSAppProviderCallbackStringID {
  FSAppProviderCallbackStringIDValidateFailed = 1, FSAppProviderCallbackStringIDCalcOverride = 2, FSAppProviderCallbackStringIDModifyField = 3, FSAppProviderCallbackStringIDNotModifyField = 4,
  FSAppProviderCallbackStringIDAppName = 5, FSAppProviderCallbackStringIDImageFilter = 6, FSAppProviderCallbackStringIDUnknownCaught = 7, FSAppProviderCallbackStringIDUnableToSet = 8,
  FSAppProviderCallbackStringIDValueExcalmatory = 9, FSAppProviderCallbackStringIDInvalidEnumValue = 10, FSAppProviderCallbackStringIDUnsupportMethod = 11, FSAppProviderCallbackStringIDUnsupportProperty = 12,
  FSAppProviderCallbackStringIDInvalidPropertySetOperation = 13, FSAppProviderCallbackStringIDNotDefaultValue = 14, FSAppProviderCallbackStringIDUnableSetLanguage = 15, FSAppProviderCallbackStringIDUnableSetNumPages = 16,
  FSAppProviderCallbackStringIDUnableSetPlatformValue = 17, FSAppProviderCallbackStringIDUnableSetValidationsEnabledValue = 18, FSAppProviderCallbackStringIDUnableSetValidationsValue = 19, FSAppProviderCallbackStringIDUnableSetVersion = 20,
  FSAppProviderCallbackStringIDUnableSetReady = 21, FSAppProviderCallbackStringIDNumberOfOccur = 22, FSAppProviderCallbackStringIDUnableSetClassName = 23, FSAppProviderCallbackStringIDUnableSetLengthValue = 24,
  FSAppProviderCallbackStringIDUnsupportChar = 25, FSAppProviderCallbackStringIDBadSuffix = 26, FSAppProviderCallbackStringIDExpectedIdent = 27, FSAppProviderCallbackStringIDExpectedString = 28,
  FSAppProviderCallbackStringIDInvalidateChar = 29, FSAppProviderCallbackStringIDRedefinition = 30, FSAppProviderCallbackStringIDInvalidToken = 31, FSAppProviderCallbackStringIDInvalidExpression = 32,
  FSAppProviderCallbackStringIDUndefineIdentifier = 33, FSAppProviderCallbackStringIDInvalidateLeftValue = 34, FSAppProviderCallbackStringIDCompilerError = 35, FSAppProviderCallbackStringIDCannotModifyValue = 36,
  FSAppProviderCallbackStringIDParametersError = 37, FSAppProviderCallbackStringIDExpectedEndIf = 38, FSAppProviderCallbackStringIDUnexpectedExpression = 39, FSAppProviderCallbackStringIDConditionIsNull = 40,
  FSAppProviderCallbackStringIDIllegalBreak = 41, FSAppProviderCallbackStringIDIllegalContinue = 42, FSAppProviderCallbackStringIDExpectedOperator = 43, FSAppProviderCallbackStringIDDivideZero = 44,
  FSAppProviderCallbackStringIDCannotCovertToObject = 45, FSAppProviderCallbackStringIDNotFoundContainer = 46, FSAppProviderCallbackStringIDNotFoundProperty = 47, FSAppProviderCallbackStringIDNotFoundMethod = 48,
  FSAppProviderCallbackStringIDNotFoundConst = 49, FSAppProviderCallbackStringIDNotAssignObject = 50, FSAppProviderCallbackStringIDInvalidateInstruction = 51, FSAppProviderCallbackStringIDExpectedNumber = 52,
  FSAppProviderCallbackStringIDValidateOutOfArray = 53, FSAppProviderCallbackStringIDCannotAssign = 54, FSAppProviderCallbackStringIDNotFoundFunction = 55, FSAppProviderCallbackStringIDIsNotArray = 56,
  FSAppProviderCallbackStringIDOutOfArrayRange = 57, FSAppProviderCallbackStringIDNotSupportArrayCalculate = 58, FSAppProviderCallbackStringIDArgumentNotArray = 59, FSAppProviderCallbackStringIDArgumentExpectContainer = 60,
  FSAppProviderCallbackStringIDAccessProertyInNotObject = 61, FSAppProviderCallbackStringIDFunctionBuildIn = 62, FSAppProviderCallbackStringIDErrorMessage = 63, FSAppProviderCallbackStringIDIndexValueOutOfBounds = 64,
  FSAppProviderCallbackStringIDIncorrectNumberOfMethod = 65, FSAppProviderCallbackStringIDArgumentMismatch = 66, FSAppProviderCallbackStringIDInvalidEnumerate = 67, FSAppProviderCallbackStringIDInvalidAppend = 68,
  FSAppProviderCallbackStringIDSOMExpectedList = 69, FSAppProviderCallbackStringIDNotHaveProperty = 70, FSAppProviderCallbackStringIDInvalidNodeType = 71, FSAppProviderCallbackStringIDViolateBoundary = 72,
  FSAppProviderCallbackStringIDServerDeny = 73, FSAppProviderCallbackStringIDWeekDaySun = 74, FSAppProviderCallbackStringIDWeekDayMon = 75, FSAppProviderCallbackStringIDWeekDayTue = 76,
  FSAppProviderCallbackStringIDWeekDayWed = 77, FSAppProviderCallbackStringIDWeekDayThu = 78, FSAppProviderCallbackStringIDWeekDayFri = 79, FSAppProviderCallbackStringIDWeekDaySat = 80,
  FSAppProviderCallbackStringIDMonthJan = 81, FSAppProviderCallbackStringIDMonthFeb = 82, FSAppProviderCallbackStringIDMonthMarch = 83, FSAppProviderCallbackStringIDMonthApril = 84,
  FSAppProviderCallbackStringIDMonthMay = 85, FSAppProviderCallbackStringIDMonthJune = 86, FSAppProviderCallbackStringIDMonthJuly = 87, FSAppProviderCallbackStringIDMonthAug = 88,
  FSAppProviderCallbackStringIDMonthSep = 89, FSAppProviderCallbackStringIDMonthOct = 90, FSAppProviderCallbackStringIDMonthNov = 91, FSAppProviderCallbackStringIDMonthDec = 92,
  FSAppProviderCallbackStringIDToday = 93, FSAppProviderCallbackStringIDValidateLimit = 94, FSAppProviderCallbackStringIDValidateNullWarning = 95, FSAppProviderCallbackStringIDValidateNullError = 96,
  FSAppProviderCallbackStringIDValidateWarning = 97, FSAppProviderCallbackStringIDValidateError = 98, FSAppProviderCallbackStringIDValidateNumberError = 99, FSAppProviderCallbackStringIDScriptFailedError = 100,
  FSAppProviderCallbackStringIDScriptInvalidValue = 101, FSAppProviderCallbackStringIDSubmitValidateNullError = 102
}
 Enumeration for string ID used to specify a case.
More...
 
enum  FSAssociatedFilesRelationship {
  FSAssociatedFilesRelationshipUnspecified = 0, FSAssociatedFilesRelationshipSource = 1, FSAssociatedFilesRelationshipData = 2, FSAssociatedFilesRelationshipAlternative = 3,
  FSAssociatedFilesRelationshipSupplement = 4, FSAssociatedFilesRelationshipEncryptedPayload = 5, FSAssociatedFilesRelationshipFormData = 6, FSAssociatedFilesRelationshipSchema = 7
}
 Enumeration for the relationship between PDF document and the associated file.
More...
 
enum  FSBarcodeFormat {
  FSBarcodeFormatCode39 = 0, FSBarcodeFormatCode128 = 1, FSBarcodeFormatEAN8 = 2, FSBarcodeFormatUPCA = 3,
  FSBarcodeFormatEAN13 = 4, FSBarcodeFormatITF = 5, FSBarcodeFormatPDF417 = 6, FSBarcodeFormatQRCode = 7
}
 Enumeration for barcode format.
More...
 
enum  FSBarcodeQRErrorCorrectionLevel { FSBarcodeQRCorrectionLevelLow = 0, FSBarcodeQRCorrectionLevelMedium = 1, FSBarcodeQRCorrectionLevelQuater = 2, FSBarcodeQRCorrectionLevelHigh = 3 }
 Enumeration for format error correction level of QR Code.
More...
 
enum  FSBitmapDIBFormat {
  FSBitmapDIBInvalid = 0, FSBitmapDIBRgb = 0x018, FSBitmapDIBRgb32 = 0x020, FSBitmapDIBArgb = 0x220,
  FSBitmapDIB8bppMask = 0x108, FSBitmapDIB8bpp = 0x008, FSBitmapDIBRgb565 = 0x565
}
 Enumeration for DIB format.
More...
 
enum  FSBitmapInterpolationFlag { FSBitmapDownsample = 0x01, FSBitmapQuadratic = 0x02, FSBitmapBicubic = 0x04 }
 Enumeration for bitmap interpolation flags.
More...
 
enum  FSBookmarkPosition {
  FSBookmarkPosFirstChild = 0, FSBookmarkPosLastChild = 1, FSBookmarkPosPrevSibling = 2, FSBookmarkPosNextSibling = 3,
  FSBookmarkPosFirstSibling = 4, FSBookmarkPosLastSibling = 5
}
 Enumeration for bookmark position.
More...
 
enum  FSBookmarkStyle { FSBookmarkStyleNormal = 0x00, FSBookmarkStyleItalic = 0x01, FSBookmarkStyleBold = 0x02 }
 Enumeration for bookmark style type.
More...
 
enum  FSBorderInfoStyle {
  FSBorderInfoSolid = 0, FSBorderInfoDashed = 1, FSBorderInfoUnderLine = 2, FSBorderInfoBeveled = 3,
  FSBorderInfoInset = 4, FSBorderInfoCloudy = 5
}
 Enumeration for PDF annotation border style.
More...
 
enum  FSCompareResultInfoCompareResultType {
  FSCompareResultInfoCompareResultTypeNone = -1, FSCompareResultInfoCompareResultTypeDeleteText = 0, FSCompareResultInfoCompareResultTypeInsertText = 1, FSCompareResultInfoCompareResultTypeReplaceText = 2,
  FSCompareResultInfoCompareResultTypeDeleteTable = 3, FSCompareResultInfoCompareResultTypeInsertTable = 4, FSCompareResultInfoCompareResultTypeReplaceTable = 5, FSCompareResultInfoCompareResultTypeDeleteImage = 6,
  FSCompareResultInfoCompareResultTypeInsertImage = 7, FSCompareResultInfoCompareResultTypeReplaceImage = 8, FSCompareResultInfoCompareResultTypeDeletePath = 9, FSCompareResultInfoCompareResultTypeInsertPath = 10,
  FSCompareResultInfoCompareResultTypeReplacePath = 11, FSCompareResultInfoCompareResultTypeDeleteShading = 12, FSCompareResultInfoCompareResultTypeInsertShading = 13, FSCompareResultInfoCompareResultTypeReplaceShading = 14,
  FSCompareResultInfoCompareResultTypeDeleteAnnot = 15, FSCompareResultInfoCompareResultTypeInsertAnnot = 16, FSCompareResultInfoCompareResultTypeReplaceAnnot = 17, FSCompareResultInfoCompareResultTypeTextAttriChange = 18
}
 Enumeration for compare result type.
More...
 
enum  FSComparisonCompareType { FSComparisonCompareTypeText = 0x00000001, FSComparisonCompareTypeTable = 0x00000002 }
 Enumeration for compare type flags.
More...
 
enum  FSConnectedPDFEncryptType { FSConnectedPDFEncryptTypeAES = 1, FSConnectedPDFEncryptTypeSM4CBC = 2 }
 Enumeration for encryption mode.
More...
 
enum  FSDefaultAppearanceDefAPFlags { FSDefaultAppearanceFlagFont = 0x0001, FSDefaultAppearanceFlagTextColor = 0x0002, FSDefaultAppearanceFlagFontSize = 0x0004 }
 Enumeration for default appearance flags.
More...
 
enum  FSDestinationZoomMode {
  FSDestinationZoomXYZ = 1, FSDestinationZoomFitPage = 2, FSDestinationZoomFitHorz = 3, FSDestinationZoomFitVert = 4,
  FSDestinationZoomFitRect = 5, FSDestinationZoomFitBBox = 6, FSDestinationZoomFitBHorz = 7, FSDestinationZoomFitBVert = 8
}
 Enumeration for zoom mode.
More...
 
enum  FSDocProviderCallbackInvalidateFlag { FSDocProviderCallbackInvalidateFlagAllPages = 0, FSDocProviderCallbackInvalidateFlagCurrentPage = 1 }
 Enumeration for XFA invalidate flag.
More...
 
enum  FSDocProviderCallbackPageViewEventType { FSDocProviderCallbackPageViewEventTypeAdded = 0, FSDocProviderCallbackPageViewEventTypeRemoved = 1, FSDocProviderCallbackPageViewEventTypeAllRemoved = 2 }
 Enumeration for the event type of page view.
More...
 
enum  FSDocProviderCallbackPrintOption {
  FSDocProviderCallbackPrintOptionShowDialog = 0x00000001, FSDocProviderCallbackPrintOptionCanCancel = 0x00000002, FSDocProviderCallbackPrintOptionShrinkPage = 0x00000004, FSDocProviderCallbackPrintOptionAsImage = 0x00000008,
  FSDocProviderCallbackPrintOptionReverseOrder = 0x00000010, FSDocProviderCallbackPrintOptionPrintAnnot = 0x00000020
}
 Enumeration for XFA print options.
More...
 
enum  FSDocProviderCallbackSubmitFormat {
  FSDocProviderCallbackSubmitInXDP = 0, FSDocProviderCallbackSubmitInPDF = 1, FSDocProviderCallbackSubmitInUrlEncoded = 2, FSDocProviderCallbackSubmitInXFD = 3,
  FSDocProviderCallbackSubmitInXML = 4
}
 Enumeration for XFA submit format.
More...
 
enum  FSDocProviderCallbackTextEncoding {
  FSDocProviderCallbackTextEncodingNone = 0, FSDocProviderCallbackTextEncodingBig5 = 1, FSDocProviderCallbackTextEncodingFontSpecific = 2, FSDocProviderCallbackTextEncodingGBK = 3,
  FSDocProviderCallbackTextEncodingGB18030 = 4, FSDocProviderCallbackTextEncodingGB2312 = 5, FSDocProviderCallbackTextEncodingISO8859NN = 6, FSDocProviderCallbackTextEncodingKSC5601 = 7,
  FSDocProviderCallbackTextEncodingShiftJIS = 8, FSDocProviderCallbackTextEncodingUCS2 = 9, FSDocProviderCallbackTextEncodingUTF16 = 10, FSDocProviderCallbackTextEncodingUTF8 = 11
}
 Enumeration for text encoding for XFA submit.
More...
 
enum  FSDocProviderCallbackWidgetEventType { FSDocProviderCallbackWidgetEventTypeAdded = 0, FSDocProviderCallbackWidgetEventTypeBeforeRemoved = 1 }
 Enumeration for the type of XFA widget event.
More...
 
enum  FSDocViewerPrefsPrintScale { FSDocViewerPrefsPrintScaleNone = 0, FSDocViewerPrefsPrintScaleAppDefault = 1 }
 Enumeration for page scaling option.
More...
 
enum  FSDocViewerPrefsViewerPref {
  FSDocViewerPrefsHideToolbar = 0, FSDocViewerPrefsHideMenubar = 1, FSDocViewerPrefsHideWindowUI = 2, FSDocViewerPrefsFitWindow = 3,
  FSDocViewerPrefsCenterWindow = 4, FSDocViewerPrefsDisplayDocTitle = 5
}
 Enumeration for how various GUI elements should behave when the document is opened.
More...
 
enum  FSErrorCode {
  FSErrSuccess = 0, FSErrFile = 1, FSErrFormat = 2, FSErrPassword = 3,
  FSErrHandle = 4, FSErrCertificate = 5, FSErrUnknown = 6, FSErrInvalidLicense = 7,
  FSErrParam = 8, FSErrUnsupported = 9, FSErrOutOfMemory = 10, FSErrSecurityHandler = 11,
  FSErrNotParsed = 12, FSErrNotFound = 13, FSErrInvalidType = 14, FSErrConflict = 15,
  FSErrUnknownState = 16, FSErrDataNotReady = 17, FSErrInvalidData = 18, FSErrXFALoadError = 19,
  FSErrNotLoaded = 20, FSErrInvalidState = 21, FSErrNotCDRM = 22, FSErrCanNotConnectToServer = 23,
  FSErrInvalidUserToken = 24, FSErrNoRights = 25, FSErrRightsExpired = 26, FSErrDeviceLimitation = 27,
  FSErrCanNotRemoveSecurityFromServer = 28, FSErrCanNotGetACL = 29, FSErrCanNotSetACL = 30, FSErrIsAlreadyCPDF = 31,
  FSErrIsAlreadyCDRM = 32, FSErrCanNotUploadDocInfo = 33, FSErrCanNotUploadCDRMInfo = 34, FSErrInvalidWrapper = 35,
  FSErrCanNotGetClientID = 36, FSErrCanNotGetUserToken = 37, FSErrInvalidACL = 38, FSErrInvalidClientID = 39,
  FSErrOCREngineNotInit = 40, FSErrDiskFull = 41, FSErrOCRTrialIsEnd = 42, FSErrFilePathNotExist = 43,
  FSErrComplianceEngineNotInit = 44, FSErrComplianceEngineInvalidUnlockCode = 45, FSErrComplianceEngineInitFailed = 46
}
 Enumeration for error code.
More...
 
enum  FSFDFDocType { FSFDFDocFDF = 0, FSFDFDocXFDF = 1 }
 Enumeration for FDF document type.
More...
 
enum  FSFieldFlags {
  FSFieldFlagReadOnly = 0x01, FSFieldFlagRequired = 0x02, FSFieldFlagNoExport = 0x04, FSFieldFlagButtonNoToggleToOff = 0x100,
  FSFieldFlagButtonRadiosInUnison = 0x200, FSFieldFlagTextMultiline = 0x100, FSFieldFlagTextPassword = 0x200, FSFieldFlagTextDoNotScroll = 0x400,
  FSFieldFlagTextComb = 0x800, FSFieldFlagComboEdit = 0x100, FSFieldFlagChoiseMultiSelect = 0x100
}
 Enumeration for form field flags.
More...
 
enum  FSFieldType {
  FSFieldTypeUnknown = 0, FSFieldTypePushButton = 1, FSFieldTypeCheckBox = 2, FSFieldTypeRadioButton = 3,
  FSFieldTypeComboBox = 4, FSFieldTypeListBox = 5, FSFieldTypeTextField = 6, FSFieldTypeSignature = 7
}
 Enumeration for form field type.
More...
 
enum  FSFillerEventFlags {
  FSFillerEventFlagShiftKey = 0x0001, FSFillerEventFlagControlKey = 0x0002, FSFillerEventFlagAltKey = 0x0004, FSFillerEventFlagMetaKey = 0x0008,
  FSFillerEventFlagKeyPad = 0x0010, FSFillerEventFlagAutoRepeat = 0x0020, FSFillerEventFlagLeftButtonDown = 0x0040, FSFillerEventFlagMiddleButtonDown = 0x0080,
  FSFillerEventFlagRightButtonDown = 0x0100, FSFillerEventFlagCommand = 0x0200
}
 Enumeration for key event flags.
More...
 
enum  FSFillerVirtualKeyCode {
  FSFillerVkeyUnknown = 0x00, FSFillerVkeyBack = 0x08, FSFillerVkeyTab = 0x09, FSFillerVkeyReturn = 0x0D,
  FSFillerVkeyShift = 0x10, FSFillerVkeyControl = 0x11, FSFillerVkeyMenu = 0x12, FSFillerVkeyPause = 0x13,
  FSFillerVkeyEscape = 0x1B, FSFillerVkeySpace = 0x20, FSFillerVkeyPrior = 0x21, FSFillerVkeyNext = 0x22,
  FSFillerVkeyEnd = 0x23, FSFillerVkeyHome = 0x24, FSFillerVkeyLeft = 0x25, FSFillerVkeyUp = 0x26,
  FSFillerVkeyRight = 0x27, FSFillerVkeyDown = 0x28, FSFillerVkeyPrint = 0x2A, FSFillerVkeySnapshot = 0x2C,
  FSFillerVkeyInsert = 0x2D, FSFillerVkeyDelete = 0x2E, FSFillerVkeyHelp = 0x2F, FSFillerVkey0 = 0x30,
  FSFillerVkey1 = 0x31, FSFillerVkey2 = 0x32, FSFillerVkey3 = 0x33, FSFillerVkey4 = 0x34,
  FSFillerVkey5 = 0x35, FSFillerVkey6 = 0x36, FSFillerVkey7 = 0x37, FSFillerVkey8 = 0x38,
  FSFillerVkey9 = 0x39, FSFillerVkeyA = 0x41, FSFillerVkeyB = 0x42, FSFillerVkeyC = 0x43,
  FSFillerVkeyD = 0x44, FSFillerVkeyE = 0x45, FSFillerVkeyF = 0x46, FSFillerVkeyG = 0x47,
  FSFillerVkeyH = 0x48, FSFillerVkeyI = 0x49, FSFillerVkeyJ = 0x4A, FSFillerVkeyK = 0x4B,
  FSFillerVkeyL = 0x4C, FSFillerVkeyM = 0x4D, FSFillerVkeyN = 0x4E, FSFillerVkeyO = 0x4F,
  FSFillerVkeyP = 0x50, FSFillerVkeyQ = 0x51, FSFillerVkeyR = 0x52, FSFillerVkeyS = 0x53,
  FSFillerVkeyT = 0x54, FSFillerVkeyU = 0x55, FSFillerVkeyV = 0x56, FSFillerVkeyW = 0x57,
  FSFillerVkeyX = 0x58, FSFillerVkeyY = 0x59, FSFillerVkeyZ = 0x5A, FSFillerVkeyNumpad0 = 0x60,
  FSFillerVkeyNumpad1 = 0x61, FSFillerVkeyNumpad2 = 0x62, FSFillerVkeyNumpad3 = 0x63, FSFillerVkeyNumpad4 = 0x64,
  FSFillerVkeyNumpad5 = 0x65, FSFillerVkeyNumpad6 = 0x66, FSFillerVkeyNumpad7 = 0x67, FSFillerVkeyNumpad8 = 0x68,
  FSFillerVkeyNumpad9 = 0x69, FSFillerVkeyMultiply = 0x6A, FSFillerVkeyAdd = 0x6B, FSFillerVkeySeparator = 0x6C,
  FSFillerVkeySubtract = 0x6D, FSFillerVkeyDecimal = 0x6E, FSFillerVkeyDivide = 0x6F, FSFillerVkeyF1 = 0x70,
  FSFillerVkeyF2 = 0x71, FSFillerVkeyF3 = 0x72, FSFillerVkeyF4 = 0x73, FSFillerVkeyF5 = 0x74,
  FSFillerVkeyF6 = 0x75, FSFillerVkeyF7 = 0x76, FSFillerVkeyF8 = 0x77, FSFillerVkeyF9 = 0x78,
  FSFillerVkeyF10 = 0x79, FSFillerVkeyF11 = 0x7A, FSFillerVkeyF12 = 0x7B
}
 Enumeration for virtual key code.
More...
 
enum  FSFillMode { FSFillModeNone = 0, FSFillModeAlternate = 1, FSFillModeWinding = 2 }
 Enumeration for filling mode type, mainly for path graphics object.
More...
 
enum  FSFixupDataFixupState { FSFixupDataFixupStateSuccess = 0, FSFixupDataFixupStateFailure = 1, FSFixupDataFixupStateNotRequired = 2 }
 Enumeration for the state of a fixup data.
More...
 
enum  FSFontCharset {
  FSFontCharsetANSI = 0, FSFontCharsetDefault = 1, FSFontCharsetSymbol = 2, FSFontCharsetShift_JIS = 128,
  FSFontCharsetHangeul = 129, FSFontCharsetGB2312 = 134, FSFontCharsetChineseBig5 = 136, FSFontCharsetThai = 222,
  FSFontCharsetEastEurope = 238, FSFontCharsetRussian = 204, FSFontCharsetGreek = 161, FSFontCharsetTurkish = 162,
  FSFontCharsetHebrew = 177, FSFontCharsetArabic = 178, FSFontCharsetBaltic = 186
}
 Enumeration for font charset.
More...
 
enum  FSFontStandardID {
  FSFontStdIDCourier = 0, FSFontStdIDCourierB = 1, FSFontStdIDCourierBI = 2, FSFontStdIDCourierI = 3,
  FSFontStdIDHelvetica = 4, FSFontStdIDHelveticaB = 5, FSFontStdIDHelveticaBI = 6, FSFontStdIDHelveticaI = 7,
  FSFontStdIDTimes = 8, FSFontStdIDTimesB = 9, FSFontStdIDTimesBI = 10, FSFontStdIDTimesI = 11,
  FSFontStdIDSymbol = 12, FSFontStdIDZapfDingbats = 13
}
 Enumeration for standard font ID.
More...
 
enum  FSFontStyles {
  FSFontStyleFixedPitch = 0x0001, FSFontStyleSerif = 0x0002, FSFontStyleSymbolic = 0x0004, FSFontStyleScript = 0x0008,
  FSFontStyleNonSymbolic = 0x0020, FSFontStyleItalic = 0x0040, FSFontStyleAllCap = 0x10000, FSFontStylesSmallCap = 0x20000,
  FSFontStylesBold = 0x40000
}
 Enumeration for font styles.
More...
 
enum  FSFullTextSearchRankMode { FSFullTextSearchRankNone = 0, FSFullTextSearchRankHitCountASC = 1, FSFullTextSearchRankHitCountDESC = 2 }
 Enumeration for rank mode of full text search.
More...
 
enum  FSGraphicsObjectBlendMode {
  FSGraphicsObjectBlendNormal = 0, FSGraphicsObjectBlendMultiply = 1, FSGraphicsObjectBlendScreen = 2, FSGraphicsObjectBlendOverlay = 3,
  FSGraphicsObjectBlendDarken = 4, FSGraphicsObjectBlendLighten = 5, FSGraphicsObjectBlendColorDodge = 6, FSGraphicsObjectBlendColorBurn = 7,
  FSGraphicsObjectBlendHardlight = 8, FSGraphicsObjectBlendSoftlight = 9, FSGraphicsObjectBlendDifference = 10, FSGraphicsObjectBlendExclusion = 11,
  FSGraphicsObjectBlendHue = 21, FSGraphicsObjectBlendSaturation = 22, FSGraphicsObjectBlendColor = 23, FSGraphicsObjectBlendLuminosity = 24
}
 Enumeration for render blend mode.
More...
 
enum  FSGraphicsObjectType {
  FSGraphicsObjectTypeAll = 0, FSGraphicsObjectTypeText = 1, FSGraphicsObjectTypePath = 2, FSGraphicsObjectTypeImage = 3,
  FSGraphicsObjectTypeShading = 4, FSGraphicsObjectTypeFormXObject = 5
}
 Enumeration for PDF graphics object type.
More...
 
enum  FSGraphStateLineCapStyle { FSGraphStateLineCapButt = 0, FSGraphStateLineCapRound = 1, FSGraphStateLineCapSquare = 2 }
 Enumeration for line cap style.
More...
 
enum  FSGraphStateLineJoinStyle { FSGraphStateLineJoinMiter = 0, FSGraphStateLineJoinRound = 1, FSGraphStateLineJoinBevel = 2 }
 Enumeration for line join style.
More...
 
enum  FSHitDataCheckSeverity { FSHitDataCheckSeverityInfo = 1, FSHitDataCheckSeverityWarning = 2, FSHitDataCheckSeverityError = 3 }
 Enumeration for check severity of a hit data.
More...
 
enum  FSIconFitScaleWayType { FSIconFitScaleWayAlways = 1, FSIconFitScaleWayBigger = 2, FSIconFitScaleWaySmaller = 3, FSIconFitScaleWayNever = 4 }
 Enumeration for the type of icon scaling way.
More...
 
enum  FSImageObjectColorSpace {
  FSImageObjectColorSpaceInvalid = 0, FSImageObjectColorSpaceDeviceGray = 1, FSImageObjectColorSpaceDeviceRGB = 2, FSImageObjectColorSpaceDeviceCMYK = 3,
  FSImageObjectColorSpaceCalGray = 4, FSImageObjectColorSpaceCalRGB = 5, FSImageObjectColorSpaceLab = 6, FSImageObjectColorSpaceSeparation = 8,
  FSImageObjectColorSpaceDeviceN = 9, FSImageObjectColorSpacePattern = 11, FSImageObjectColorSpaceICCBasedDeviceGray = 12, FSImageObjectColorSpaceICCBasedDeviceRGB = 13,
  FSImageObjectColorSpaceICCBasedDeviceCMYK = 14
}
 Enumeration for image color space.
More...
 
enum  FSImageType {
  FSImageUnknown = -1, FSImageNone = 0, FSImageBMP = 1, FSImageJPG = 2,
  FSImagePNG = 3, FSImageGIF = 4, FSImageTIF = 5, FSImageJPX = 6,
  FSImageJBIG2 = 8
}
 Enumeration for image type.
More...
 
enum  FSLayerContextUsageType {
  FSLayerContextUsageView = 0x0000, FSLayerContextUsageDesign = 0x0001, FSLayerContextUsagePrint = 0x0002, FSLayerContextUsageExport = 0x0003,
  FSLayerContextUsageZoom = 0x0004
}
 Enumeration for PDF layer usage type.
More...
 
enum  FSLayerTreeUsageState { FSLayerTreeStateON = 0x0000, FSLayerTreeStateOFF = 0x0001, FSLayerTreeStateUnchanged = 0x0002, FSLayerTreeStateUndefined = 0x0003 }
 Enumeration for PDF layer base state.
More...
 
enum  FSLineCapPos { FSLineCapPosInline = 0, FSLineCapPosTop = 1 }
 Enumeration for the position type of caption.
More...
 
enum  FSMarkupEndingStyle {
  FSMarkupEndingStyleNone = 0, FSMarkupEndingStyleSquare = 1, FSMarkupEndingStyleCircle = 2, FSMarkupEndingStyleDiamond = 3,
  FSMarkupEndingStyleOpenArrow = 4, FSMarkupEndingStyleClosedArrow = 5, FSMarkupEndingStyleButt = 6, FSMarkupEndingStyleROpenArrow = 7,
  FSMarkupEndingStyleRClosedArrow = 8, FSMarkupEndingStyleSlash = 9
}
 Enumeration for line ending style.
More...
 
enum  FSMarkupState {
  FSMarkupStateMarked = 1, FSMarkupStateUnmarked = 2, FSMarkupStateAccepted = 3, FSMarkupStateRejected = 4,
  FSMarkupStateCancelled = 5, FSMarkupStateCompleted = 6, FSMarkupStateNone = 7
}
 Enumeration for markup annotation's state.
More...
 
enum  FSMarkupStateModel { FSMarkupStateModelMarked = 1, FSMarkupStateModelReview = 2 }
 Enumeration for markup annotation's state model.
More...
 
enum  FSPageLabelsStyle {
  FSPageLabelsNone = 0, FSPageLabelsDecimalNums = 1, FSPageLabelsUpperRomanNums = 2, FSPageLabelsLowerRomanNums = 3,
  FSPageLabelsUpperLetters = 4, FSPageLabelsLowerLetters = 5
}
 Enumeration for page label style.
More...
 
enum  FSPathPointType {
  FSPathTypeMoveTo = 1, FSPathTypeLineTo = 2, FSPathTypeLineToCloseFigure = 3, FSPathTypeBezierTo = 4,
  FSPathTypeBezierToCloseFigure = 5
}
 Enumeration for point type in path.
More...
 
enum  FSPDFAComplianceVersion {
  FSPDFAComplianceVersionPDFA1a = 1, FSPDFAComplianceVersionPDFA1b = 2, FSPDFAComplianceVersionPDFA2a = 3, FSPDFAComplianceVersionPDFA2b = 4,
  FSPDFAComplianceVersionPDFA2u = 5, FSPDFAComplianceVersionPDFA3a = 6, FSPDFAComplianceVersionPDFA3b = 7, FSPDFAComplianceVersionPDFA3u = 8
}
 Enumeration for PDF/A version.
More...
 
enum  FSPDFDocDataType { FSPDFDocForms = 0x0001, FSPDFDocAnnots = 0x0002, FSPDFDocLinks = 0x0004 }
 Enumeration for data type used to decide which object(s) will be imported from or exported to FDF/XFDF document.
More...
 
enum  FSPDFDocDisplayMode {
  FSPDFDocDisplayUseNone = 0, FSPDFDocDisplayUseOutlines = 1, FSPDFDocDisplayUseThumbs = 2, FSPDFDocDisplayFullScreen = 3,
  FSPDFDocDisplayUseOC = 4, FSPDFDocDisplayUseAttachment = 5
}
 Enumeration for display mode which specifies how the document should be displayed when opened.
More...
 
enum  FSPDFDocEncryptType {
  FSPDFDocEncryptUnknown = -1, FSPDFDocEncryptNone = 0, FSPDFDocEncryptPassword = 1, FSPDFDocEncryptCertificate = 2,
  FSPDFDocEncryptFoxitDRM = 3, FSPDFDocEncryptCustom = 4, FSPDFDocEncryptRMS = 5, FSPDFDocEncryptCDRM = 6
}
 Enumeration for encryption type.
More...
 
enum  FSPDFDocImportPageFlags { FSPDFDocImportFlagNormal = 0, FSPDFDocImportFlagWithLayers = 0x0001, FSPDFDocImportFlagShareStream = 0x0002 }
 Enumeration for flags used for importing pages.
More...
 
enum  FSPDFDocPasswordType { FSPDFDocPwdInvalid = 0, FSPDFDocPwdNoPassword = 1, FSPDFDocPwdUser = 2, FSPDFDocPwdOwner = 3 }
 Enumeration for the type of current used password in a PDF document.
More...
 
enum  FSPDFDocSaveFlags {
  FSPDFDocSaveFlagNormal = 0, FSPDFDocSaveFlagIncremental = 0x0001, FSPDFDocSaveFlagNoOriginal = 0x0002, FSPDFDocSaveFlagXRefStream = 0x0008,
  FSPDFDocSaveFlagLinearized = 0x1000, FSPDFDocSaveFlagRemoveRedundantObjects = 0x0010
}
 Enumeration for PDF document saving flags.
More...
 
enum  FSPDFDocUserPermissions {
  FSPDFDocPermPrint = 0x0004, FSPDFDocPermModify = 0x0008, FSPDFDocPermExtract = 0x0010, FSPDFDocPermAnnotForm = 0x0020,
  FSPDFDocPermFillForm = 0x0100, FSPDFDocPermExtractAccess = 0x0200, FSPDFDocPermAssemble = 0x0400, FSPDFDocPermPrintHigh = 0x0800
}
 Enumeration for user access permissions in a PDF document.
More...
 
enum  FSPDFDocWrapperType { FSPDFDocWrapperNone = 0, FSPDFDocWrapperFoxit = 1, FSPDFDocWrapperPDFV2 = 2 }
 Enumeration for wrapper type.
More...
 
enum  FSPDFNameTreeType { FSPDFNameTreeDests = 1, FSPDFNameTreeJavaScript = 2, FSPDFNameTreeEmbeddedFiles = 3 }
 Enumeration for name tree type.
More...
 
enum  FSPDFNumberTreeType { FSPDFNumberTreePageLabels = 1 }
 Enumeration for number tree type.
More...
 
enum  FSPDFObjectType {
  FSPDFObjectInvalidType = 0, FSPDFObjectBoolean = 1, FSPDFObjectNumber = 2, FSPDFObjectString = 3,
  FSPDFObjectName = 4, FSPDFObjectArray = 5, FSPDFObjectDictionary = 6, FSPDFObjectStream = 7,
  FSPDFObjectNull = 8, FSPDFObjectReference = 9
}
 Enumeration for PDF object type.
More...
 
enum  FSPDFPageBoxType {
  FSPDFPageMediaBox = 0, FSPDFPageCropBox = 1, FSPDFPageTrimBox = 2, FSPDFPageArtBox = 3,
  FSPDFPageBleedBox = 4
}
 Enumeration for page box type.
More...
 
enum  FSPDFPageCalcMarginMode { FSPDFPageCalcContentsBox = 0, FSPDFPageCalcDetection = 1 }
 Enumeration for calculating margin mode.
More...
 
enum  FSPDFPageFlattenOptions { FSPDFPageFlattenAll = 0, FSPDFPageFlattenNoAnnot = 0x0001, FSPDFPageFlattenNoFormControl = 0x0002 }
 Enumeration for flatten options.
More...
 
enum  FSPDFPageParseFlags { FSPDFPageParsePageNormal = 0x0000, FSPDFPageParsePageTextOnly = 0x0001 }
 Enumeration for parsing flags used for PDF page.
More...
 
enum  FSPDFPageSize {
  FSPDFPageSizeLetter = 1, FSPDFPageSizeLegal = 2, FSPDFPageSizeA2 = 3, FSPDFPageSizeA3 = 4,
  FSPDFPageSizeA4 = 5, FSPDFPageSizeA5 = 6, FSPDFPageSizeA6 = 7, FSPDFPageSizeB2 = 8,
  FSPDFPageSizeB3 = 9, FSPDFPageSizeB4 = 10, FSPDFPageSizeB5 = 11, FSPDFPageSizeB6 = 12
}
 Enumeration for page size type.
More...
 
enum  FSPDFStreamFilter {
  FSPDFStreamUnknown = -1, FSPDFStreamNoneDecode = 0, FSPDFStreamASCIIHexDecode = 1, FSPDFStreamASCII85Decode = 2,
  FSPDFStreamLZWDecode = 3, FSPDFStreamFlateDecode = 4, FSPDFStreamRunLengthDecode = 5, FSPDFStreamCCITTFaxDecode = 6,
  FSPDFStreamJBIG2Decode = 7, FSPDFStreamDCTDecode = 8, FSPDFStreamJPXDecode = 9, FSPDFStreamCrypt = 10
}
 Enumeration for stream filter type.
More...
 
enum  FSPosition {
  FSPosTopLeft = 0, FSPosTopCenter = 1, FSPosTopRight = 2, FSPosCenterLeft = 3,
  FSPosCenter = 4, FSPosCenterRight = 5, FSPosBottomLeft = 6, FSPosBottomCenter = 7,
  FSPosBottomRight = 8
}
 Enumeration for watermark position in a PDF page.
More...
 
enum  FSProgressiveState { FSProgressiveError = 0, FSProgressiveToBeContinued = 1, FSProgressiveFinished = 2 }
 Enumeration for progress state.
More...
 
enum  FSRangeFilter { FSRangeAll = 0, FSRangeEven = 1, FSRangeOdd = 2 }
 Enumeration for range filter.
More...
 
enum  FSReflowPageFlags { FSReflowPageNormal = 0x0, FSReflowPageWithImage = 0x1, FSReflowPageNoTruncate = 0x2 }
 Enumeration for parsing flags used for a reflow page.
More...
 
enum  FSRendererColorMode { FSRendererColorModeNormal = 0, FSRendererColorModeMapping = 2 }
 Enumeration for rendering color mode.
More...
 
enum  FSRendererContentFlag { FSRendererRenderPage = 0x01, FSRendererRenderAnnot = 0x02 }
 Enumeration for rendering content flags.
More...
 
enum  FSRenditionActionOperationType {
  FSRenditionActionOpTypeNone = -1, FSRenditionActionOpTypeAssociate = 0, FSRenditionActionOpTypeStop = 1, FSRenditionActionOpTypePause = 2,
  FSRenditionActionOpTypeResume = 3, FSRenditionActionOpTypePlay = 4
}
 Enumeration for operation type to perform when the rendition action is triggered.
More...
 
enum  FSRenditionFloatingWindowOffscreenEvent { FSRenditionFloatingWindowOffscreenEventNone = 0, FSRenditionFloatingWindowOffscreenEventMoveResize = 1, FSRenditionFloatingWindowOffscreenEventNonViable = 2 }
 Enumeration for offscreen event type of floating window.
More...
 
enum  FSRenditionFloatingWindowRelatedWindowType { FSRenditionFloatingWindowRelatedWindowDocument = 0, FSRenditionFloatingWindowRelatedWindowApplication = 1, FSRenditionFloatingWindowRelatedWindowFullDesktop = 2, FSRenditionFloatingWindowRelatedWindowMonitor = 3 }
 Enumeration for the type of floating window's related window.
More...
 
enum  FSRenditionFloatingWindowResizeType { FSRenditionFloatingWindowResizeTypeNo = 0, FSRenditionFloatingWindowResizeTypeAspectRatio = 1, FSRenditionFloatingWindowResizeTypeAnyway = 2 }
 Enumeration for resize type of floating window.
More...
 
enum  FSRenditionMediaOptionType { FSRenditionMediaOptionMustBeHonored = 0, FSRenditionMediaOptionBestEffort = 1 }
 Enumeration for media option type.
More...
 
enum  FSRenditionMediaPermission { FSRenditionMediaPermTempNever = 0, FSRenditionMediaPermTempExtract = 1, FSRenditionMediaPermTempAccess = 2, FSRenditionMediaPermTempAlways = 3 }
 Enumeration for PDF media player permission.
More...
 
enum  FSRenditionMediaPlayerFitStyle {
  FSRenditionMediaPlayerFitStyleMeet = 0, FSRenditionMediaPlayerFitStyleSlice = 1, FSRenditionMediaPlayerFitStyleFill = 2, FSRenditionMediaPlayerFitStyleScroll = 3,
  FSRenditionMediaPlayerFitStyleHidden = 4, FSRenditionMediaPlayerFitStyleDefault = 5
}
 Enumeration for the fit style.
More...
 
enum  FSRenditionMediaPlayerType { FSRenditionMediaPlayerMustUsed = 0, FSRenditionMediaPlayerAvailable = 1, FSRenditionMediaPlayerNotUsed = 2 }
 Enumeration for PDF media player classified type.
More...
 
enum  FSRenditionMonitorSpecifier {
  FSRenditionMonitorSpecifierLargest = 0, FSRenditionMonitorSpecifierSmallest = 1, FSRenditionMonitorSpecifierPrimary = 2, FSRenditionMonitorSpecifierGreatestColorDepth = 3,
  FSRenditionMonitorSpecifierGreatestArea = 4, FSRenditionMonitorSpecifierGreatestHeight = 5, FSRenditionMonitorSpecifierGreatestWidth = 6
}
 Enumeration for monitor specifier type.
More...
 
enum  FSRenditionWindowType { FSRenditionWindowTypeFloating = 0, FSRenditionWindowTypeFullScreen = 1, FSRenditionWindowTypeHidden = 2, FSRenditionWindowTypeAnnotRect = 3 }
 Enumeration for the type of window that the media should play in.
More...
 
enum  FSRotation {
  FSRotation0 = 0, FSRotation90 = 1, FSRotation180 = 2, FSRotation270 = 3,
  FSRotationUnknown = 4
}
 Enumeration for rotation.
More...
 
enum  FSSecurityHandlerCipherType { FSSecurityHandlerCipherNone = 0, FSSecurityHandlerCipherRC4 = 1, FSSecurityHandlerCipherAES = 2 }
 Enumeration for Encryption Algorithm.
More...
 
enum  FSSignatureAPFlags {
  FSSignatureAPFlagFoxitFlag = 0x0001, FSSignatureAPFlagLabel = 0x0002, FSSignatureAPFlagReason = 0x0004, FSSignatureAPFlagSigningTime = 0x0008,
  FSSignatureAPFlagDN = 0x0010, FSSignatureAPFlagLocation = 0x0020, FSSignatureAPFlagSigner = 0x0040, FSSignatureAPFlagBitmap = 0x0080,
  FSSignatureAPFlagText = 0x0100
}
 Enumeration for signature appearance flags.
More...
 
enum  FSSignatureDigestAlgorithm { FSSignatureDigestSHA1 = 0, FSSignatureDigestSHA256 = 1, FSSignatureDigestSHA384 = 2, FSSignatureDigestSHA512 = 3 }
 Enumeration for signature digest algorithm.
More...
 
enum  FSSignatureKeyName {
  FSSignatureKeyNameSigner = 0, FSSignatureKeyNameLocation = 1, FSSignatureKeyNameReason = 2, FSSignatureKeyNameContactInfo = 3,
  FSSignatureKeyNameDN = 4, FSSignatureKeyNameText = 5
}
 Enumeration for signature key name.
More...
 
enum  FSSignatureStates {
  FSSignatureStateUnknown = 0x00000000, FSSignatureStateNoSignData = 0x00000200, FSSignatureStateUnsigned = 0x00000001, FSSignatureStateSigned = 0x00000002,
  FSSignatureStateVerifyValid = 0x00000004, FSSignatureStateVerifyInvalid = 0x00000008, FSSignatureStateVerifyErrorData = 0x00000010, FSSignatureStateVerifyNoSupportWay = 0x00000020,
  FSSignatureStateVerifyErrorByteRange = 0x00000040, FSSignatureStateVerifyChange = 0x00000080, FSSignatureStateVerifyIncredible = 0x00000100, FSSignatureStateVerifyNoChange = 0x00000400,
  FSSignatureStateVerifyIssueValid = 0x00001000, FSSignatureStateVerifyIssueUnknown = 0x00002000, FSSignatureStateVerifyIssueRevoke = 0x00004000, FSSignatureStateVerifyIssueExpire = 0x00008000,
  FSSignatureStateVerifyIssueUncheck = 0x00010000, FSSignatureStateVerifyIssueCurrent = 0x00020000, FSSignatureStateVerifyTimestampNone = 0x00040000, FSSignatureStateVerifyTimestampDoc = 0x00080000,
  FSSignatureStateVerifyTimestampValid = 0x00100000, FSSignatureStateVerifyTimestampInvalid = 0x00200000, FSSignatureStateVerifyTimestampExpire = 0x00400000, FSSignatureStateVerifyTimestampIssueUnknown = 0x00800000,
  FSSignatureStateVerifyTimestampIssueValid = 0x01000000, FSSignatureStateVerifyTimestampTimeBefore = 0x02000000
}
 Enumeration for signature states.
More...
 
enum  FSSubmitFormActionFlags {
  FSSubmitFormActionFlagExclude = 0x0001, FSSubmitFormActionFlagIncludeNoValueFields = 0x0002, FSSubmitFormActionFlagExportFormat = 0x0004, FSSubmitFormActionFlagGetMethod = 0x0008,
  FSSubmitFormActionFlagWithCoordinates = 0x0010, FSSubmitFormActionFlagAsXFDF = 0x0020, FSSubmitFormActionFlagIncludeAppendSaves = 0x0040, FSSubmitFormActionFlagIncludeAnnotations = 0x0080,
  FSSubmitFormActionFlagSubmitAsPDF = 0x0100, FSSubmitFormActionFlagCanonicalFormat = 0x0200, FSSubmitFormActionFlagExclNonUserAnnots = 0x0400, FSSubmitFormActionFlagExclFKey = 0x0800,
  FSSubmitFormActionFlagEmbedForm = 0x2000
}
 Enumeration for flags of submit form action.
More...
 
enum  FSTabOrderMgrOrderType { FSTabOrderMgrNone = 0x0000, FSTabOrderMgrRow = 0x0001, FSTabOrderMgrColumn = 0x0002, FSTabOrderMgrStructure = 0x0003 }
 Enumeration for tab order type.
More...
 
enum  FSTextPageTextParseFlags { FSTextPageParseTextNormal = 0x0000, FSTextPageParseTextOutputHyphen = 0x0001, FSTextPageParseTextUseStreamOrder = 0x0002 }
 Enumeration for parsing flags used for text page.
More...
 
enum  FSTextSearchSearchFlags { FSTextSearchSearchNormal = 0x00, FSTextSearchSearchMatchCase = 0x01, FSTextSearchSearchMatchWholeWord = 0x02, FSTextSearchSearchConsecutive = 0x04 }
 Enumeration for searching flags.
More...
 
enum  FSTextStateMode {
  FSTextStateModeFill = 0, FSTextStateModeStroke = 1, FSTextStateModeFillStroke = 2, FSTextStateModeInvisible = 3,
  FSTextStateModeFillClip = 4, FSTextStateModeStrokeClip = 5, FSTextStateModeFillStrokeClip = 6, FSTextStateModeClip = 7
}
 Enumeration for text mode.
More...
 
enum  FSWatermarkSettingsFlags {
  FSWatermarkSettingsFlagASPageContents = 0x0000, FSWatermarkSettingsFlagASAnnot = 0x0001, FSWatermarkSettingsFlagOnTop = 0x0002, FSWatermarkSettingsFlagNoPrint = 0x0004,
  FSWatermarkSettingsFlagInvisible = 0x0008
}
 Enumeration for watermark setting flags.
More...
 
enum  FSWatermarkTextPropertiesFontStyle { FSWatermarkTextPropertiesFontStyleNormal = 0, FSWatermarkTextPropertiesFontStyleUnderline = 1 }
 Enumeration for watermark font style.
More...
 
enum  FSXFADocEventType { FSXFADocEventTypeUnknown = 0, FSXFADocEventTypePostPrint = 1, FSXFADocEventTypePrePrint = 2 }
 Enumeration for XFA event type.
More...
 
enum  FSXFADocExportDataType { FSXFADocExportDataTypeXML = 0, FSXFADocExportDataTypeStaticXDP = 1, FSXFADocExportDataTypeXDP = 2 }
 Enumeration for the type of exported data.
More...
 
enum  FSXFADocType { FSXFADocDynamic = 0, FSXFADocStatic = 1, FSXFADocXDP = 2 }
 Enumeration for XFA document type.
More...
 
enum  FSXFAWidgetHitTestArea { FSXFAWidgetHitTestAreaUnknown = 0, FSXFAWidgetHitTestAreaClient = 1, FSXFAWidgetHitTestAreaTitleBar = 2, FSXFAWidgetHitTestAreaHyperLink = 3 }
 Enumeration for hit test area of XFA widget.
More...
 
enum  FSXFAWidgetPresenceProperty {
  FSXFAWidgetPresenceUnknown = 0, FSXFAWidgetPresenceVisible = 1, FSXFAWidgetPresenceHidden = 2, FSXFAWidgetPresenceInactive = 3,
  FSXFAWidgetPresenceInvisible = 4
}
 Enumeration for presence attribute of XFA widget.
More...
 
enum  FSXFAWidgetWidgetNameType { FSXFAWidgetWidgetNameTypeField = 0, FSXFAWidgetWidgetNameTypeCaption = 1 }
 Enumeration for the type of XFA widget name.
More...
 
enum  FSXFAWidgetWidgetType {
  FSXFAWidgetWidgetTypeBarcode = 0, FSXFAWidgetWidgetTypePushButton = 1, FSXFAWidgetWidgetTypeCheckButton = 2, FSXFAWidgetWidgetTypeArc = 3,
  FSXFAWidgetWidgetTypeDateTimeEdit = 4, FSXFAWidgetWidgetTypeNumericEdit = 5, FSXFAWidgetWidgetTypeSignature = 6, FSXFAWidgetWidgetTypeChoiceList = 7,
  FSXFAWidgetWidgetTypeImageEdit = 8, FSXFAWidgetWidgetTypeLine = 9, FSXFAWidgetWidgetTypePasswordEdit = 10, FSXFAWidgetWidgetTypeRadioButton = 11,
  FSXFAWidgetWidgetTypeRectangle = 12, FSXFAWidgetWidgetTypeTextEdit = 13, FSXFAWidgetWidgetTypeUnknown = 14, FSXFAWidgetWidgetTypeExclGroup = 15
}
 Enumeration for the type of XFA widget.
More...
 

Detailed Description

Enumeration Type Documentation

◆ FSActionCallbackAppInfoType

Enumeration for application's information type.

Values of this enumeration should be used alone.

Enumerator
FSActionCallbackAppInfoTypeFormsVersion 

Application's forms version information.

FSActionCallbackAppInfoTypeViewerType 

Application's viewer type information.

FSActionCallbackAppInfoTypeViewerVariation 

Application's viewer variation information.

FSActionCallbackAppInfoTypeViewerVersion 

Application's viewer version information.

FSActionCallbackAppInfoTypeAppVersion 

Application's app version information.

◆ FSActionCallbackLanguage

Enumeration for language.

Values of this enumeration should be used alone.

Enumerator
FSActionCallbackLanguageUnknown 

Unknown language.

FSActionCallbackLanguageCHS 

Chinese Simplified.

FSActionCallbackLanguageCHT 

Chinese Traditional.

FSActionCallbackLanguageDAN 

Danish.

FSActionCallbackLanguageDEU 

German.

FSActionCallbackLanguageENU 

English.

FSActionCallbackLanguageESP 

Spanish.

FSActionCallbackLanguageFRA 

French.

FSActionCallbackLanguageITA 

Italian.

FSActionCallbackLanguageKOR 

Korean.

FSActionCallbackLanguageJPN 

Japanese.

FSActionCallbackLanguageNLD 

Dutch.

FSActionCallbackLanguageNOR 

Norwegian.

FSActionCallbackLanguagePTB 

Brazilian Portuguese.

FSActionCallbackLanguageSUO 

Finnish.

FSActionCallbackLanguageSVE 

Swedish.

◆ FSActionCallbackMailType

Enumeration for data type to be mailed.

Values of this enumeration should be used alone.

Enumerator
FSActionCallbackMailTypeDoc 

Mailed data type: document.

FSActionCallbackMailTypeForm 

Mailed data type: form.

FSActionCallbackMailTypeMsg 

Mailed data type: string message.

◆ FSActionNewWindowFlag

Enumeration for new window flag.

Values of this enumeration should be used alone.

Enumerator
FSActionNewWindowFlagFalse 

"NewWindow" flag is NO.

FSActionNewWindowFlagTrue 

"NewWindow" flag is YES.

FSActionNewWindowFlagNone 

No "NewWindow" flag.

◆ FSActionType

Enumeration for action type.

Values of this enumeration should be used alone.

Enumerator
FSActionTypeUnknown 

Action type: unknown action.

FSActionTypeGoto 

Action type: go-to action.

FSActionTypeGoToR 

Action type: remote go-to action.

FSActionTypeGoToE 

Action type: embedded go-to action.

FSActionTypeLaunch 

Action type: launch action.

FSActionTypeThread 

Action type: thread action.

FSActionTypeURI 

Action type: uniform resource identifier (URI) action.

FSActionTypeSound 

Action type: sound action.

FSActionTypeMovie 

Action type: movie action.

FSActionTypeHide 

Action type: hide action.

FSActionTypeNamed 

Action type: named action.

FSActionTypeSubmitForm 

Action type: submit-form action.

FSActionTypeResetForm 

Action type: reset-form action.

FSActionTypeImportData 

Action type: import-data action.

FSActionTypeJavaScript 

Action type: JavaScript action.

FSActionTypeSetOCGState 

Action type: set-OCG-state action.

FSActionTypeRendition 

Action type: rendition action.

FSActionTypeTrans 

Action type: transition action.

FSActionTypeGoTo3DView 

Action type: go-to-3D-view action.

◆ FSAdditionalActionTriggerEvent

Enumeration for trigger event.

Values of this enumeration should be used alone.

Enumerator
FSAdditionalActionTriggerPageOpened 

Trigger an action to be performed when the page is opened.

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

FSAdditionalActionTriggerPageClosed 

Trigger an action to be performed when the page is closed.

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

FSAdditionalActionTriggerDocWillClose 

Trigger a JavaScript action to be performed before closing a document.

This represents "WC" entry in a document catalog's additional-actions dictionary. Only applicable for additional action object constructed from PDF document.

FSAdditionalActionTriggerDocWillSave 

Trigger a JavaScript action to be performed before saving a document.

This represents "WS" entry in a document catalog's additional-actions dictionary. Only applicable for additional action object constructed from PDF document.

FSAdditionalActionTriggerDocSaved 

Trigger a JavaScript action to be performed after saving a document.

This represents "DS" entry in a document catalog's additional-actions dictionary. Only applicable for additional action object constructed from PDF document.

FSAdditionalActionTriggerDocWillPrint 

Trigger a JavaScript action to be performed before printing a document.

This represents "WP" entry in a document catalog's additional-actions dictionary. Only applicable for additional action object constructed from PDF document.

FSAdditionalActionTriggerDocPrinted 

Trigger a JavaScript action to be performed after printing a document.

This represents "DP" entry in a document catalog's additional-actions dictionary. Only applicable for additional action object constructed from PDF document.

FSAdditionalActionTriggerFieldKeyStroke 

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.

FSAdditionalActionTriggerFieldWillFormat 

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.

FSAdditionalActionTriggerFieldValueChanged 

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.

FSAdditionalActionTriggerFieldRecalculateValue 

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.
The order in which the document's fields are recalculated can be gotten by function FSForm::fieldsInCalculationOrder.

FSAdditionalActionTriggerAnnotCursorEnter 

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.

FSAdditionalActionTriggerAnnotCursorExit 

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.

FSAdditionalActionTriggerAnnotMouseButtonPressed 

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.

FSAdditionalActionTriggerAnnotMouseButtonReleased 

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.

FSAdditionalActionTriggerAnnotReceiveInputFocus 

(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.

FSAdditionalActionTriggerAnnotLoseInputFocus 

(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.

FSAdditionalActionTriggerAnnotPageOpened 

Trigger an action to be performed when the page containing the annotation is opened.

This represents "PO" entry in an annotation's additional-actions dictionary. Only applicable for additional action object constructed from PDF annotation. The triggered action is executed after action for FSAdditionalActionTriggerPageOpened is triggered and open action of PDF document, if such actions present.

FSAdditionalActionTriggerAnnotPageClosed 

Trigger an action to be performed when the page containing the annotation is closed.

This represents "PC" entry in an annotation's additional-actions dictionary. Only applicable for additional action object constructed from PDF annotation. The triggered action is executed after action for FSAdditionalActionTriggerPageClosed is triggered, if such action present.

FSAdditionalActionTriggerAnnotPageVisible 

Trigger an action to be performed when the page containing the annotation becomes visible in the viewer application's user interface.

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

FSAdditionalActionTriggerAnnotPageInvisible 

Trigger an action to be performed when the page containing the annotation is no longer visible in the viewer application's user interface.

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

◆ FSAlignment

Enumeration for alignment (horizontal).

Values of this enumeration should be used alone.

Enumerator
FSAlignmentLeft 

Left alignment.

FSAlignmentCenter 

Center alignment.

FSAlignmentRight 

Right alignment.

◆ FSAnnotAppearanceType

Enumeration for the type of annotation's appearance.

Values of this enumeration should be used alone.

Enumerator
FSAnnotAppearanceTypeNormal 

Annotation's normal appearance.

FSAnnotAppearanceTypeRollover 

Annotation's rollover appearance.

FSAnnotAppearanceTypeDown 

Annotation's down appearance.

◆ FSAnnotFlags

Enumeration for PDF annotation flags.

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

Enumerator
FSAnnotFlagInvisible 

Annotation flag: 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 non-standard annotation using an appearance stream specified by its appearance dictionary, if any.

FSAnnotFlagHidden 

Annotation flag: 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.

FSAnnotFlagPrint 

Annotation flag: 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. This can be useful, for example, for annotations representing interactive pushbuttons, which would serve no meaningful purpose on the printed page.

FSAnnotFlagNoZoom 

Annotation flag: no zoom.

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. See below for further discussion.

FSAnnotFlagNoRotate 

Annotation flag: no rotate.

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.

FSAnnotFlagNoView 

Annotation flag: no view.

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 flag FSAnnotFlagPrint) but should be considered hidden for purposes of on- screen display and user interaction.

FSAnnotFlagReadOnly 

Annotation flag: read only.

If set, do not allow the annotation to interact with the user. The annotation may be displayed or printed (depending on the settings of flags FSAnnotFlagNoView and FSAnnotFlagPrint) but should not respond to mouse clicks or change its appearance in response to mouse motions.

Note
This flag is ignored for widget annotations; its function is subsumed by flag FSFieldFlagReadOnly of related form field.
FSAnnotFlagLocked 

Annotation flag: 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.

FSAnnotFlagToggleNoView 

Annotation flag: toggle no view.

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.

FSAnnotFlagLockedContents 

Annotation flag: locked contents.

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.

◆ FSAnnotHighlightingMode

Enumeration for PDF annotation highlighting mode.

Values of this enumeration should be used alone.

Enumerator
FSAnnotHighlightingNone 

Highlighting mode: No highlighting.

FSAnnotHighlightingInvert 

Highlighting mode: Invert, which is to invert the contents of the annotation rectangle.

FSAnnotHighlightingOutline 

Highlighting mode: Outline, which is to invert the annotation's border.

FSAnnotHighlightingPush 

Highlighting mode: Push, which is to display the annotation's down appearance, if any.

FSAnnotHighlightingToggle 

Highlighting mode: Toggle. This is only useful for widget annotation.

◆ FSAnnotMKEntry

Enumeration for annotation's MK dictionary (an appearance characteristics) entry.

Values of this enumeration should be used alone.

Enumerator
FSAnnotMKEntryRotation 

Rotation entry. "R" in MK dictionary.

FSAnnotMKEntryBorderColor 

Border color entry. "BC" in MK dictionary.

FSAnnotMKEntryBackgroundColor 

Background color entry. "BG" in MK dictionary.

FSAnnotMKEntryNormalCaption 

Normal caption entry. "CA" in MK dictionary.

Note
Only applicable for widget annotation associated with pushbutton field, check box field or radio button field.
FSAnnotMKEntryRolloverCaption 

Rollover caption entry. "RC" in MK dictionary.

Note
Only applicable for widget annotation associated with pushbutton field.
FSAnnotMKEntryDownCaption 

Down caption (or alternate caption) entry. "AC" in MK dictionary.

Note
Only applicable for widget annotation associated with pushbutton field.
FSAnnotMKEntryNormalIcon 

Normal icon entry. "I" in MK dictionary.

Note
Only applicable for widget annotation associated with pushbutton field.
FSAnnotMKEntryRolloverIcon 

Rollover icon entry. "RI" in MK dictionary.

Note
Only applicable for widget annotation associated with pushbutton field.
FSAnnotMKEntryDownIcon 

Down icon (or alternate icon) entry. "IX" in MK dictionary.

Note
Only applicable for widget annotation associated with pushbutton field.
FSAnnotMKEntryIconFit 

Icon fit information entry. "IF" in MK dictionary.

Note
Only applicable for widget annotation associated with pushbutton field.
FSAnnotMKEntryIconCaptionRelation 

Icon and caption relation entry. "TP" in MK dictionary.

Note
Only applicable for widget annotation associated with pushbutton field. This is used to specify where to position the text of widget annotation's mk caption relative to widget annotation's mk icon.

◆ FSAnnotMKIconCaptionRelation

Enumeration for icon and caption relative position in annotation's MK dictionary.

Values of this enumeration should be used alone.

Enumerator
FSAnnotMKRelationNoIcon 

No icon; captin only.

FSAnnotMKRelationNoCaption 

No caption; icon only.

FSAnnotMKRelationCaptionBelowIcon 

Caption below the icon.

FSAnnotMKRelationCaptionAboveIcon 

Caption above the icon.

FSAnnotMKRelationCaptionRight 

Caption to the right of the icon.

FSAnnotMKRelationCaptionLeft 

Caption to the left of the icon.

FSAnnotMKRelationCaptionOvrlayOnIcon 

Caption overlaid directly on the icon.

◆ FSAnnotProperty

Enumeration for some PDF annotation property.

Values of this enumeration should be used alone.

Enumerator
FSAnnotPropertyModifiedDate 

Annotation property: modified date.

FSAnnotPropertyCreationDate 

Annotation property: creation date.

Only markup annotations can have creation date property.

FSAnnotPropertyBorderColor 

Annotation property: border color.

FSAnnotPropertyFillColor 

Annotation property: fill color.

Only following types of annotations can have fill color property:
square, circle, free text, line, polygon, polyline.

◆ FSAnnotType

Enumeration for PDF annotation type.

Values of this enumeration should be used alone.

Enumerator
FSAnnotUnknownType 

Annotation type: unknown.

FSAnnotNote 

Annotation type: note annotation, which is just "Text" annotation - one of standard annotation in <PDF reference 1.7>.

FSAnnotLink 

Annotation type: link annotation. One of standard annotation in <PDF reference 1.7>.

FSAnnotFreeText 

Annotation type: free text annotation. One of standard annotation in <PDF reference 1.7>.

FSAnnotLine 

Annotation type: line annotation. One of standard annotation in <PDF reference 1.7>.

FSAnnotSquare 

Annotation type: square annotation. One of standard annotation in <PDF reference 1.7>.

FSAnnotCircle 

Annotation type: circle annotation. One of standard annotation in <PDF reference 1.7>.

FSAnnotPolygon 

Annotation type: polygon annotation. One of standard annotation in <PDF reference 1.7>.

FSAnnotPolyLine 

Annotation type: polyline annotation. One of standard annotation in <PDF reference 1.7>.

FSAnnotHighlight 

Annotation type: highlight annotation. One of standard annotation in <PDF reference 1.7>.

FSAnnotUnderline 

Annotation type: underline annotation. One of standard annotation in <PDF reference 1.7>.

FSAnnotSquiggly 

Annotation type: squiggly annotation. One of standard annotation in <PDF reference 1.7>.

FSAnnotStrikeOut 

Annotation type: strikeout annotation. One of standard annotation in <PDF reference 1.7>.

FSAnnotStamp 

Annotation type: stamp annotation. One of standard annotation in <PDF reference 1.7>.

FSAnnotCaret 

Annotation type: caret annotation. One of standard annotation in <PDF reference 1.7>.

FSAnnotInk 

Annotation type: ink annotation. One of standard annotation in <PDF reference 1.7>.

FSAnnotPSInk 

Annotation type: pressure sensitive ink annotation.

FSAnnotFileAttachment 

Annotation type: file attachment annotation. One of standard annotation in <PDF reference 1.7>.

FSAnnotSound 

Annotation type: sound annotation. One of standard annotation in <PDF reference 1.7>.

FSAnnotMovie 

Annotation type: movie annotation. One of standard annotation in <PDF reference 1.7>.

FSAnnotWidget 

Annotation type: widget annotation. One of standard annotation in <PDF reference 1.7>.

Note
Foxit PDF SDK treats widget annotation as form control.
FSAnnotScreen 

Annotation type: screen annotation. One of standard annotation in <PDF reference 1.7>.

FSAnnotPrinterMark 

Annotation type: printer's mark annotation. One of standard annotation in <PDF reference 1.7>.

FSAnnotTrapNet 

Annotation type: trap network annotation. One of standard annotation in <PDF reference 1.7>.

FSAnnotWatermark 

Annotation type: watermark annotation. One of standard annotation in <PDF reference 1.7>.

FSAnnot3D 

Annotation type: 3D annotation. One of standard annotation in <PDF reference 1.7>.

FSAnnotPopup 

Annotation type: pop-up annotation. One of standard annotation in <PDF reference 1.7>.

FSAnnotRedact 

Annotation type: redact annotation.

◆ FSAppProviderCallbackAppInfo

Enumeration for XFA application information type.

Values of this enumeration should be used alone.

Enumerator
FSAppProviderCallbackAppInfoVersion 

Application information: version.

FSAppProviderCallbackAppInfoLanguage 

Application information: language.

FSAppProviderCallbackAppInfoPlatform 

Application information: platform.

FSAppProviderCallbackAppInfoVariation 

Application information: variation.

FSAppProviderCallbackAppInfoName 

Application information: name.

FSAppProviderCallbackAppInfoType 

Application information: type.

◆ FSAppProviderCallbackBeepType

Enumeration for XFA beep type.

Values of this enumeration should be used alone.

Enumerator
FSAppProviderCallbackBeepTypeError 

Beep type: error.

FSAppProviderCallbackBeepTypeWarning 

Beep type: warning.

FSAppProviderCallbackBeepTypeQuestion 

Beep type: question.

FSAppProviderCallbackBeepTypeStatus 

Beep type: status.

FSAppProviderCallbackBeepTypeDefault 

Beep type: default.

◆ FSAppProviderCallbackMsgBoxButtonID

Enumeration for button ID of XFA message box.

Values of this enumeration should be used alone.

Enumerator
FSAppProviderCallbackMsgBtnIDOK 

Message box button ID: OK.

FSAppProviderCallbackMsgBtnIDCancel 

Message box button ID: Cancel.

FSAppProviderCallbackMsgBtnIDNo 

Message box button ID: No.

FSAppProviderCallbackMsgBtnIDYes 

Message box button ID: Yes.

◆ FSAppProviderCallbackMsgBoxButtonType

Enumeration for button type of XFA message box.

Values of this enumeration should be used alone.

Enumerator
FSAppProviderCallbackMsgBtnTypeOK 

Message box button: OK.

FSAppProviderCallbackMsgBtnTypeOKCancel 

Message box button: OK and Cancel.

FSAppProviderCallbackMsgBtnTypeYesNo 

Message box button: Yes and No.

FSAppProviderCallbackMsgBtnTypeYesNoCancel 

Message box button: Yes, No and Cancel.

◆ FSAppProviderCallbackMsgBoxIconType

Enumeration for icon type of XFA message box.

Values of this enumeration should be used alone.

Enumerator
FSAppProviderCallbackMsgBoxIconError 

Message box icon: Error.

FSAppProviderCallbackMsgBoxIconWarning 

Message box icon: Warning.

FSAppProviderCallbackMsgBoxIconQuestion 

Message box icon: Question.

FSAppProviderCallbackMsgBoxIconStatus 

Message box icon: Status.

◆ FSAppProviderCallbackStringID

Enumeration for string ID used to specify a case.

Values of this enumeration should be used alone.

Enumerator
FSAppProviderCallbackStringIDValidateFailed 

Sample message: "Validate failed".

FSAppProviderCallbackStringIDCalcOverride 

Sample message: "Calculate Override".

FSAppProviderCallbackStringIDModifyField 

String ID for case: If to modify field. Sample message: "Do you want to modify this field?".

FSAppProviderCallbackStringIDNotModifyField 

String ID for case: Not allow to modify field. Sample message: "You are not allowed to modify this field.".

FSAppProviderCallbackStringIDAppName 

String ID for case: Application's name. Sample message: "Foxit Phantom".

FSAppProviderCallbackStringIDImageFilter 

String ID for case: Filter for image files. Sample message: "Image Files(*.bmp;*.jpg;*.png;*.gif;*.tif)|*.bmp;*.jpg;*.png;*.gif;*.tif|All Files(*.*)|*.*||".

FSAppProviderCallbackStringIDUnknownCaught 

Sample message: "Unknown error is caught!".

FSAppProviderCallbackStringIDUnableToSet 

Sample message: "Unable to set".

FSAppProviderCallbackStringIDValueExcalmatory 

Sample message: "Value!".

FSAppProviderCallbackStringIDInvalidEnumValue 

String ID for case: Some enumerate value is invalid. Sample message: "Invalid enumerate value:".

FSAppProviderCallbackStringIDUnsupportMethod 

Sample message: "Unsupported method %s.".

FSAppProviderCallbackStringIDUnsupportProperty 

Sample message: "Unsupported property %s.".

FSAppProviderCallbackStringIDInvalidPropertySetOperation 

String ID for case: Some setting operation to property is invalid. Sample message: "Invalid property setting operation:".

FSAppProviderCallbackStringIDNotDefaultValue 

Sample message: "Not have a default property".

FSAppProviderCallbackStringIDUnableSetLanguage 

Sample message: "Unable to set the value for property 'language'".

FSAppProviderCallbackStringIDUnableSetNumPages 

Sample message: "Unable to set the value for property 'numPages'".

FSAppProviderCallbackStringIDUnableSetPlatformValue 

Sample message: "Unable to set the value for property 'platform'".

FSAppProviderCallbackStringIDUnableSetValidationsEnabledValue 

Sample message: "Unable to set the value for property 'validationsEnabled'".

FSAppProviderCallbackStringIDUnableSetValidationsValue 

Sample message: "Unable to set the value for property 'variation'".

FSAppProviderCallbackStringIDUnableSetVersion 

Sample message: "Unable to set the value for property 'version'".

FSAppProviderCallbackStringIDUnableSetReady 

Sample message: "Unable to set the value for property 'ready'".

FSAppProviderCallbackStringIDNumberOfOccur 

Sample message: "The element [%s] has violated its allowable number of occurrences".

FSAppProviderCallbackStringIDUnableSetClassName 

Sample message: "Unable to set the value for property 'className'".

FSAppProviderCallbackStringIDUnableSetLengthValue 

Sample message: "Unable to set the value for property 'length'".

FSAppProviderCallbackStringIDUnsupportChar 

Sample message: "Unsupported character '%c'".

FSAppProviderCallbackStringIDBadSuffix 

Sample message: "Bad suffix on number".

FSAppProviderCallbackStringIDExpectedIdent 

Sample message: "Expected identifier instead of '%s'".

FSAppProviderCallbackStringIDExpectedString 

Sample message: "Expected '%s' instead of '%s'".

FSAppProviderCallbackStringIDInvalidateChar 

Sample message: "Invalidate character '%c'".

FSAppProviderCallbackStringIDRedefinition 

Sample message: "'%s' redefinition".

FSAppProviderCallbackStringIDInvalidToken 

Sample message: "Invalidate token '%s'".

FSAppProviderCallbackStringIDInvalidExpression 

Sample message: "Invalidate expression '%s'".

FSAppProviderCallbackStringIDUndefineIdentifier 

Sample message: "Undefined identifier '%s'".

FSAppProviderCallbackStringIDInvalidateLeftValue 

Sample message: "Invalidate left-value '%s'".

FSAppProviderCallbackStringIDCompilerError 

Sample message: "Compiler error".

FSAppProviderCallbackStringIDCannotModifyValue 

Sample message: "Cannot modify the '%s' value".

FSAppProviderCallbackStringIDParametersError 

Sample message: "Function '%s' does not have %d parameters".

FSAppProviderCallbackStringIDExpectedEndIf 

Sample message: "Expected 'endif' instead of '%s'".

FSAppProviderCallbackStringIDUnexpectedExpression 

Sample message: "Unexpected expression '%s'".

FSAppProviderCallbackStringIDConditionIsNull 

Sample message: "Condition is null".

FSAppProviderCallbackStringIDIllegalBreak 

Sample message: "Illegal break".

FSAppProviderCallbackStringIDIllegalContinue 

Sample message: "Illegal continue".

FSAppProviderCallbackStringIDExpectedOperator 

Sample message: "Expected operator '%s' instead of '%s'".

FSAppProviderCallbackStringIDDivideZero 

Sample message: "Divide by zero".

FSAppProviderCallbackStringIDCannotCovertToObject 

Sample message: "%s.%s cannot covert to object".

FSAppProviderCallbackStringIDNotFoundContainer 

Sample message: "Cannot find container '%s'".

FSAppProviderCallbackStringIDNotFoundProperty 

Sample message: "Cannot find property '%s'".

FSAppProviderCallbackStringIDNotFoundMethod 

Sample message: "Cannot find method '%s'".

FSAppProviderCallbackStringIDNotFoundConst 

Sample message: "Cannot find const '%s'".

FSAppProviderCallbackStringIDNotAssignObject 

Sample message: "Cannot directly assign the value to object".

FSAppProviderCallbackStringIDInvalidateInstruction 

Sample message: "Invalidate instruction".

FSAppProviderCallbackStringIDExpectedNumber 

Sample message: "Expected number instead of '%s'".

FSAppProviderCallbackStringIDValidateOutOfArray 

Sample message: "Validate access index '%s' out of array".

FSAppProviderCallbackStringIDCannotAssign 

Sample message: "Cannot assign to '%s'".

FSAppProviderCallbackStringIDNotFoundFunction 

Sample message: "Cannot find function '%s'".

FSAppProviderCallbackStringIDIsNotArray 

Sample message: "'%s' is not an array".

FSAppProviderCallbackStringIDOutOfArrayRange 

Sample message: "Out of the range of '%s' array".

FSAppProviderCallbackStringIDNotSupportArrayCalculate 

Sample message: "'%s' operator cannot support array calculation".

FSAppProviderCallbackStringIDArgumentNotArray 

Sample message: "'%s' function's %d argument cannot be array".

FSAppProviderCallbackStringIDArgumentExpectContainer 

Sample message: "'%s' argument is expected to be a container".

FSAppProviderCallbackStringIDAccessProertyInNotObject 

Sample message: "An attempt was made to reference property '%s' of a non-object in SOM expression %s".

FSAppProviderCallbackStringIDFunctionBuildIn 

Sample message: "Function 's' is built-in.

FSAppProviderCallbackStringIDErrorMessage 

Sample message: "%s : %s".

FSAppProviderCallbackStringIDIndexValueOutOfBounds 

Sample message: "Index value is out of bounds".

FSAppProviderCallbackStringIDIncorrectNumberOfMethod 

Sample message: "Incorrect number of parameters are used when calling method '%s'".

FSAppProviderCallbackStringIDArgumentMismatch 

Sample message: "Argument mismatch in property or function argument".

FSAppProviderCallbackStringIDInvalidEnumerate 

Sample message: "Invalid enumerated value: %s".

FSAppProviderCallbackStringIDInvalidAppend 

Sample message: "Invalid append operation: %s cannot have a child element of %s".

FSAppProviderCallbackStringIDSOMExpectedList 

Sample message: "SOM expression returned list when single result was expected".

FSAppProviderCallbackStringIDNotHaveProperty 

Sample message: "'%s' doesn't have property '%s'".

FSAppProviderCallbackStringIDInvalidNodeType 

Sample message: "Invalid node type: '%s'".

FSAppProviderCallbackStringIDViolateBoundary 

Sample message: "The element [%s] has violated its allowable number of occurrences".

FSAppProviderCallbackStringIDServerDeny 

String ID for case: Server denies. Sample message: "Server does not permit".

FSAppProviderCallbackStringIDWeekDaySun 

String ID for case: Use string in local language for "Sunday".

FSAppProviderCallbackStringIDWeekDayMon 

String ID for case: Use string in local language for "Monday".

FSAppProviderCallbackStringIDWeekDayTue 

String ID for case: Use string in local language for "Tuesday".

FSAppProviderCallbackStringIDWeekDayWed 

String ID for case: Use string in local language for "Wednesday".

FSAppProviderCallbackStringIDWeekDayThu 

String ID for case: Use string in local language for "Thursday".

FSAppProviderCallbackStringIDWeekDayFri 

String ID for case: Use string in local language for "Friday".

FSAppProviderCallbackStringIDWeekDaySat 

String ID for case: Use string in local language for "Saturday".

FSAppProviderCallbackStringIDMonthJan 

String ID for case: Use string in local language for "January".

FSAppProviderCallbackStringIDMonthFeb 

String ID for case: Use string in local language for "February".

FSAppProviderCallbackStringIDMonthMarch 

String ID for case: Use string in local language for "March".

FSAppProviderCallbackStringIDMonthApril 

String ID for case: Use string in local language for "April".

FSAppProviderCallbackStringIDMonthMay 

String ID for case: Use string in local language for "May".

FSAppProviderCallbackStringIDMonthJune 

String ID for case: Use string in local language for "June".

FSAppProviderCallbackStringIDMonthJuly 

String ID for case: Use string in local language for "July".

FSAppProviderCallbackStringIDMonthAug 

String ID for case: Use string in local language for "August".

FSAppProviderCallbackStringIDMonthSep 

String ID for case: Use string in local language for "September".

FSAppProviderCallbackStringIDMonthOct 

String ID for case: Use string in local language for "October".

FSAppProviderCallbackStringIDMonthNov 

String ID for case: Use string in local language for "November".

FSAppProviderCallbackStringIDMonthDec 

String ID for case: Use string in local language for "December".

FSAppProviderCallbackStringIDToday 

String ID for case: Use string in local language for "Today".

FSAppProviderCallbackStringIDValidateLimit 

Sample message: "Message limit exceeded. Remaining %d validation errors not reported.".

FSAppProviderCallbackStringIDValidateNullWarning 

Sample message: "%s cannot be left blank. To ignore validations for %s, click Ignore.".

FSAppProviderCallbackStringIDValidateNullError 

Sample message: "%s cannot be left blank.".

FSAppProviderCallbackStringIDValidateWarning 

Sample message: "The value you entered for %s is invalid. To ignore validations for %s, click Ignore.".

FSAppProviderCallbackStringIDValidateError 

Sample message: "The value you entered for %s is invalid.".

FSAppProviderCallbackStringIDValidateNumberError 

Sample message: "Illegal value:cannot assign '%s' to %s.".

FSAppProviderCallbackStringIDScriptFailedError 

Sample message: "Script failed(language is %s;context is %s) script=%s".

FSAppProviderCallbackStringIDScriptInvalidValue 

Sample message: "Error:Invalid enumerated value:%s".

FSAppProviderCallbackStringIDSubmitValidateNullError 

Sample message: "At least one required field was empty. Please fill in the required fields(highlighted) before continuing.".

◆ FSAssociatedFilesRelationship

Enumeration for the relationship between PDF document and the associated file.

Values of this enumeration should be used alone.

Enumerator
FSAssociatedFilesRelationshipUnspecified 

The relationship is not known or cannot be described by other values.

FSAssociatedFilesRelationshipSource 

The relationship is "Source" which means the file specification is the original source material for the associated content.

FSAssociatedFilesRelationshipData 

The relationship is "Data" which means the file specification represents information used to derive a visual presentation - such as for a table or a graph.

FSAssociatedFilesRelationshipAlternative 

The relationship is "Alternative" which means the file specification is an alternative representation of content, for example audio.

FSAssociatedFilesRelationshipSupplement 

The relationship is "Supplement" which means the file specification represents a supplemental representation of the original source or data that may be more easily consumable.

FSAssociatedFilesRelationshipEncryptedPayload 

The relationship is "Encrypted payload" which means the file specification is an encrypted payload document that should be displayed to the user if the PDF processor has the cryptographic filter needed to decrypt the document.

FSAssociatedFilesRelationshipFormData 

The relationship is "Form data" which means the file specification is the data associated with the "AcroForm" dictionary in the PDF file.

FSAssociatedFilesRelationshipSchema 

The relationship is "Schema" which means the file specification is a schema definition for the associated object.

◆ FSBarcodeFormat

Enumeration for barcode format.

Values of this enumeration should be used alone.

Enumerator
FSBarcodeFormatCode39 

Barcode format: standard 39 code.

FSBarcodeFormatCode128 

Barcode format: Code128, including EAN128 code.

FSBarcodeFormatEAN8 

Barcode format: EAN-8 code.

FSBarcodeFormatUPCA 

Barcode format: UPC-A code.

FSBarcodeFormatEAN13 

Barcode format: EAN-13 code.

FSBarcodeFormatITF 

Barcode format: ITF code.

FSBarcodeFormatPDF417 

Barcode format: PDF-417 code.

FSBarcodeFormatQRCode 

Barcode format: Quick Response Code.

◆ FSBarcodeQRErrorCorrectionLevel

Enumeration for format error correction level of QR Code.

Values of this enumeration should be used alone.

Enumerator
FSBarcodeQRCorrectionLevelLow 

The capability of recovery from 7% amounts of damage.

FSBarcodeQRCorrectionLevelMedium 

The capability of recovery from 15% amounts of damage.

FSBarcodeQRCorrectionLevelQuater 

The capability of recovery from 25% amounts of damage.

FSBarcodeQRCorrectionLevelHigh 

The capability of recovery from 30% amounts of damage.

◆ FSBitmapDIBFormat

Enumeration for DIB format.

Values of this enumeration should be used alone.

Enumerator
FSBitmapDIBInvalid 

Invalid DIB format.

FSBitmapDIBRgb 

DIB format: 24bpp format, with bits order "Blue, Green, Red". Blue is in the lowest order.

FSBitmapDIBRgb32 

DIB format: 32bpp format, with bits order "Blue, Green, Red, not used". Blue is in the lowest order.

FSBitmapDIBArgb 

DIB format: 32bpp format, with bits order "Blue, Green, Red, Alpha". Blue is in the lowest order.

FSBitmapDIB8bppMask 

DIB format: 8bpp alpha mask.

FSBitmapDIB8bpp 

DIB format: 8bpp format, 256 color RGB bitmap.

FSBitmapDIBRgb565 

16bpp format, bits order: Red 5 bits, Green 6 bits, Blue 5 bits. Red is the lowest order.

◆ FSBitmapInterpolationFlag

Enumeration for bitmap interpolation flags.

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

Enumerator
FSBitmapDownsample 

If set, do not do halftone for shrinking or rotating.

FSBitmapQuadratic 

If set, do interpolation for stretching or transforming.

FSBitmapBicubic 

If set, do bicubic interpolation for stretching or transforming.

◆ FSBookmarkPosition

Enumeration for bookmark position.

Values of this enumeration should be used alone.
Actually, "bookmark position" means the relationship between a bookmark and another bookmark.

Enumerator
FSBookmarkPosFirstChild 

A bookmark is the first child of another specified bookmark.

FSBookmarkPosLastChild 

A bookmark is the last child of another specified bookmark.

FSBookmarkPosPrevSibling 

A bookmark is the previous sibling of another specified bookmark.

FSBookmarkPosNextSibling 

A bookmark is the next sibling of another specified bookmark.

FSBookmarkPosFirstSibling 

A bookmark is the first sibling of another specified bookmark.

FSBookmarkPosLastSibling 

A bookmark is the last sibling of another specified bookmark.

◆ FSBookmarkStyle

Enumeration for bookmark style type.

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

Enumerator
FSBookmarkStyleNormal 

Show bookmark title as normal text.

FSBookmarkStyleItalic 

Show bookmark title as italic text.

FSBookmarkStyleBold 

Show bookmark title as bold text.

◆ FSBorderInfoStyle

Enumeration for PDF annotation border style.

Values of this enumeration should be used alone.

Enumerator
FSBorderInfoSolid 

Border style: Solid.

FSBorderInfoDashed 

Border style: Dashed.

This is only useful for link, free text, line, square, circle, polygon, polyline and screen annotation. If this is set to other type annotation, Foxit PDF SDK will change to set border style as FSBorderInfoSolid by default internally.

FSBorderInfoUnderLine 

Border style: Underline.

This is only useful for link annotation. If this is set to other type annotation, Foxit PDF SDK will change to set border style as FSBorderInfoSolid by default internally.

FSBorderInfoBeveled 

Border style: Beveled.

Currently, Foxit PDF SDK does not support the annotation appearance of this border style. If this is set to any annotation, Foxit PDF SDK will change to set border style as FSBorderInfoSolid by default internally.

FSBorderInfoInset 

Border style: Inset.

Currently, Foxit PDF SDK does not support the annotation appearance of this border style. If this is set to any annotation, Foxit PDF SDK will change to set border style as FSBorderInfoSolid by default internally.

FSBorderInfoCloudy 

Border style: Cloudy.

This is only useful for free text, square, circle, and polygon annotations. If this is set to other type annotation, Foxit PDF SDK will change to set border style as FSBorderInfoSolid by default internally.

◆ FSCompareResultInfoCompareResultType

Enumeration for compare result type.

Values of this enumeration can be used alone.

Enumerator
FSCompareResultInfoCompareResultTypeNone 

Result type: unsupported or invalid.

FSCompareResultInfoCompareResultTypeDeleteText 

Result type: delete text.

FSCompareResultInfoCompareResultTypeInsertText 

Result type: insert text.

FSCompareResultInfoCompareResultTypeReplaceText 

Result type: replace text.

FSCompareResultInfoCompareResultTypeDeleteTable 

(Reserved, not supported yet) Result type: delete table.

FSCompareResultInfoCompareResultTypeInsertTable 

(Reserved, not supported yet) Result type: insert table.

FSCompareResultInfoCompareResultTypeReplaceTable 

(Reserved, not supported yet) Result type: replace table.

FSCompareResultInfoCompareResultTypeDeleteImage 

(Reserved, not supported yet) Result type: delete image.

FSCompareResultInfoCompareResultTypeInsertImage 

(Reserved, not supported yet) Result type: insert image.

FSCompareResultInfoCompareResultTypeReplaceImage 

(Reserved, not supported yet) Result type: replace image.

FSCompareResultInfoCompareResultTypeDeletePath 

(Reserved, not supported yet) Result type: delete path.

FSCompareResultInfoCompareResultTypeInsertPath 

(Reserved, not supported yet) Result type: insert path.

FSCompareResultInfoCompareResultTypeReplacePath 

(Reserved, not supported yet) Result type: replace path.

FSCompareResultInfoCompareResultTypeDeleteShading 

(Reserved, not supported yet) Result type: delete shading.

FSCompareResultInfoCompareResultTypeInsertShading 

(Reserved, not supported yet) Result type: insert shading.

FSCompareResultInfoCompareResultTypeReplaceShading 

(Reserved, not supported yet) Result type: replace shading.

FSCompareResultInfoCompareResultTypeDeleteAnnot 

(Reserved, not supported yet) Result type: delete annotation.

FSCompareResultInfoCompareResultTypeInsertAnnot 

(Reserved, not supported yet) Result type: insert annotation.

FSCompareResultInfoCompareResultTypeReplaceAnnot 

(Reserved, not supported yet) Result type: replace annotation.

FSCompareResultInfoCompareResultTypeTextAttriChange 

(Reserved, not supported yet) Result type: text attribute change.

◆ FSComparisonCompareType

Enumeration for compare type flags.

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

Enumerator
FSComparisonCompareTypeText 

Compare text only.

FSComparisonCompareTypeTable 

(Reserved, not supported yet) Compare table.

◆ FSConnectedPDFEncryptType

Enumeration for encryption mode.

Values of this enumeration should be used alone.

Enumerator
FSConnectedPDFEncryptTypeAES 

AES encryption algorithm.

FSConnectedPDFEncryptTypeSM4CBC 

SM4 electronic codebook mode.

◆ FSDefaultAppearanceDefAPFlags

Enumeration for default appearance flags.

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

Enumerator
FSDefaultAppearanceFlagFont 

Indicates property font of FSDefaultAppearance is meaningful.

FSDefaultAppearanceFlagTextColor 

Indicates property text color of FSDefaultAppearance is meaningful.

FSDefaultAppearanceFlagFontSize 

Indicates property text size of FSDefaultAppearance is meaningful.

◆ FSDestinationZoomMode

Enumeration for zoom mode.

Values of this enumeration should be used alone.

Enumerator
FSDestinationZoomXYZ 

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

If this is used, that means the specified position of the page will be treated as the left-top position when the page is rendered and this position should be at the upper-left corner of the display area. Contents of the page should be magnified by the specified zoom factor.

FSDestinationZoomFitPage 

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

If this is used, that means the contents of the page should be magnified just enough to fit the entire page within the display area both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the page within the window in the other dimension.

FSDestinationZoomFitHorz 

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

If this is used, that means the contents of the page should be magnified just enough to fit the entire width of the page within the display area.

FSDestinationZoomFitVert 

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

If this is used, that means the contents of the page should be magnified just enough to fit the entire height of the page within the display area.

FSDestinationZoomFitRect 

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

If this is used, that means the contents of the page should be magnified just enough to fit the page content in the specified rectangle entirely within the display area both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the rectangle within the display area in the other dimension.

FSDestinationZoomFitBBox 

Fit the bounding box of page entirely within the display area when display the page.

If this is used, that means the contents of the page should be magnified just enough to fit its bounding box entirely within the display area both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the bounding box within the display area in the other dimension.

FSDestinationZoomFitBHorz 

Fit the entire width of the page's bounding box within the display area when display the page.

If this is used, that means the contents of the page should be magnified just enough to fit the entire width of the page's bounding box within the display area.

FSDestinationZoomFitBVert 

Fit the entire height of the page's bounding box within the display area when display the page.

If this is used, that means the contents of the page should be magnified just enough to fit the entire height of the page's bounding box within the display area.

◆ FSDocProviderCallbackInvalidateFlag

Enumeration for XFA invalidate flag.

Values of this enumeration should be used alone.

Enumerator
FSDocProviderCallbackInvalidateFlagAllPages 

Invalidate all pages.

FSDocProviderCallbackInvalidateFlagCurrentPage 

Invalidate current page.

◆ FSDocProviderCallbackPageViewEventType

Enumeration for the event type of page view.

Values of this enumeration should be used alone.

Enumerator
FSDocProviderCallbackPageViewEventTypeAdded 

Event type: after a page view is added.

FSDocProviderCallbackPageViewEventTypeRemoved 

Event type: after a page view is removed.

FSDocProviderCallbackPageViewEventTypeAllRemoved 

Event type: all page views are removed.

◆ FSDocProviderCallbackPrintOption

Enumeration for XFA print options.

Values of this enumeration should be used alone.

Enumerator
FSDocProviderCallbackPrintOptionShowDialog 

If set, show printing dialog box.

FSDocProviderCallbackPrintOptionCanCancel 

If set, that means printing process can be canceled.

FSDocProviderCallbackPrintOptionShrinkPage 

If set, shrink page to fit within content area.

FSDocProviderCallbackPrintOptionAsImage 

If set, print page as image; otherwise, as text.

FSDocProviderCallbackPrintOptionReverseOrder 

If set, print page in reverse order; otherwise, in normal order.

FSDocProviderCallbackPrintOptionPrintAnnot 

If set, print annotations.

◆ FSDocProviderCallbackSubmitFormat

Enumeration for XFA submit format.

Values of this enumeration should be used alone.

Enumerator
FSDocProviderCallbackSubmitInXDP 

The submit data is packaged in XDP format, as described in XDP Specification.

FSDocProviderCallbackSubmitInPDF 

The submit data is packaged in PDF format as described in the PDF Reference.

FSDocProviderCallbackSubmitInUrlEncoded 

The submit data is packaged in URL-encoded format as described in Uniform Resource Locator(URL).

FSDocProviderCallbackSubmitInXFD 

The submit data is packaged in XFD format, as described in XFDF.

FSDocProviderCallbackSubmitInXML 

The submit data is translated and packaged into an URL-Encoded format.

◆ FSDocProviderCallbackTextEncoding

Enumeration for text encoding for XFA submit.

Values of this enumeration should be used alone.

Enumerator
FSDocProviderCallbackTextEncodingNone 

No text encoding.

FSDocProviderCallbackTextEncodingBig5 

Text encoding: Big5.

FSDocProviderCallbackTextEncodingFontSpecific 

Text encoding: font specific.

FSDocProviderCallbackTextEncodingGBK 

Text encoding: GBK.

FSDocProviderCallbackTextEncodingGB18030 

Text encoding: GB18030.

FSDocProviderCallbackTextEncodingGB2312 

Text encoding: GB2312.

FSDocProviderCallbackTextEncodingISO8859NN 

Text encoding: ISO8859NN.

FSDocProviderCallbackTextEncodingKSC5601 

Text encoding: KSC5601.

FSDocProviderCallbackTextEncodingShiftJIS 

Text encoding: ShiftJIS.

FSDocProviderCallbackTextEncodingUCS2 

Text encoding: UCS-2.

FSDocProviderCallbackTextEncodingUTF16 

Text encoding: UTF-16.

FSDocProviderCallbackTextEncodingUTF8 

Text encoding: UTF-8.

◆ FSDocProviderCallbackWidgetEventType

Enumeration for the type of XFA widget event.

Values of this enumeration should be used alone.

Enumerator
FSDocProviderCallbackWidgetEventTypeAdded 

Event type: after an XFA widget is added.

FSDocProviderCallbackWidgetEventTypeBeforeRemoved 

Event type: before an XFA widget is removed.

◆ FSDocViewerPrefsPrintScale

Enumeration for page scaling option.

Values of this enumeration should be used alone.

Enumerator
FSDocViewerPrefsPrintScaleNone 

This means the print dialog should reflect no page scaling.

FSDocViewerPrefsPrintScaleAppDefault 

This means applications should use the current print scaling.

◆ FSDocViewerPrefsViewerPref

Enumeration for how various GUI elements should behave when the document is opened.

Values of this enumeration should be used alone.

Enumerator
FSDocViewerPrefsHideToolbar 

A flag specifying whether to hide the viewer application's tool bars when the document is active.

FSDocViewerPrefsHideMenubar 

A flag specifying whether to hide the viewer application's menu bar when the document is active.

FSDocViewerPrefsHideWindowUI 

A flag specifying whether to hide user interface elements in the document's window (such as scroll bars and navigation controls), leaving only the document's contents displayed.

FSDocViewerPrefsFitWindow 

A flag specifying whether to resize the document's window to fit the size of the first displayed page.

FSDocViewerPrefsCenterWindow 

A flag specifying whether to position the document's window in the center of the screen.

FSDocViewerPrefsDisplayDocTitle 

A flag specifying whether the window's title bar should display the document title taken from the "Title" entry of the document information dictionary. If NO, the title bar should instead display the name of the PDF file containing the document.

◆ FSErrorCode

Enumeration for error code.

Values of this enumeration should be used alone.

Enumerator
FSErrSuccess 

Success, and no error occurs.

FSErrFile 

File cannot be found or could not be opened.

FSErrFormat 

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

FSErrPassword 

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.

FSErrHandle 

Error handle.

FSErrCertificate 

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

FSErrUnknown 

Any unknown error occurs.

FSErrInvalidLicense 

Invalid license is used to initialize Foxit PDF SDK library.

FSErrParam 

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

FSErrUnsupported 

Some types are not supported.

FSErrOutOfMemory 

Out-of-memory error occurs.

FSErrSecurityHandler 

PDF document is encrypted by some unsupported security handler.

FSErrNotParsed 

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

FSErrNotFound 

Expected data or object is not found.

FSErrInvalidType 

The type of input object or current object is invalid.

FSErrConflict 

New data conflicts with existed data.

FSErrUnknownState 

Any unknown state occurs.

FSErrDataNotReady 

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

FSErrInvalidData 

Data of current object is invalid.

FSErrXFALoadError 

XFA loading error.

FSErrNotLoaded 

Current object has not been loaded yet.

FSErrInvalidState 

Invalid or incorrect state.

FSErrNotCDRM 

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

FSErrCanNotConnectToServer 

(For ConnectedPDF only) Cannot connect to ConnectedPDF server.

FSErrInvalidUserToken 

(For ConnectedPDF only) Input user token is invalid.

FSErrNoRights 

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

FSErrRightsExpired 

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

FSErrDeviceLimitation 

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

FSErrCanNotRemoveSecurityFromServer 

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

FSErrCanNotGetACL 

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

FSErrCanNotSetACL 

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

FSErrIsAlreadyCPDF 

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

FSErrIsAlreadyCDRM 

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

FSErrCanNotUploadDocInfo 

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

FSErrCanNotUploadCDRMInfo 

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

FSErrInvalidWrapper 

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

FSErrCanNotGetClientID 

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

FSErrCanNotGetUserToken 

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

FSErrInvalidACL 

(For ConnectedPDF only) Input ACL is invalid.

FSErrInvalidClientID 

(For ConnectedPDF only) Input client ID is invalid.

FSErrOCREngineNotInit 

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

FSErrDiskFull 

(For OCR only) Not enough disk space.

FSErrOCRTrialIsEnd 

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

FSErrFilePathNotExist 

File or folder path does not exist.

FSErrComplianceEngineNotInit 

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

FSErrComplianceEngineInvalidUnlockCode 

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

FSErrComplianceEngineInitFailed 

(For compliance only) Fail to initialize compliance engine.

◆ FSFDFDocType

Enumeration for FDF document type.

Values of this enumeration should be used alone.

Enumerator
FSFDFDocFDF 

FDF document type: FDF.

FSFDFDocXFDF 

FDF document type: XFDF.

◆ FSFieldFlags

Enumeration for form field flags.

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

Enumerator
FSFieldFlagReadOnly 

If set, the user may not change the value of the field. Any associated widget annotations will not interact with the user; that is, they will not respond to mouse clicks or change their appearance in response to mouse motions. This flag is useful for fields whose values are computed or imported from a database.

FSFieldFlagRequired 

If set, the field must have a value at the time it is exported by a submit-form action.

FSFieldFlagNoExport 

if set, the field must not be exported by a submit-form action.

FSFieldFlagButtonNoToggleToOff 

(Only useful for radio button) If set, exactly one radio button must be selected at all times; clicking the currently selected button has no effect. If clear, clicking the selected button deselects it, leaving no button selected.

FSFieldFlagButtonRadiosInUnison 

(Only useful for radio button) If set, a group of radio buttons within a radio button field that use the same value for the on state will turn on and off in unison; that is if one is checked, they are all checked. If clear, the buttons are mutually exclusive.

FSFieldFlagTextMultiline 

(Only useful for text field) If set, the text field can contain multiple lines of text; if clear, the field's text is restricted to a single line.

FSFieldFlagTextPassword 

(Only useful for text field) If set, the field is intended for entering a secure password that should not be echoed visibly to the screen. Characters typed from the keyboard should instead be echoed in some unreadable form, such as asterisks or bullet characters.

Note
To protect password confidentiality, viewer applications should never store the value of the text field in the PDF file if this flag is set.
FSFieldFlagTextDoNotScroll 

(Only useful for text field) If set, the field does not scroll (horizontally for single-line fields, vertically for multiple-line fields) to accommodate more text than fits within its annotation rectangle. Once the field is full, no further text is accepted.

FSFieldFlagTextComb 

(Only useful for text field) If set, use combs.

If set, the field is automatically divided into as many equally spaced positions, or combs, as the value of maximum length of a field's text, and the text is laid out into those combs.

FSFieldFlagComboEdit 

(Only useful for combo box) If set, the combo box includes an editable text control with a drop-down list, if clear, it includes only a drop-down list.

FSFieldFlagChoiseMultiSelect 

(Only useful for combo box and list box) If set, more than one items may be selected simultaneously; if clear, no more than one item at a time may be selected.

◆ FSFieldType

Enumeration for form field type.

Values of this enumeration should be used alone.

Enumerator
FSFieldTypeUnknown 

Form field type: unknown.

FSFieldTypePushButton 

Form field type: push button.

FSFieldTypeCheckBox 

Form field type: check box.

FSFieldTypeRadioButton 

Form field type: radio button.

FSFieldTypeComboBox 

Form field type: combo box.

FSFieldTypeListBox 

Form field type: list box.

FSFieldTypeTextField 

Form field type: text field.

FSFieldTypeSignature 

Form field type: signature field.

◆ FSFillerEventFlags

Enumeration for key event flags.

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

Enumerator
FSFillerEventFlagShiftKey 

Event flag: "Shift" key.

FSFillerEventFlagControlKey 

Event flag: "Ctrl" key.

FSFillerEventFlagAltKey 

Event flag: "Alt" key.

FSFillerEventFlagMetaKey 

Event flag: meta key.

FSFillerEventFlagKeyPad 

Event flag: key pad.

FSFillerEventFlagAutoRepeat 

Event flag: auto repeat.

FSFillerEventFlagLeftButtonDown 

Event flag: the left button of the mouse is down.

FSFillerEventFlagMiddleButtonDown 

Event flag: the middle button of the mouse is down.

FSFillerEventFlagRightButtonDown 

Event flag: the right button of the mouse is down.

FSFillerEventFlagCommand 

Event flag: the command key.

◆ FSFillerVirtualKeyCode

Enumeration for virtual key code.

Values of this enumeration should be used alone.

Enumerator
FSFillerVkeyUnknown 

An unknown key.

FSFillerVkeyBack 

Backspace key.

FSFillerVkeyTab 

Tab key.

FSFillerVkeyReturn 

Enter key.

FSFillerVkeyShift 

Shift key.

FSFillerVkeyControl 

Ctrl key.

FSFillerVkeyMenu 

Menu key.

FSFillerVkeyPause 

Pause Break key.

FSFillerVkeyEscape 

ESC key.

FSFillerVkeySpace 

Space key.

FSFillerVkeyPrior 

Page Up key.

FSFillerVkeyNext 

Page Down key.

FSFillerVkeyEnd 

End key.

FSFillerVkeyHome 

Home key.

FSFillerVkeyLeft 

Left arrow key.

FSFillerVkeyUp 

Up arrow key.

FSFillerVkeyRight 

Right arrow key.

FSFillerVkeyDown 

Down arrow key.

FSFillerVkeyPrint 

Print key.

FSFillerVkeySnapshot 

Print Screen key.

FSFillerVkeyInsert 

Insert key.

FSFillerVkeyDelete 

Delete key.

FSFillerVkeyHelp 

Help key.

FSFillerVkey0 

0 key.

FSFillerVkey1 

1 key.

FSFillerVkey2 

2 key.

FSFillerVkey3 

3 key.

FSFillerVkey4 

4 key.

FSFillerVkey5 

5 key.

FSFillerVkey6 

6 key.

FSFillerVkey7 

7 key.

FSFillerVkey8 

8 key.

FSFillerVkey9 

9 key.

FSFillerVkeyA 

A key.

FSFillerVkeyB 

B key.

FSFillerVkeyC 

C key.

FSFillerVkeyD 

D key.

FSFillerVkeyE 

E key.

FSFillerVkeyF 

F key.

FSFillerVkeyG 

G key.

FSFillerVkeyH 

H key.

FSFillerVkeyI 

I key.

FSFillerVkeyJ 

J key.

FSFillerVkeyK 

K key.

FSFillerVkeyL 

L key.

FSFillerVkeyM 

M key.

FSFillerVkeyN 

N key.

FSFillerVkeyO 

O key.

FSFillerVkeyP 

P key.

FSFillerVkeyQ 

Q key.

FSFillerVkeyR 

R key.

FSFillerVkeyS 

S key.

FSFillerVkeyT 

T key.

FSFillerVkeyU 

U key.

FSFillerVkeyV 

V key.

FSFillerVkeyW 

W key.

FSFillerVkeyX 

X key.

FSFillerVkeyY 

Y key.

FSFillerVkeyZ 

Z key.

FSFillerVkeyNumpad0 

0 key in the numeric keypad.

FSFillerVkeyNumpad1 

1 key in the numeric keypad.

FSFillerVkeyNumpad2 

2 key in the numeric keypad.

FSFillerVkeyNumpad3 

3 key in the numeric keypad.

FSFillerVkeyNumpad4 

4 key in the numeric keypad.

FSFillerVkeyNumpad5 

5 key in the numeric keypad.

FSFillerVkeyNumpad6 

6 key in the numeric keypad.

FSFillerVkeyNumpad7 

7 key in the numeric keypad.

FSFillerVkeyNumpad8 

8 key in the numeric keypad.

FSFillerVkeyNumpad9 

9 key in the numeric keypad.

FSFillerVkeyMultiply 

Multiply key in the numeric keypad.

FSFillerVkeyAdd 

Plus key in the numeric keypad.

FSFillerVkeySeparator 

Enter key in the numeric keypad.

FSFillerVkeySubtract 

Minus key in the numeric keypad.

FSFillerVkeyDecimal 

Dot key in the numeric keypad.

FSFillerVkeyDivide 

Slash key in the numeric keypad.

FSFillerVkeyF1 

F1 key.

FSFillerVkeyF2 

F2 key.

FSFillerVkeyF3 

F3 key.

FSFillerVkeyF4 

F4 key.

FSFillerVkeyF5 

F5 key.

FSFillerVkeyF6 

F6 key.

FSFillerVkeyF7 

F7 key.

FSFillerVkeyF8 

F8 key.

FSFillerVkeyF9 

F9 key.

FSFillerVkeyF10 

F10 key.

FSFillerVkeyF11 

F11 key.

FSFillerVkeyF12 

F12 key.

◆ FSFillMode

enum FSFillMode

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

Values of this enumeration should be used alone.

Enumerator
FSFillModeNone 

Fill mode: none.

FSFillModeAlternate 

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

FSFillModeWinding 

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

◆ FSFixupDataFixupState

Enumeration for the state of a fixup data.

Values of this enumeration should be used alone.

Enumerator
FSFixupDataFixupStateSuccess 

A fixup succeeded.

FSFixupDataFixupStateFailure 

A fixup failed.

FSFixupDataFixupStateNotRequired 

A fixup was not required.

◆ FSFontCharset

Enumeration for font charset.

Values of this enumeration should be used alone.

Enumerator
FSFontCharsetANSI 

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

FSFontCharsetDefault 

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

FSFontCharsetSymbol 

Font charset: Standard symbols.

FSFontCharsetShift_JIS 

Font charset: Japanese (Shift-JIS).

FSFontCharsetHangeul 

Font charset: Korean (Wansung).

FSFontCharsetGB2312 

Font charset: Simplified Chinese.

FSFontCharsetChineseBig5 

Font charset: Traditional Chinese.

FSFontCharsetThai 

Font charset: Thai.

FSFontCharsetEastEurope 

Font charset: Eastern European.

FSFontCharsetRussian 

Font charset: Russian.

FSFontCharsetGreek 

Font charset: Greek.

FSFontCharsetTurkish 

Font charset: Turkish.

FSFontCharsetHebrew 

Font charset: Hebrew.

FSFontCharsetArabic 

Font charset: Arabic.

FSFontCharsetBaltic 

Font charset: Baltic.

◆ FSFontStandardID

Enumeration for standard font ID.

Values of this enumeration should be used alone.

Enumerator
FSFontStdIDCourier 

Standard font: Courier.

FSFontStdIDCourierB 

Standard font: Courier-Bold.

FSFontStdIDCourierBI 

Standard font: Courier-BoldOblique, Bold italic.

FSFontStdIDCourierI 

Standard font: Courier-Oblique, Italic.

FSFontStdIDHelvetica 

Standard font: Helvetica.

FSFontStdIDHelveticaB 

Standard font: Helvetica-Bold.

FSFontStdIDHelveticaBI 

Standard font: Helvetica-BoldOblique, Bold italic.

FSFontStdIDHelveticaI 

Standard font: Helvetica-Oblique, Italic.

FSFontStdIDTimes 

Standard font: Times-Roman.

FSFontStdIDTimesB 

Standard font: Times-Bold.

FSFontStdIDTimesBI 

Standard font: Times-BoldItalic.

FSFontStdIDTimesI 

Standard font: Times-Italic.

FSFontStdIDSymbol 

Standard font: Symbol.

FSFontStdIDZapfDingbats 

Standard font: ZapfDingbats.

◆ FSFontStyles

Enumeration for font styles.

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

Enumerator
FSFontStyleFixedPitch 

Font style: fixed pitch.

FSFontStyleSerif 

Font style: serif.

FSFontStyleSymbolic 

Font style: symbolic.

FSFontStyleScript 

Font style: script.

FSFontStyleNonSymbolic 

Font style: non-symbolic.

FSFontStyleItalic 

Font style: italic.

FSFontStyleAllCap 

Font style: all cap.

FSFontStylesSmallCap 

Font style: small cap.

FSFontStylesBold 

Font style: force bold.

◆ FSFullTextSearchRankMode

Enumeration for rank mode of full text search.

Values of this enumeration should be used alone.

Enumerator
FSFullTextSearchRankNone 

No ranking mode is used for searching results.

FSFullTextSearchRankHitCountASC 

Rank the searching results according to how the result matches the expected searching patten, in ascending order (from less similar to most similar or the same).

FSFullTextSearchRankHitCountDESC 

Rank the searching results according to how the result matches the expected searching patten, in descending order (from the same or most similar to less similar).

◆ FSGraphicsObjectBlendMode

Enumeration for render blend mode.

Values of this enumeration should be used alone.

Enumerator
FSGraphicsObjectBlendNormal 

Selecting source color and ignoring backdrop color.

Here is the formula :

B(Cb, Cs) = Cs.
FSGraphicsObjectBlendMultiply 

Multiply backdrop by source color values.

Here is the formula :

B(Cb, Cs) = Cb * Cs.
FSGraphicsObjectBlendScreen 

Multiply complements of backdrop by source color values, and then complement the result.

Here is the formula :

B(Cb, Cs) = 1 - [(1 - Cb) * (1 - Cs)] = Cb + Cs - Cb * Cs.
FSGraphicsObjectBlendOverlay 

Multiply or screens colors, depending on backdrop color value.

Here is the formula :

B(Cb, Cs) = HardLight(Cs, Cb).
FSGraphicsObjectBlendDarken 

Select darker one of backdrop and source colors.

Here is the formula :

B(Cb, Cs) = min(Cb, Cs).
FSGraphicsObjectBlendLighten 

Select lighter one of backdrop and source colors.

Here is the formula :

B(Cb, Cs) = max(Cb, Cs).
FSGraphicsObjectBlendColorDodge 

Brightens backdrop color to reflect source colors.

Painting with black produces no changes.
Here is the formula :

         B(Cb, Cs) =
         -min(1, Cb / (1 - Cs))    if Cs < 1
         -1              if Cs = 1
         
FSGraphicsObjectBlendColorBurn 

Darkens backdrop color to reflect the source color.

Painting with white produces no changes.
Here is the formula :

         B(Cb, Cs) =
         -1 - min(1, (1 - Cb) / Cs)  if Cs > 0
         -0              if Cs = 0
         
FSGraphicsObjectBlendHardlight 

Multiply or screens colors, depending on source color value.

Here is the formula :

         B(Cb, Cs) =
           -Multiply(Cb, 2 * Cs)    if Cs <= 0.5
           -Screen(Cb, 2 * Cs - 1)  if Cs > 0.5
         
FSGraphicsObjectBlendSoftlight 

Darkens or lightens colors, depending on source color value.

Here is the formula :

         B(Cb, Cs) =
           -Cb - (1 - 2 * Cs) * Cb * (1 - Cb)    if Cs <= 0.5
           -Cb + (2 * Cs - 1) * (D(Cb) - Cb)    if Cs > 0.5
         where D(x) =
           -((16 * x - 12) * x + 4) * x      if x <= 0.25
         -sqrt(x)                if x > 0.25
         
FSGraphicsObjectBlendDifference 

Subtracts the darker of the two constituent colors from lighter colors.

Here is the formula :

B(Cb, Cs) = |Cb - Cs|.
FSGraphicsObjectBlendExclusion 

Creates a color with the hue of the source color, and the saturation and luminosity of the backdrop color.

Here is the formula :

B(Cb, Cs) = SetLum(SetSat(Cs, Sat(Cb)), Lum(Cb)).
FSGraphicsObjectBlendHue 

Creates a color with the hue of the source color, and the saturation and luminosity of the backdrop color.

Here is the formula :

B(Cb, Cs) = SetLum(SetSat(Cs, Sat(Cb)), Lum(Cb)).
FSGraphicsObjectBlendSaturation 

Creates a color with the saturation of the source color, and the hue and luminosity of the backdrop color.

Here is the formula :

B(Cb, Cs) = SetLum(SetSat(Cb, Sat(Cs)), Lum(Cb)).
FSGraphicsObjectBlendColor 

Creates a color with the hue and saturation of the source color, and the luminosity of the backdrop color.

Here is the formula :

B(Cb, Cs) = SetLum(Cs, Lum(Cb)).
FSGraphicsObjectBlendLuminosity 

Creates a color with the luminosity of the source color, and the hue and saturation of the backdrop color.

Here is the formula :

B(Cb, Cs) = SetLum(Cb, Lum(Cs)).

◆ FSGraphicsObjectType

Enumeration for PDF graphics object type.

Values of this enumeration should be used alone.

Enumerator
FSGraphicsObjectTypeAll 

Represents all graphics object types, only used as filter.

FSGraphicsObjectTypeText 

Text graphics object.

FSGraphicsObjectTypePath 

Path graphics object.

FSGraphicsObjectTypeImage 

Image graphics object.

FSGraphicsObjectTypeShading 

Shading graphics object.

FSGraphicsObjectTypeFormXObject 

Form XObject graphics object.

◆ FSGraphStateLineCapStyle

Enumeration for line cap style.

Values of this enumeration should be used alone. The line cap style specifies the shape to be used at the ends of open sub paths (and dashes, if any) when they are stroked.

Enumerator
FSGraphStateLineCapButt 

Butt cap. The stroke is squared off at the endpoint of a path. There is no projection beyond the end of a path.

FSGraphStateLineCapRound 

Round cap. A semicircular arc with a diameter equal to the line width is drawn around the endpoint and filled in.

FSGraphStateLineCapSquare 

Projecting square cap. The stroke continues beyond the endpoint of the path for a distance equal to half the line width and is squared off.

◆ FSGraphStateLineJoinStyle

Enumeration for line join style.

Values of this enumeration should be used alone. The line join style specifies the shape to be used at the corners of paths that are stroked.

Enumerator
FSGraphStateLineJoinMiter 

Miter line join type.

The outer edges of the strokes for the two segments are extended until they meet at an angle.

FSGraphStateLineJoinRound 

Round line join type.

An arc of a circle with a diameter equal to the line width is drawn around the point where the two segments meet, connecting the outer edges of the strokes for the two segments.

FSGraphStateLineJoinBevel 

Bevel line join type.

The two segments are finished with butt caps and the resulting notch beyond the end of the segments is filled with a triangle.

◆ FSHitDataCheckSeverity

Enumeration for check severity of a hit data.

Values of this enumeration should be used alone.

Enumerator
FSHitDataCheckSeverityInfo 

Info severity.

FSHitDataCheckSeverityWarning 

Warning severity.

FSHitDataCheckSeverityError 

Error severity.

◆ FSIconFitScaleWayType

Enumeration for the type of icon scaling way.

Values of this enumeration should be used alone.

Enumerator
FSIconFitScaleWayAlways 

Always scale.

FSIconFitScaleWayBigger 

Scale only when icon is bigger than annotation rectangle.

FSIconFitScaleWaySmaller 

Scale only when icon is smaller than annotation rectangle.

FSIconFitScaleWayNever 

Never scale.

◆ FSImageObjectColorSpace

Enumeration for image color space.

Values of this enumeration should be used alone.

Enumerator
FSImageObjectColorSpaceInvalid 

Color space: Invalid.

FSImageObjectColorSpaceDeviceGray 

Color space: DeviceGray.

FSImageObjectColorSpaceDeviceRGB 

Color space: DeviceRGB.

FSImageObjectColorSpaceDeviceCMYK 

Color space: DeviceCMYK.

FSImageObjectColorSpaceCalGray 

Color space: CalGray.

FSImageObjectColorSpaceCalRGB 

Color space: CalRGB.

FSImageObjectColorSpaceLab 

Color space: Lab.

FSImageObjectColorSpaceSeparation 

Color space: Separation.

FSImageObjectColorSpaceDeviceN 

Color space: DeviceN.

FSImageObjectColorSpacePattern 

Color space: Pattern.

FSImageObjectColorSpaceICCBasedDeviceGray 

Color space: ICCBased DeviceGray.

FSImageObjectColorSpaceICCBasedDeviceRGB 

Color space: ICCBased DeviceRGB.

FSImageObjectColorSpaceICCBasedDeviceCMYK 

Color space: ICCBased DeviceCMYK.

◆ FSImageType

Enumeration for image type.

Values of this enumeration should be used alone.

Enumerator
FSImageUnknown 

Unknown image type.

FSImageNone 

Not have image type yet.

Note
This is only for a new image object, which is not constructed from any image file or retrieved from other object.
FSImageBMP 

Image type is BMP.

FSImageJPG 

Image type is JPG or JPeg.

FSImagePNG 

Image type is PNG.

FSImageGIF 

Image type is GIF.

FSImageTIF 

Image type is TIF or TIFF.

FSImageJPX 

Image type is JPX or JPeg-2000.

FSImageJBIG2 

Image type is JBIG2.

Note
Currently, only few functions in class FSImage support this type.

◆ FSLayerContextUsageType

Enumeration for PDF layer usage type.

Values of this enumeration should be used alone.

Enumerator
FSLayerContextUsageView 

Use for a viewer.

FSLayerContextUsageDesign 

Use for representing a document designer's structural organization of artwork.

FSLayerContextUsagePrint 

Use for printing.

FSLayerContextUsageExport 

Use for exporting.

FSLayerContextUsageZoom 

Use for zooming.

◆ FSLayerTreeUsageState

Enumeration for PDF layer base state.

Values of this enumeration should be used alone.

Enumerator
FSLayerTreeStateON 

The state is ON.

FSLayerTreeStateOFF 

The state is OFF.

FSLayerTreeStateUnchanged 

The state is unchanged.

FSLayerTreeStateUndefined 

The state is undefined.

◆ FSLineCapPos

Enumeration for the position type of caption.

Values of this enumeration should be used alone.

Enumerator
FSLineCapPosInline 

The caption shall be centered inside the line

FSLineCapPosTop 

The caption shall be on top of the line

◆ FSMarkupEndingStyle

Enumeration for line ending style.

Values of this enumeration should be used alone.

Enumerator
FSMarkupEndingStyleNone 

No special line ending.

FSMarkupEndingStyleSquare 

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

FSMarkupEndingStyleCircle 

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

FSMarkupEndingStyleDiamond 

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

FSMarkupEndingStyleOpenArrow 

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

FSMarkupEndingStyleClosedArrow 

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.

FSMarkupEndingStyleButt 

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

FSMarkupEndingStyleROpenArrow 

Two short lines in the reverse direction from OpenArrow.

FSMarkupEndingStyleRClosedArrow 

A triangular closed arrowhead in the reverse direction from ClosedArrow.

FSMarkupEndingStyleSlash 

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

◆ FSMarkupState

Enumeration for markup annotation's state.

Values of this enumeration should be used alone.

Enumerator
FSMarkupStateMarked 

(Used for FSMarkupStateModelMarked) The annotation has been marked by the user.

FSMarkupStateUnmarked 

(Used for FSMarkupStateModelMarked) The annotation has not been marked by the user.

FSMarkupStateAccepted 

(Used for FSMarkupStateModelReview) The user agrees with the change.

FSMarkupStateRejected 

(Used for FSMarkupStateModelReview) The user disagrees with the change.

FSMarkupStateCancelled 

(Used for FSMarkupStateModelReview) The change has been cancelled.

FSMarkupStateCompleted 

(Used for FSMarkupStateModelReview) The change has been completed.

FSMarkupStateNone 

(Used for FSMarkupStateModelReview) The user has indicated nothing about the change.

◆ FSMarkupStateModel

Enumeration for markup annotation's state model.

Values of this enumeration should be used alone.

Enumerator
FSMarkupStateModelMarked 

Markup annotation state model: marked.

FSMarkupStateModelReview 

Markup annotation state model: review.

◆ FSPageLabelsStyle

Enumeration for page label style.

Values of this enumeration should be used alone.

Enumerator
FSPageLabelsNone 

Page label style: no numbering style.

This means page labels consist solely of a label prefix with no numeric portion.

FSPageLabelsDecimalNums 

Page label style: decimal Arabic numerals.

FSPageLabelsUpperRomanNums 

Page label style: uppercase roman numerals.

FSPageLabelsLowerRomanNums 

Page label style: lowercase roman numerals.

FSPageLabelsUpperLetters 

Page label style: uppercase letters.

If this style is used, A to Z will be used for the first 26 pages, AA to ZZ will be used for the next 26, and so on.

FSPageLabelsLowerLetters 

Page label style: lowercase letters.

If this style is used, a to z will be used for the first 26 pages, aa to zz will be used for the next 26, and so on.

◆ FSPathPointType

Enumeration for point type in path.

Values of this enumeration should be used alone.

Enumerator
FSPathTypeMoveTo 

Indicates that the point is the first point of a figure.

FSPathTypeLineTo 

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

FSPathTypeLineToCloseFigure 

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

FSPathTypeBezierTo 

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

FSPathTypeBezierToCloseFigure 

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

◆ FSPDFAComplianceVersion

Enumeration for PDF/A version.

Values of this enumeration should be used alone.

Enumerator
FSPDFAComplianceVersionPDFA1a 

PDF/A-1a.

FSPDFAComplianceVersionPDFA1b 

PDF/A-1b.

FSPDFAComplianceVersionPDFA2a 

PDF/A-2a.

FSPDFAComplianceVersionPDFA2b 

PDF/A-2b.

FSPDFAComplianceVersionPDFA2u 

PDF/A-2u.

FSPDFAComplianceVersionPDFA3a 

PDF/A-3a.

FSPDFAComplianceVersionPDFA3b 

PDF/A-3b.

FSPDFAComplianceVersionPDFA3u 

PDF/A-3u.

◆ FSPDFDocDataType

Enumeration for data type used to decide which object(s) will be imported from or exported to FDF/XFDF document.

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

Enumerator
FSPDFDocForms 

If set, form fields are to imported from or exported to FDF/XFDF document.

FSPDFDocAnnots 

If set, annotations (except link annotations) are to imported from or exported to FDF/XFDF document.

FSPDFDocLinks 

(Reserved, not supported yet) If set, only link annotations are to imported from or exported to XFDF document.

◆ FSPDFDocDisplayMode

Enumeration for display mode which specifies how the document should be displayed when opened.

Values of this enumeration should be used alone.

Enumerator
FSPDFDocDisplayUseNone 

When document is opened, neither document outlines nor thumbnail images are visible.

FSPDFDocDisplayUseOutlines 

When document is opened, document outlines (bookmarks) are visible.

FSPDFDocDisplayUseThumbs 

When document is opened, thumbnail images are visible.

FSPDFDocDisplayFullScreen 

When document is opened, full-screen mode, with no menu bar, window controls, or any other windows are visible.

FSPDFDocDisplayUseOC 

When document is opened, optional content group panels are visible.

FSPDFDocDisplayUseAttachment 

When document is opened, attachment panels are visible.

◆ FSPDFDocEncryptType

Enumeration for encryption type.

Values of this enumeration should be used alone.

Enumerator
FSPDFDocEncryptUnknown 

Unknown encryption type.

FSPDFDocEncryptNone 

No encryption pattern.

FSPDFDocEncryptPassword 

Encryption type: password, which is the standard encryption.

FSPDFDocEncryptCertificate 

Encryption type: digital certificate encryption.

FSPDFDocEncryptFoxitDRM 

Encryption type: Foxit DRM encryption.

FSPDFDocEncryptCustom 

Encryption type: customized encryption.

FSPDFDocEncryptRMS 

Encryption type: Microsoft RMS encryption.

FSPDFDocEncryptCDRM 

Encryption type: Foxit connected PDF DRM encryption.

◆ FSPDFDocImportPageFlags

Enumeration for flags used for importing pages.

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

Enumerator
FSPDFDocImportFlagNormal 

Import pages normally.

FSPDFDocImportFlagWithLayers 

Import pages with layers.

FSPDFDocImportFlagShareStream 

Import pages without cloning stream objects into memory.

This flags is only useful when the source PDF document has not been encrypted. If this flag is used for importing pages, it will reduce memory overhead.

◆ FSPDFDocPasswordType

Enumeration for the type of current used password in a PDF document.

Values of this enumeration should be used alone.

Enumerator
FSPDFDocPwdInvalid 

The password is invalid.

FSPDFDocPwdNoPassword 

No password is used in PDF document.

FSPDFDocPwdUser 

A user password is used in PDF document.

FSPDFDocPwdOwner 

An owner password is used in PDF document.

◆ FSPDFDocSaveFlags

Enumeration for PDF document saving flags.

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

Enumerator
FSPDFDocSaveFlagNormal 

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

FSPDFDocSaveFlagIncremental 

Save document incrementally.

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

FSPDFDocSaveFlagNoOriginal 

Save document without original data or unchanged objects.

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

FSPDFDocSaveFlagXRefStream 

Save document by using XRef stream.

This can be used alone or be combined with other saving flags except FSPDFDocSaveFlagNormal.

FSPDFDocSaveFlagLinearized 

Save document as a linearized file.

This should be used alone and cannot be used with other saving flags. This can only be used for function FSPDFDoc::saveAs:save_flags: or FSPDFDoc::startSaveAs:save_flags:pause:.

FSPDFDocSaveFlagRemoveRedundantObjects 

Save document with removing redundant PDF objects.

This can be used alone or be combined with FSPDFDocSaveFlagNoOriginal or FSPDFDocSaveFlagXRefStream. This can only be used for function FSPDFDoc::saveAs:save_flags: or FSPDFDoc::startSaveAs:save_flags:pause:.

◆ FSPDFDocUserPermissions

Enumeration for user access permissions in a PDF document.

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

Enumerator
FSPDFDocPermPrint 

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

If user wants to print a higher quality level of PDF document, please set current value with value FSPDFDocPermPrintHigh together.

FSPDFDocPermModify 

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 FSPDFDocPermAnnotForm, FSPDFDocPermFillForm and FSPDFDocPermAssemble.

FSPDFDocPermExtract 

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 FSPDFDocPermExtractAccess.

FSPDFDocPermAnnotForm 

Operate text annotations and fill in interactive form fields. (Bit 6 in permission value)

If value FSPDFDocPermModify is also set, user can create or modify interactive form fields (including signature fields).

FSPDFDocPermFillForm 

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 FSPDFDocPermAnnotForm is not used.

FSPDFDocPermExtractAccess 

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.

FSPDFDocPermAssemble 

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 FSPDFDocPermModify is set or not.

FSPDFDocPermPrintHigh 

Print PDF document with higher qualities. (Bit 12 in permission value)

If this value is not set (and value FSPDFDocPermPrint is set), printing is limited to a low-level representation of the appearance, possibly of degraded quality.

◆ FSPDFDocWrapperType

Enumeration for wrapper type.

Values of this enumeration should be used alone.

Enumerator
FSPDFDocWrapperNone 

Normal document.

FSPDFDocWrapperFoxit 

Foxit wrapper document.

FSPDFDocWrapperPDFV2 

PDF 2.0 wrapper document.

◆ FSPDFNameTreeType

Enumeration for name tree type.

Values of this enumeration should be used alone.

Enumerator
FSPDFNameTreeDests 

"Dests" name tree.

FSPDFNameTreeJavaScript 

"JavaScript" name tree.

FSPDFNameTreeEmbeddedFiles 

"EmbeddedFiles" name tree.

◆ FSPDFNumberTreeType

Enumeration for number tree type.

Values of this enumeration should be used alone.

Enumerator
FSPDFNumberTreePageLabels 

"PageLabels" number tree.

◆ FSPDFObjectType

Enumeration for PDF object type.

Values of this enumeration should be used alone.

Enumerator
FSPDFObjectInvalidType 

Invalid PDF object type.

FSPDFObjectBoolean 

PDF boolean object.

FSPDFObjectNumber 

PDF number object.

FSPDFObjectString 

PDF string object.

FSPDFObjectName 

PDF name object.

FSPDFObjectArray 

PDF array object.

FSPDFObjectDictionary 

PDF dictionary object.

FSPDFObjectStream 

PDF stream object.

FSPDFObjectNull 

PDF null object.

FSPDFObjectReference 

PDF reference object.

◆ FSPDFPageBoxType

Enumeration for page box type.

Values of this enumeration should be used alone.

Enumerator
FSPDFPageMediaBox 

Media Box for page boundary.

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

FSPDFPageCropBox 

Crop Box for page boundary.

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

FSPDFPageTrimBox 

Trim Box for page boundary.

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

FSPDFPageArtBox 

Art Box for page boundary.

The intended dimensions of a finished page after trimming.

FSPDFPageBleedBox 

Bleed Box for page boundary.

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

◆ FSPDFPageCalcMarginMode

Enumeration for calculating margin mode.

Values of this enumeration should be used alone.

Enumerator
FSPDFPageCalcContentsBox 

Calculate margin according to bounding box of all contents.

FSPDFPageCalcDetection 

Calculate margin by detecting paths or images.

◆ FSPDFPageFlattenOptions

Enumeration for flatten options.

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

Enumerator
FSPDFPageFlattenAll 

Flatten all contents of a PDF page.

FSPDFPageFlattenNoAnnot 

Flatten a PDF page without annotations.

FSPDFPageFlattenNoFormControl 

Flatten a PDF page without form controls.

◆ FSPDFPageParseFlags

Enumeration for parsing flags used for PDF page.

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

Enumerator
FSPDFPageParsePageNormal 

Parsing flag for normal mode, which means to parse all the contents in a PDF page.

FSPDFPageParsePageTextOnly 

Parsing flag for text-only mode.

◆ FSPDFPageSize

Enumeration for page size type.

Values of this enumeration should be used alone.

Enumerator
FSPDFPageSizeLetter 

Page size: letter.

FSPDFPageSizeLegal 

Page size: legal.

FSPDFPageSizeA2 

Page size: A2.

FSPDFPageSizeA3 

Page size: A3.

FSPDFPageSizeA4 

Page size: A4.

FSPDFPageSizeA5 

Page size: A5.

FSPDFPageSizeA6 

Page size: A6.

FSPDFPageSizeB2 

Page size: B2.

FSPDFPageSizeB3 

Page size: B3.

FSPDFPageSizeB4 

Page size: B4.

FSPDFPageSizeB5 

Page size: B5.

FSPDFPageSizeB6 

Page size: B6.

◆ FSPDFStreamFilter

Enumeration for stream filter type.

Values of this enumeration should be used alone. The stream filter indicates how the data in the PDF stream must be decoded before the data is used.

Enumerator
FSPDFStreamUnknown 

Unknown filter type.

FSPDFStreamNoneDecode 

No need to decode the stream data.

FSPDFStreamASCIIHexDecode 

Filter type: ASCIIHexDecode, which means to decode data encoded in an ASCII hexadecimal representation, reproducing the original binary data.

FSPDFStreamASCII85Decode 

Filter type: ASCII85Decode, which means to decode data encoded in an ASCII base-85 representation, reproducing the original binary data.

FSPDFStreamLZWDecode 

Filter type: LZWDecode, which means to decompress data encoded using the LZW (Lempel-Ziv-Welch) adaptive compression method, reproducing the original text or binary data.

FSPDFStreamFlateDecode 

Filter type: FlateDecode, which means to decompress data encoded using the zlib/deflate compression method, reproducing the original text or binary data.

FSPDFStreamRunLengthDecode 

Filter type: RunLengthDecode, which means to decompress 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).

FSPDFStreamCCITTFaxDecode 

Filter type: CCITTFaxDecode, which means to decompress data encoded using the CCITT facsimile standard, reproducing the original data (typically monochrome image data at 1 bit per pixel).

FSPDFStreamJBIG2Decode 

Filter type: JBIG2Decode, which means to decompress data encoded using the JBIG2 standard, reproducing the original monochrome (1 bit per pixel) image data (or an approximation of that data).

FSPDFStreamDCTDecode 

Filter type: DCTDecode, which means to decompress data encoded using a DCT (discrete cosine transform) technique based on the JPEG standard, reproducing image sample data that approximates the original data.

FSPDFStreamJPXDecode 

Filter type: JPXDecode, which means to decompress data encoded using the wavelet-based JPEG2000 standard, reproducing the original image data.

FSPDFStreamCrypt 

Filter type: Crypt, which means to decrypt data encrypted by a security handler, reproducing the original data as it was before encryption.

◆ FSPosition

enum FSPosition

Enumeration for watermark position in a PDF page.

Values of this enumeration should be used alone.

Enumerator
FSPosTopLeft 

Position: top left.

FSPosTopCenter 

Position: top center.

FSPosTopRight 

Position: top right.

FSPosCenterLeft 

Position center left.

FSPosCenter 

Position: center.

FSPosCenterRight 

Position: center right.

FSPosBottomLeft 

Position: bottom left.

FSPosBottomCenter 

Position: bottom center.

FSPosBottomRight 

Position: bottom right.

◆ FSProgressiveState

Enumeration for progress state.

Values of this enumeration should be used alone.

Enumerator
FSProgressiveError 

Progress state: any error occurs.

FSProgressiveToBeContinued 

Progress state: progress needs to be continued.

FSProgressiveFinished 

Progress state: progress is finished.

◆ FSRangeFilter

Enumeration for range filter.

Values of this enumeration should be used alone.

Enumerator
FSRangeAll 

All the indexes within a range will be used.

FSRangeEven 

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

FSRangeOdd 

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

◆ FSReflowPageFlags

Enumeration for parsing flags used for a reflow page.

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

Enumerator
FSReflowPageNormal 

Parsing flag for normal mode, without image.

FSReflowPageWithImage 

Parsing flag for image mode.

FSReflowPageNoTruncate 

Parsing flag to decide whether to allow to truncate the first/last image or line of text within the specified screen size or not.

The height of final parsed reflow page may be larger than the actual screen height. In this case, the content of a reflow page would be shown in more than one screen in application.
Application may use following modes to show such reflow page:

  • Show only part of content of the reflow page in the screen in one time. When user clicks or taps, show the previous or next part of content. This is like to turn to a page in a real book. Here, call this mode as "single screen mode".
  • Show the reflow page continuously – that means user can scroll the screen to see any part of content in this reflow page. Here, call this mode as "scroll screen mode".

If use "single screen mode" to show a reflow page, a truncate problem may occurs: the first line of text or image just shows the bottom half in the top of the screen, or the last line of text of image just shows the top half in the bottom of the screen. This flag can be set to avoid such problem.
If use "scroll screen mode", no need to use this flag.

◆ FSRendererColorMode

Enumeration for rendering color mode.

Values of this enumeration should be used alone.

Enumerator
FSRendererColorModeNormal 

Normal color mode.

FSRendererColorModeMapping 

Map a color value to the color range defined by a background color and a foreground color.

◆ FSRendererContentFlag

Enumeration for rendering content flags.

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

Enumerator
FSRendererRenderPage 

If set, page content will be rendered.

FSRendererRenderAnnot 

If set, annotations will be rendered.

◆ FSRenditionActionOperationType

Enumeration for operation type to perform when the rendition action is triggered.

Values of this enumeration should be used alone.

Enumerator
FSRenditionActionOpTypeNone 

No operation is specified.

FSRenditionActionOpTypeAssociate 

Associate rendition to related screen annotation.

If no rendition is associated with related screen annotation, play rendition (which is specified in rendition action), associating it with the annotation. If a rendition is already associated with related screen annotation, it is stopped, and the new rendition (which is specified in rendition action) is associated with the annotation.

FSRenditionActionOpTypeStop 

Stop any rendition being played in association with related screen annotation and remove the association. If no rendition is being played, there is no effect.

FSRenditionActionOpTypePause 

Pause any rendition being played in association with related screen annotation. If no rendition is being played, there is no effect.

FSRenditionActionOpTypeResume 

Resume any rendition being played in association with related screen annotation. If no rendition is being played or the rendition is not paused, there is no effect.

FSRenditionActionOpTypePlay 

Play rendition (which is specified in rendition action), associating it with related screen annotation. If a rendition is already associated with the annotation, resume that rendition if it is paused; otherwise, do nothing.

◆ FSRenditionFloatingWindowOffscreenEvent

Enumeration for offscreen event type of floating window.

Values of this enumeration should be used alone.
Offscreen event type is used to specifies what should occur if the floating window is positioned totally or partially offscreen (that is, not visible on any physical monitor).

Enumerator
FSRenditionFloatingWindowOffscreenEventNone 

Nothing.

FSRenditionFloatingWindowOffscreenEventMoveResize 

Move or resize.

FSRenditionFloatingWindowOffscreenEventNonViable 

Consider the object non-viable.

◆ FSRenditionFloatingWindowRelatedWindowType

Enumeration for the type of floating window's related window.

Values of this enumeration should be used alone.
Related window type specifies the place to which the floating window should be positioned.

Enumerator
FSRenditionFloatingWindowRelatedWindowDocument 

The document window.

FSRenditionFloatingWindowRelatedWindowApplication 

The application window.

FSRenditionFloatingWindowRelatedWindowFullDesktop 

The full virtual desktop.

FSRenditionFloatingWindowRelatedWindowMonitor 

Depends on monitor specifier.

◆ FSRenditionFloatingWindowResizeType

Enumeration for resize type of floating window.

Values of this enumeration should be used alone.

Enumerator
FSRenditionFloatingWindowResizeTypeNo 

May not be resized.

FSRenditionFloatingWindowResizeTypeAspectRatio 

May be resized only if aspect ratio is preserved.

FSRenditionFloatingWindowResizeTypeAnyway 

May be resized without preserving aspect ratio.

◆ FSRenditionMediaOptionType

Enumeration for media option type.

Values of this enumeration should be used alone.
Please refer to <PDF reference 1.7> P757 Section "9.1.1 Viability" for more details.

Enumerator
FSRenditionMediaOptionMustBeHonored 

Options defined in this type must be honored for rendition object to be considered viable.

FSRenditionMediaOptionBestEffort 

Options defined in this type need only be honored in a "best effort" sense.

◆ FSRenditionMediaPermission

Enumeration for PDF media player permission.

Values of this enumeration should be used alone.
Media permission indicates the circumstances under which it is acceptable to write a temporary file in order to play a media clip.

Enumerator
FSRenditionMediaPermTempNever 

Never allowed.

FSRenditionMediaPermTempExtract 

Allowed only if the document permissions allow content extraction.

FSRenditionMediaPermTempAccess 

Allowed only if the document permissions allow content extraction, including for accessibility purposes.

FSRenditionMediaPermTempAlways 

Always allowed.

◆ FSRenditionMediaPlayerFitStyle

Enumeration for the fit style.

Values of this enumeration should be used alone.
Fit style (manner) specifies how the player should treat a visual media type that does not exactly fit the rectangle in which it plays.

Enumerator
FSRenditionMediaPlayerFitStyleMeet 

The media's width and height are scaled while preserving the aspect ratio so that the media and play rectangles have the greatest possible intersection while still displaying all media content. Same as "meet" value of SMIL's fit attribute.

FSRenditionMediaPlayerFitStyleSlice 

The media's width and height are scaled while preserving the aspect ratio so that the play rectangle is entirely filled, and the amount of media content that does not fit within the play rectangle is minimized. Same as "slice" value of SMIL's fit attribute.

FSRenditionMediaPlayerFitStyleFill 

The media's width and height are scaled independently so that the media and play rectangles are the same; the aspect ratio is not necessarily preserved. Same as "fill" value of SMIL's fit attribute.

FSRenditionMediaPlayerFitStyleScroll 

The media is not scaled. A scrolling user interface is provided if the media rectangle is wider or taller than the play rectangle. Same as "scroll" value of SMIL's fit attribute.

FSRenditionMediaPlayerFitStyleHidden 

The media is not scaled. Only the portions of the media rectangle that intersect the play rectangle are displayed. Same as "hidden" value of SMIL's fit attribute.

FSRenditionMediaPlayerFitStyleDefault 

Use the player's default setting (author has no preference).

◆ FSRenditionMediaPlayerType

Enumeration for PDF media player classified type.

Values of this enumeration should be used alone.

Enumerator
FSRenditionMediaPlayerMustUsed 

One of players in this type must be used in playing the associated media clip.

FSRenditionMediaPlayerAvailable 

Any of players in this type may be used in playing the associated media clip.

FSRenditionMediaPlayerNotUsed 

Players in this type must not be used in playing the associated media clip.

◆ FSRenditionMonitorSpecifier

Enumeration for monitor specifier type.

Values of this enumeration should be used alone.
Monitor specifier is used to specify which monitor in a multi-monitor system a floating or full-screen window should appear on.

Enumerator
FSRenditionMonitorSpecifierLargest 

The monitor that contains the largest section of the document window.

FSRenditionMonitorSpecifierSmallest 

The monitor that contains the smallest section of the document window.

FSRenditionMonitorSpecifierPrimary 

Primary monitor. If no monitor is considered primary, use case 0.

FSRenditionMonitorSpecifierGreatestColorDepth 

Monitor with the greatest color depth.

FSRenditionMonitorSpecifierGreatestArea 

Monitor with the greatest area (in pixels squared)

FSRenditionMonitorSpecifierGreatestHeight 

Monitor with the greatest height (in pixels)

FSRenditionMonitorSpecifierGreatestWidth 

Monitor with the greatest width (in pixels)

◆ FSRenditionWindowType

Enumeration for the type of window that the media should play in.

Values of this enumeration should be used alone.

Enumerator
FSRenditionWindowTypeFloating 

Window type: a floating window.

FSRenditionWindowTypeFullScreen 

Window type: a full-screen window that obscures all other windows.

FSRenditionWindowTypeHidden 

Window type: a hidden window.

FSRenditionWindowTypeAnnotRect 

Window type: the rectangle occupied by the screen annotation which is associated with the rendition object.

◆ FSRotation

enum FSRotation

Enumeration for rotation.

Values of this enumeration should be used alone.

Enumerator
FSRotation0 

No rotation.

FSRotation90 

Rotate 90 degrees in clockwise direction.

FSRotation180 

Rotate 180 degrees in clockwise direction.

FSRotation270 

Rotate 270 degrees in clockwise direction.

FSRotationUnknown 

Unknown rotation.

◆ FSSecurityHandlerCipherType

Enumeration for Encryption Algorithm.

Values of this enumeration should be used alone.

Enumerator
FSSecurityHandlerCipherNone 

Not use encryption algorithm.

FSSecurityHandlerCipherRC4 

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

FSSecurityHandlerCipherAES 

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).

◆ FSSignatureAPFlags

Enumeration for signature appearance flags.

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

Enumerator
FSSignatureAPFlagFoxitFlag 

If set, show Foxit flag on signature appearance.

FSSignatureAPFlagLabel 

If set, show label on signature appearance.

FSSignatureAPFlagReason 

If set, show reason on signature appearance.

FSSignatureAPFlagSigningTime 

If set, show signing time on signature appearance.

FSSignatureAPFlagDN 

If set, show distinguish name on signature appearance.

FSSignatureAPFlagLocation 

If set, show location on signature appearance.

FSSignatureAPFlagSigner 

If set, show signer on signature appearance.

FSSignatureAPFlagBitmap 

If set, show bitmap on signature appearance.

FSSignatureAPFlagText 

If set, show text content on signature appearance.

◆ FSSignatureDigestAlgorithm

Enumeration for signature digest algorithm.

Values of this enumeration should be used alone.

Enumerator
FSSignatureDigestSHA1 

Signature digest algorithm: sha1 algorithm.

FSSignatureDigestSHA256 

Signature digest algorithm: sha256 algorithm.

FSSignatureDigestSHA384 

Signature digest algorithm: sha384 algorithm.

FSSignatureDigestSHA512 

Signature digest algorithm: sha512 algorithm.

◆ FSSignatureKeyName

Enumeration for signature key name.

Values of this enumeration should be used alone.

Enumerator
FSSignatureKeyNameSigner 

Signature key name: signer.

FSSignatureKeyNameLocation 

Signature key name: location.

FSSignatureKeyNameReason 

Signature key name: reason.

FSSignatureKeyNameContactInfo 

Signature key name: contact information.

FSSignatureKeyNameDN 

Signature key name: distinguish name.

FSSignatureKeyNameText 

Signature key name: text content.

◆ FSSignatureStates

Enumeration for signature states.

Values of this enumeration can be used alone or in combination.
These values can be divided into four parts:


Enumerator
FSSignatureStateUnknown 

Unknown signature.

FSSignatureStateNoSignData 

Signature does not have any data for signing.

FSSignatureStateUnsigned 

Unsigned signature.

FSSignatureStateSigned 

Signed signature.

FSSignatureStateVerifyValid 

Verification state of a signature is valid.

FSSignatureStateVerifyInvalid 

Verification state of a signature is invalid.

FSSignatureStateVerifyErrorData 

Signature data is destroyed (that means the signature data cannot be parsed properly).

FSSignatureStateVerifyNoSupportWay 

Unsupported signature.

FSSignatureStateVerifyErrorByteRange 

Non expected byte range.

FSSignatureStateVerifyChange 

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

FSSignatureStateVerifyIncredible 

Signature cannot be trusted (containing aggression).

FSSignatureStateVerifyNoChange 

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

FSSignatureStateVerifyIssueValid 

Verification state of the issuer is valid.

FSSignatureStateVerifyIssueUnknown 

Verification state of the issuer is unknown.

FSSignatureStateVerifyIssueRevoke 

Certificate for verifying issuer is revoked.

FSSignatureStateVerifyIssueExpire 

Certificate for verifying issuer is expired.

FSSignatureStateVerifyIssueUncheck 

Not check the issuer.

FSSignatureStateVerifyIssueCurrent 

The verified issue is current issuer.

FSSignatureStateVerifyTimestampNone 

No timestamp or not check timestamp.

FSSignatureStateVerifyTimestampDoc 

The signature is a timestamp signature.

FSSignatureStateVerifyTimestampValid 

Verification state of the timestamp is valid.

FSSignatureStateVerifyTimestampInvalid 

Verification state of the timestamp is invalid.

FSSignatureStateVerifyTimestampExpire 

Verification state of the timestamp is expired.

FSSignatureStateVerifyTimestampIssueUnknown 

Verification state of the timestamp issuer is unknown.

FSSignatureStateVerifyTimestampIssueValid 

Verification state of the timestamp issuer is valid.

FSSignatureStateVerifyTimestampTimeBefore 

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

◆ FSSubmitFormActionFlags

Enumeration for flags of submit form action.

Values of this enumeration could be used alone or in a combination.

Enumerator
FSSubmitFormActionFlagExclude 

Bit 1. If set, fields name defined in submit form action should be excluded from submitting; if not set, only these fields name (including their descendants) are to be submit.

FSSubmitFormActionFlagIncludeNoValueFields 

Bit 2. Submit fields regardless of whether they have a value.

Note
For fields without a value, only the field name is transmitted.
FSSubmitFormActionFlagExportFormat 

Bit 3. Field names and values are submitted in HTML Form format.

Note
Meaningful only if flags FSSubmitFormActionFlagAsXFDF and FSSubmitFormActionFlagSubmitAsPDF are clear.
If this flag is clear, that means to submit in Forms Data Format (FDF).
FSSubmitFormActionFlagGetMethod 

Bit 4. Field names and values are submitted using an HTTP GET request.

Note
Meaningful only when flag FSSubmitFormActionFlagExportFormat is set. If this flag is clear, that means to submit using a POST request.
FSSubmitFormActionFlagWithCoordinates 

Bit 5. Coordinates of the mouse are transmitted as part of the form data.

FSSubmitFormActionFlagAsXFDF 

Bit 6. Field names and values are submitted as XFDF.

FSSubmitFormActionFlagIncludeAppendSaves 

Bit 7. Submitted FDF file includes contents as contained in differences entry in the FDF dictionary.

Note
Meaningful only when the form is being submitted in Forms Data Format.
FSSubmitFormActionFlagIncludeAnnotations 

Bit 8. Submitted FDF file includes all markup annotations in underlying PDF document.

Note
Meaningful only when the form is being submitted in Forms Data Format.
FSSubmitFormActionFlagSubmitAsPDF 

Bit 9. The document is submitted as PDF.

FSSubmitFormActionFlagCanonicalFormat 

Bit 10. Any submitted field values representing dates are converted to the standard format.

FSSubmitFormActionFlagExclNonUserAnnots 

Bit 11. Only those markup annotations whose "T" entry matches the name of the current user are being submitted.

FSSubmitFormActionFlagExclFKey 

Bit 12. Submitted FDF excludes "F" entry.

FSSubmitFormActionFlagEmbedForm 

Bit 14. "F" entry of submitted FDF is an embedded file stream.

◆ FSTabOrderMgrOrderType

Enumeration for tab order type.

Values of this enumeration should be used alone.

Enumerator
FSTabOrderMgrNone 

None (index order): Annotations are visited in annotation's index across the page.

FSTabOrderMgrRow 

R (row order): Annotations are visited in rows running horizontally across the page.

FSTabOrderMgrColumn 

C (column order): Annotations are visited in columns running vertically up and down the page.

FSTabOrderMgrStructure 

S (structure order): Annotations are visited in the order in which they appear in the structure tree.

◆ FSTextPageTextParseFlags

Enumeration for parsing flags used for text page.

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

Enumerator
FSTextPageParseTextNormal 

No special parsing options for text page.

FSTextPageParseTextOutputHyphen 

Parse the text content of a PDF page with outputting the hyphen on a line feed.

FSTextPageParseTextUseStreamOrder 

Parse the text content of a PDF page by the stream order.

◆ FSTextSearchSearchFlags

Enumeration for searching flags.

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

Enumerator
FSTextSearchSearchNormal 

No special searching options.

FSTextSearchSearchMatchCase 

If set, match the case of keyword when searching.

FSTextSearchSearchMatchWholeWord 

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

FSTextSearchSearchConsecutive 

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

◆ FSTextStateMode

Enumeration for text mode.

Values of this enumeration should be used alone.

Enumerator
FSTextStateModeFill 

Text mode: fill text.

FSTextStateModeStroke 

Text mode: stroke text.

FSTextStateModeFillStroke 

Text mode: fill and stroke text.

FSTextStateModeInvisible 

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

FSTextStateModeFillClip 

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

FSTextStateModeStrokeClip 

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

FSTextStateModeFillStrokeClip 

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

FSTextStateModeClip 

Text mode: add text to path for clipping.

◆ FSWatermarkSettingsFlags

Enumeration for watermark setting flags.

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

Enumerator
FSWatermarkSettingsFlagASPageContents 

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

FSWatermarkSettingsFlagASAnnot 

If set, the watermark will be an annotation when inserted to a PDF page.

FSWatermarkSettingsFlagOnTop 

If set, show watermark above other page content.

FSWatermarkSettingsFlagNoPrint 

If set, do not print a watermark.

FSWatermarkSettingsFlagInvisible 

If set, do not display a watermark.

◆ FSWatermarkTextPropertiesFontStyle

Enumeration for watermark font style.

Values of this enumeration should be used alone.

Enumerator
FSWatermarkTextPropertiesFontStyleNormal 

Watermark font style: normal.

FSWatermarkTextPropertiesFontStyleUnderline 

Watermark font style: with underline.

◆ FSXFADocEventType

Enumeration for XFA event type.

Values of this enumeration should be used alone.

Enumerator
FSXFADocEventTypeUnknown 

Event type: Unknown.

FSXFADocEventTypePostPrint 

This kind of event is triggered just after the rendered form has been sent to the printer, spooler, or output destination.

FSXFADocEventTypePrePrint 

This kind of event is triggered just before the rendering for printing begins.

◆ FSXFADocExportDataType

Enumeration for the type of exported data.

Values of this enumeration should be used alone.

Enumerator
FSXFADocExportDataTypeXML 

Type of exported data: XML.

FSXFADocExportDataTypeStaticXDP 

Type of exported data: Static XDP.

FSXFADocExportDataTypeXDP 

Type of exported data: XDP.

◆ FSXFADocType

Enumeration for XFA document type.

Values of this enumeration should be used alone.

Enumerator
FSXFADocDynamic 

XFA document type: Dynamic.

FSXFADocStatic 

XFA document type: Static.

FSXFADocXDP 

XFA document type: XDP, as Raw XML data.

◆ FSXFAWidgetHitTestArea

Enumeration for hit test area of XFA widget.

Values of this enumeration should be used alone.

Enumerator
FSXFAWidgetHitTestAreaUnknown 

Hit test area: Unknown.

FSXFAWidgetHitTestAreaClient 

Hit test area: Client.

FSXFAWidgetHitTestAreaTitleBar 

Hit test area: Title Bar.

FSXFAWidgetHitTestAreaHyperLink 

Hit test area: HyperLink.

◆ FSXFAWidgetPresenceProperty

Enumeration for presence attribute of XFA widget.

Values of this enumeration should be used alone.
The presence property controls the participation of the associated object in different phases of processing.

Enumerator
FSXFAWidgetPresenceUnknown 

Presence property: Unknown.

FSXFAWidgetPresenceVisible 

Presence property: Visible. Participate in interaction, layout, and rendering.

FSXFAWidgetPresenceHidden 

Presence property: Hidden. Participate in interaction but not layout or rendering.

FSXFAWidgetPresenceInactive 

Presence property: Inactive. Do not participate in interaction, layout, or rendering.

FSXFAWidgetPresenceInvisible 

Presence property: Invisible. Participate in interaction and layout but not rendering.

◆ FSXFAWidgetWidgetNameType

Enumeration for the type of XFA widget name.

Values of this enumeration should be used alone.

Enumerator
FSXFAWidgetWidgetNameTypeField 

Name type: field name. Name in this type will be retrieved from XFA widget's name entry and this may an empty string.

FSXFAWidgetWidgetNameTypeCaption 

Name type: caption name. Name in this type will be retrieved from caption entry.

◆ FSXFAWidgetWidgetType

Enumeration for the type of XFA widget.

Values of this enumeration should be used alone.

Enumerator
FSXFAWidgetWidgetTypeBarcode 

XFA widget type: barcode.

FSXFAWidgetWidgetTypePushButton 

XFA widget type: push button.

FSXFAWidgetWidgetTypeCheckButton 

XFA widget type: check button.

FSXFAWidgetWidgetTypeArc 

XFA widget type: arc.

FSXFAWidgetWidgetTypeDateTimeEdit 

XFA widget type: date time edit.

FSXFAWidgetWidgetTypeNumericEdit 

XFA widget type: numeric edit.

FSXFAWidgetWidgetTypeSignature 

XFA widget type: signature.

FSXFAWidgetWidgetTypeChoiceList 

XFA widget type: choice list.

FSXFAWidgetWidgetTypeImageEdit 

XFA widget type: image edit.

FSXFAWidgetWidgetTypeLine 

XFA widget type: line.

FSXFAWidgetWidgetTypePasswordEdit 

XFA widget type: password edit.

FSXFAWidgetWidgetTypeRadioButton 

XFA widget type: radio button.

FSXFAWidgetWidgetTypeRectangle 

XFA widget type: rectangle.

FSXFAWidgetWidgetTypeTextEdit 

XFA widget type: text edit.

FSXFAWidgetWidgetTypeUnknown 

XFA widget type: unknown.

FSXFAWidgetWidgetTypeExclGroup 

XFA widget type: Exclusion Group for radio button only.