Foxit PDF SDK  9.1
Enumerations

Enumerations

enum  FS_PAGESPACING_DIRECTION { FS_PAGESPACING_HORIZONTAL = 0x0001, FS_PAGESPACING_VERTICAL = 0x0002 }
 Enumeration for page spacing direction. 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  FSAnnotationSummarySettingsFontSizeType { FSAnnotationSummarySettingsFontSizeSmall = 0, FSAnnotationSummarySettingsFontSizeMedium = 1, FSAnnotationSummarySettingsFontSizeLarge = 2 }
 Enumeration for options used for font size type in result document.
More...
 
enum  FSAnnotationSummarySettingsSortType { FSAnnotationSummarySettingsTypeSortByAuthor = 0, FSAnnotationSummarySettingsTypeSortByDate = 1, FSAnnotationSummarySettingsTypeSortByPage = 2, FSAnnotationSummarySettingsTypeSortByAnnotationType = 3 }
 Enumeration for options used for sorting annotation in result document.
More...
 
enum  FSAnnotationSummarySettingsSummaryLayout {
  FSAnnotationSummarySettingsSummaryLayoutSeparatePagesWithLine = 0, FSAnnotationSummarySettingsSummaryLayoutSinglePageWithLine = 1, FSAnnotationSummarySettingsSummaryLayoutAnnotationOnly = 2, FSAnnotationSummarySettingsSummaryLayoutSeparatePagesWithSequenceNumber = 3,
  FSAnnotationSummarySettingsSummaryLayoutSinglePageWithSequenceNumber = 4
}
 Enumeration for options used for annotation summary layout.
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,
  FSAnnotRichMedia = 28, FSAnnotPagingSeal = 29
}
 Enumeration for PDF annotation type.
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, FSBitmapDIB1bpp = 0x001, FSBitmapDIBRgb = 0x018, FSBitmapDIBRgb32 = 0x020,
  FSBitmapDIBArgb = 0x220, FSBitmapDIBCmyk = 0x420, FSBitmapDIB8bppMask = 0x108, FSBitmapDIB8bpp = 0x008,
  FSBitmapDIB8bppGray = 0x1008, FSBitmapDIBAbgr = 0x222, FSBitmapDIBRgb565 = 0x565
}
 Enumeration for DIB format.
More...
 
enum  FSBitmapFadeOutEnhancementAlgorithm { FSBitmapEnhanceAlgoGrayLevelTransformation = 0 }
 Enumeration for bitmap enhancement algorithm for fading out.
More...
 
enum  FSBitmapFadeOutThresholdAlogrithm { FSBitmapThresholdAlgoFixedThreshold = 0, FSBitmapThresholdAlgoOTSU = 1 }
 Enumeration for bitmap threshold algorithm for fading out.
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  FSCertVerifyResultCertStatus { FSCertVerifyResultCertStatusValid = 0, FSCertVerifyResultCertStatusRevoked = 1, FSCertVerifyResultCertStatusExpired = 2, FSCertVerifyResultCertStatusUnknown = 3 }
 Enumeration for certificate status.
More...
 
enum  FSCertVerifyResultResponseInfoLocation { FSCertVerifyResultLocationNotSet = 0, FSCertVerifyResultLocationDSS = 1, FSCertVerifyResultLocationSignature = 2, FSCertVerifyResultLocationOnline = 3 }
 Enumeration for response information location.
More...
 
enum  FSCertVerifyResultRevocationReason {
  FSCertVerifyResultReasonNoStatus = -1, FSCertVerifyResultReasonUnspecified = 0, FSCertVerifyResultReasonKeyCompromise = 1, FSCertVerifyResultReasonCACompromise = 2,
  FSCertVerifyResultReasonAffiliationChanged = 3, FSCertVerifyResultReasonSuperseded = 4, FSCertVerifyResultReasonCessationOfOperation = 5, FSCertVerifyResultReasonCertificateHold = 6,
  FSCertVerifyResultReasonRemoveFromCRL = 7, FSCertVerifyResultReasonPrivilegeWithDrawn = 8, FSCertVerifyResultReasonAACompromise = 9
}
 Enumeration for revocation reason for a certificate.
More...
 
enum  FSColorSpaceRenderingIntent { FSColorSpaceRenderIntentPerceptual = 0, FSColorSpaceRenderIntentRelColorimetric = 1, FSColorSpaceRenderIntentSaturation = 2, FSColorSpaceRenderIntentAbsColorimetric = 3 }
 Enumeration for rendering intent.
More...
 
enum  FSColorSpaceType {
  FSColorSpaceInvalid = 0, FSColorSpaceDeviceGray = 1, FSColorSpaceDeviceRGB = 2, FSColorSpaceDeviceCMYK = 3,
  FSColorSpaceCalGray = 4, FSColorSpaceCalRGB = 5, FSColorSpaceLab = 6, FSColorSpaceICCBased = 7,
  FSColorSpaceSeparation = 8, FSColorSpaceDeviceN = 9, FSColorSpaceIndexed = 10, FSColorSpacePattern = 11,
  FSColorSpaceICCBasedDeviceGray = 12, FSColorSpaceICCBasedDeviceRGB = 13, FSColorSpaceICCBasedDeviceCMYK = 14
}
 Enumeration for color space.
More...
 
enum  FSCompareResultInfoCompareResultType {
  FSCompareResultInfoCompareResultTypeNone = -1, FSCompareResultInfoCompareResultTypeDeleteText = 0, FSCompareResultInfoCompareResultTypeInsertText = 1, FSCompareResultInfoCompareResultTypeReplaceText = 2,
  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 { FSComparisonCompareTypeAll = 0x00000000, FSComparisonCompareTypeText = 0x00000001, FSComparisonCompareTypeAnnotation = 0x00000002 }
 Enumeration for compare type flags.
More...
 
enum  FSDataSortComparison { FSDataSortOrderedAscending, FSDataSortOrderedDescending }
 Constants that indicate sort order. 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  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  FSDWG2PDFSettingDataDWG2PDFColorPolicy { FSDWG2PDFSettingDataDWG2PDFColorPolicyNoPolicy = 0, FSDWG2PDFSettingDataDWG2PDFColorPolicyMono = 1, FSDWG2PDFSettingDataDWG2PDFColorPolicyGrayscale = 2 }
 Enumeration for color policy used for converting DWG to PDF.
More...
 
enum  FSDWG2PDFSettingDataDWG2PDFExportFlags {
  FSDWG2PDFSettingDataFlagEmbededTTF = 0x0001, FSDWG2PDFSettingDataFlagTTFTextAsGeometry = 0x0002, FSDWG2PDFSettingDataFlagSHXTextAsGeometry = 0x0004, FSDWG2PDFSettingDataFlagSimpleGeomOptimization = 0x0008,
  FSDWG2PDFSettingDataFlagEnableLayers = 0x0010, FSDWG2PDFSettingDataFlagIncludeOffLayers = 0x0020, FSDWG2PDFSettingDataFlagEmbededOptimizedTTF = 0x0040, FSDWG2PDFSettingDataFlagUseHLR = 0x0080,
  FSDWG2PDFSettingDataFlagFlateCompression = 0x0100, FSDWG2PDFSettingDataFlagASCIIHexEncoding = 0x0200, FSDWG2PDFSettingDataFlagExportHyperlinks = 0x0400, FSDWG2PDFSettingDataFlagZoomToExtentsMode = 0x0800,
  FSDWG2PDFSettingDataFlagLinearized = 0x1000, FSDWG2PDFSettingDataFlagMeasuring = 0x4000
}
 Enumeration for flags of DWG to PDF export.
More...
 
enum  FSDWG2PDFSettingDataDWG2PDFExportHatchesType { FSDWG2PDFSettingDataDWG2PDFExportHatchesTypeBitmap = 0, FSDWG2PDFSettingDataDWG2PDFExportHatchesTypeDrawing = 1, FSDWG2PDFSettingDataDWG2PDFExportHatchesTypePdfPaths = 2, FSDWG2PDFSettingDataDWG2PDFExportHatchesTypePolygons = 3 }
 Enumeration for hatches export type used for converting DWG to PDF.
More...
 
enum  FSDWG2PDFSettingDataDWG2PDFSearchableTextType { FSDWG2PDFSettingDataDWG2PDFSearchableTextTypeNoSearch = 0, FSDWG2PDFSettingDataDWG2PDFSearchableTextTypeSHX = 1, FSDWG2PDFSettingDataDWG2PDFSearchableTextTypeTTF = 2 }
 Enumeration for searchable text type used for converting DWG to PDF.
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, FSErrTimeStampServerMgrNotInit = 47,
  FSErrLTVVerifyModeNotSet = 48, FSErrLTVRevocationCallbackNotSet = 49, FSErrLTVCannotSwitchVersion = 50, FSErrLTVCannotCheckDTS = 51,
  FSErrLTVCannotLoadDSS = 52, FSErrLTVCannotLoadDTS = 53, FSErrNeedSigned = 54, FSErrComplianceResourceFile = 55,
  FSErrTimeStampServerMgrNoDefaltServer = 56, FSErrDefaultTimeStampServer = 57, FSErrNoConnectedPDFModuleRight = 58, FSErrNoXFAModuleRight = 59,
  FSErrNoRedactionModuleRight = 60, FSErrNoRMSModuleRight = 61, FSErrNoOCRModuleRight = 62, FSErrNoComparisonModuleRight = 63,
  FSErrNoComplianceModuleRight = 64, FSErrNoOptimizerModuleRight = 65, FSErrNoConversionModuleRight = 66, FSErrOfficeComNotInit = 67,
  FSErrNoMicroOfficeInstalled = 68, FSErrExcelHasNoContent = 69, FSErrNoLayoutRecognitionModuleRight = 70, FSErrWPSEngineNotFound = 71,
  FSErrLibreofficeEngineNotFound = 72, FSErrNoAccessibilityModuleRight = 73, FSErrODAEngineNotFound = 74, FSErrNoTableMakerModuleRight = 75,
  FSErrNoDWG2PDFModuleRight = 76, FSErrNoAdvEditModuleRight = 77, FSErrNoPDF2OfficeModuleRight = 78, FSErrURLInBlackList = 79,
  FSErrOFDEngineNotInit = 80, FSErrNoOFDModuleRight = 81, FSErrNo3DModuleRight = 82, FSErrInvalidRegex = 83,
  FSErrNoDocumentPermission = 84, FSErrNoOffice2PDFModuleRight = 85, FSErrMIPUPEEngineInitFailed = 86, FSErrMIPProtectionEngineInitFailed = 87,
  FSErrMIPCreateProtectionHandlerFailed = 88, FSErrMIPGetExtendedLabelInfoByIdFailed = 89, FSErrNoPrint2PDFModuleRight = 90
}
 Intent: converted result file will be used for printing.
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, FSFieldFlagTextFileSelect = 0x400,
  FSFieldFlagTextNoSpellCheck = 0x800, FSFieldFlagTextDoNotScroll = 0x1000, FSFieldFlagTextComb = 0x2000, FSFieldFlagComboEdit = 0x100,
  FSFieldFlagChoiceMultiSelect = 0x100, FSFieldFlagTextRichText = 0x4000, FSFieldFlagChoiceSort = 0x200, FSFieldFlagChoiceCommitOnSelChange = 0x400
}
 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  FSFileFormatType {
  FSFileFormatTypeFDF = 0, FSFileFormatTypeXFDF = 1, FSFileFormatTypeHTML = 2, FSFileFormatTypeXDP = 3,
  FSFileFormatTypeXML = 4, FSFileFormatTypeXFD = 5, FSFileFormatTypePDF = 6, FSFileFormatTypeTXT = 7
}
 Enumeration for file format 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  FSFillSignFillSignObjectType {
  FSFillSignFillSignObjectTypeText = 0, FSFillSignFillSignObjectTypeCrossMark = 1, FSFillSignFillSignObjectTypeCheckMark = 2, FSFillSignFillSignObjectTypeRoundRectangle = 3,
  FSFillSignFillSignObjectTypeLine = 4, FSFillSignFillSignObjectTypeDot = 5, FSFillSignFillSignObjectTypeSignature = 6, FSFillSignFillSignObjectTypeInitialsSignature = 7
}
 Enumeration for fill-sign object type.
More...
 
enum  FSFloatingInfoOffScreenAction { FSFloatingInfoOffScreenAllow = 0, FSFloatingInfoOffScreenForceOnScreen = 1, FSFloatingInfoOffScreenCancel = 2 }
 Enumeration for the action can be taken if the floating window is positioned totally or partially offscreen.
More...
 
enum  FSFloatingInfoRelativeTarget { FSFloatingInfoRelativeTargetPageWindow = 0, FSFloatingInfoRelativeTargetAppWindow = 1, FSFloatingInfoRelativeTargetDesktop = 2, FSFloatingInfoRelativeTargetMonitor = 3 }
 Enumeration for the values used to set relative position of floating window.
More...
 
enum  FSFloatingInfoResizeType { FSFloatingInfoResizeTypeNo = 0, FSFloatingInfoResizeTypeKeepRatio = 1, FSFloatingInfoResizeTypeYes = 2 }
 Enumeration for the resize type, which specifies whether a floating window may be resized by the user.
More...
 
enum  FSFloatingInfoWindowPosition {
  FSFloatingInfoWindowPositionTopLeft = 0, FSFloatingInfoWindowPositionTopCenter = 1, FSFloatingInfoWindowPositionTopRight = 2, FSFloatingInfoWindowPositionCenterLeft = 3,
  FSFloatingInfoWindowPositionCenter = 4, FSFloatingInfoWindowPositionCenterRight = 5, FSFloatingInfoWindowPositionBottomLeft = 6, FSFloatingInfoWindowPositionBottomCenter = 7,
  FSFloatingInfoWindowPositionBottomRight = 8
}
 Enumeration for the window position used for media player.
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  FSFontCIDCharset {
  FSFontCIDCharsetUnknown = 0, FSFontCIDCharsetGB1 = 1, FSFontCIDCharsetCNS1 = 2, FSFontCIDCharsetJAPAN1 = 3,
  FSFontCIDCharsetKOREA1 = 4, FSFontCIDCharsetUNICODE = 5
}
 Enumeration for CID font charset.
More...
 
enum  FSFontFontTypes { FSFontFontTypeType1 = 1, FSFontFontTypeTrueType = 2, FSFontFontTypeType3 = 3, FSFontFontTypeCIDFont = 4 }
 Enumeration for font type.
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  FSFunction {
  FSFunctionMultiMediaEdit, FSFunctionDocInfoEdit, FSFunctionEdit, FSFunctionReduce,
  FSFunctionPDFDigitalSignAdd, FSFunctionRMS, FSFunctionDigitalSignField, FSFunctionRedaction,
  FSFunctionCanSaveToLocal, FSFunctionStandEncrypt, FSFunctionFlatten, FSFunctionPDFSign,
  FSFunctionPDFBookMark, FSFunctionSmallBottomBarToolItem, FSFunctionImageAnnoteItem, FSFunctionAttachmentsPanelAddItem,
  FSFunctionAttachmentsPanelEditItem, FSFunctionPDFEsign, FSFunctionDocumentAttachmentCanEdit, FSFunctionInkRecognize,
  FSFunction3DView
}
 
enum  FSGestureLockOptions {
  FSGestureLockOptionNone = 0, FSGestureLockOptionSingleTap = 1 << 0, FSGestureLockOptionDoubleTap = 1 << 1, FSGestureLockOptionLongPress = 1 << 3,
  FSGestureLockOptionPinch = 1 << 4, FSGestureLockOptionPan = 1 << 5, FSGestureLockOptionAll = FSGestureLockOptionSingleTap | FSGestureLockOptionDoubleTap | FSGestureLockOptionLongPress | FSGestureLockOptionPinch | FSGestureLockOptionPan
}
 
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  FSGraphicsObjectsTextMergeOption { FSGraphicsObjectsTextMergeNone = 0, FSGraphicsObjectsTextMergeTJY = 1, FSGraphicsObjectsTextMergeBTET = 2 }
 Enumeration for text merge.
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  FSHeaderFooterContentGeneratorDateFormatType {
  FSHeaderFooterContentGeneratorDateFormatMSlashD = 0, FSHeaderFooterContentGeneratorDateFormatMSlashDSlashYY = 1, FSHeaderFooterContentGeneratorDateFormatMSlashDSlashYYYY = 2, FSHeaderFooterContentGeneratorDateFormatMMSlashDDSlashYY = 3,
  FSHeaderFooterContentGeneratorDateFormatMMSlashDDSlashYYYY = 4, FSHeaderFooterContentGeneratorDateFormatDSlashMSlashYY = 5, FSHeaderFooterContentGeneratorDateFormatDSlashMSlashYYYY = 6, FSHeaderFooterContentGeneratorDateFormatDDSlashMMSlashYY = 7,
  FSHeaderFooterContentGeneratorDateFormatDDSlashMMSlashYYYY = 8, FSHeaderFooterContentGeneratorDateFormatMMSlashYY = 9, FSHeaderFooterContentGeneratorDateFormatMMSlashYYYY = 10, FSHeaderFooterContentGeneratorDateFormatMDotDDotYY = 11,
  FSHeaderFooterContentGeneratorDateFormatMDotDDotYYYY = 12, FSHeaderFooterContentGeneratorDateFormatMMDotDDDotYY = 13, FSHeaderFooterContentGeneratorDateFormatMMDotDDDotYYYY = 14, FSHeaderFooterContentGeneratorDateFormatMMDotYY = 15,
  FSHeaderFooterContentGeneratorDateFormatDDotMDotYYYY = 16, FSHeaderFooterContentGeneratorDateFormatDDDotMMDotYY = 17, FSHeaderFooterContentGeneratorDateFormatDDDotMMDotYYYY = 18, FSHeaderFooterContentGeneratorDateFormatYYHyphenMMHyphenDD = 19,
  FSHeaderFooterContentGeneratorDateFormatYYYYHyphenMMHyphenDD = 20
}
 Enumeration for date format type.
More...
 
enum  FSHeaderFooterContentGeneratorPageNumberFormat {
  FSHeaderFooterContentGeneratorPageNumberFormatDefault = 0, FSHeaderFooterContentGeneratorPageNumberFormatNumberOfCount = 1, FSHeaderFooterContentGeneratorPageNumberFormatNumberSlashCount = 2, FSHeaderFooterContentGeneratorPageNumberFormatPageNumber = 3,
  FSHeaderFooterContentGeneratorPageNumberFormatPageNumberOfCount = 4
}
 Enumeration for page number format type.
More...
 
enum  FSHistoryDataSortKey { FSHistoryDataSortKeyDefault, FSHistoryDataSortKeyDate, FSHistoryDataSortKeyChar }
 History data sort by key. More...
 
enum  FSHistoryDataSortRule { FSHistoryDataMatchNormal = 0x00, FSHistoryDataMatchCase = 0x01, FSHistoryDataMatcConsecutive = 0x02 }
 History data match rules. More...
 
enum  FSIconFitScaleWayType {
  FSIconFitScaleWayNone = 0, FSIconFitScaleWayAlways = 1, FSIconFitScaleWayBigger = 2, FSIconFitScaleWaySmaller = 3,
  FSIconFitScaleWayNever = 4
}
 Enumeration for the type of icon scaling way.
More...
 
enum  FSImageOrientation {
  FSImageOrientationNone = 0, FSImageOrientationNormal = 1, FSImageOrientationFlipH = 2, FSImageOrientationRotate180 = 3,
  FSImageOrientationFlipV = 4, FSImageOrientationRotate90FlipH = 5, FSImageOrientationRotate90 = 6, FSImageOrientationRotate270FlipH = 7,
  FSImageOrientationRotate270 = 8
}
 Enumeration for image orientation.
More...
 
enum  FSImageSettingsImageCompressMode { FSImageSettingsImageCompressHigh = 10003, FSImageSettingsImageCompressjpeg = 10005, FSImageSettingsImageCompressjpeg2000 = 10006, FSImageSettingsImageCompressRetain = 10007 }
 Enumeration for compression mode used for color or gray image.
More...
 
enum  FSImageSettingsImageCompressQuality {
  FSImageSettingsImageCompressQualityMinimum = 1, FSImageSettingsImageCompressQualityLow = 2, FSImageSettingsImageCompressQualityMedium = 3, FSImageSettingsImageCompressQualityHigh = 4,
  FSImageSettingsImageCompressQualityMaximum = 5
}
 Enumeration for loss compression quality used for color or gray image.
More...
 
enum  FSImageSettingsStretchMode {
  FSImageSettingsStretchDefault = -1, FSImageSettingsStretchOff = 0x00, FSImageSettingsStretchInterpol = 0x20, FSImageSettingsStretchDownsample = 0x04,
  FSImageSettingsStretchBicubic = 0x80, FSImageSettingsStretchNoSmooth = 0x100
}
 Enumeration for stretch mode.
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  FSInteractiveScene { FSInteractiveSceneUndefine, FSInteractiveSceneFillingForms }
 Interactive scene. More...
 
enum  FSItemContentType { FSItemContentTypeCustom, FSItemContentTypeImage = 1 << 0, FSItemContentTypeText = 1 << 1, FSItemContentTypeImageAndText = (FSItemContentTypeImage | FSItemContentTypeText) }
 The FSMainToolbarItem content 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  FSLocaleID {
  FSLocaleIDUnspecified = 0, FSLocaleIDHongKong = 1, FSLocaleIDTaiwan = 2, FSLocaleIDNetherlands = 3,
  FSLocaleIDFrance = 4, FSLocaleIDGermany = 5, FSLocaleIDItaly = 6, FSLocaleIDKorea = 7,
  FSLocaleIDJapan = 8
}
 Enumeration for locale ID.
More...
 
enum  FSLTVVerifierTimeType { FSLTVVerifierSignatureCreationTime = 0, FSLTVVerifierSignatureTSTTime = 1, FSLTVVerifierCurrentTime = 2, FSLTVVerifierVRICreationTime = 3 }
 Enumeration for time type.
More...
 
enum  FSLTVVerifierVerifyMode { FSLTVVerifierVerifyModeAcrobat = 1 }
 Enumeration for verifying mode.
More...
 
enum  FSMainToolbarItemPosition { FSMainToolbarItemPositionLeft = 0, FSMainToolbarItemPositionCenter, FSMainToolbarItemPositionRight }
 The item is in the bar. More...
 
enum  FSMainToolbarItemType {
  FSMainToolbarItemTypeUnknown = 0, FSMainToolbarItemTypeBack, FSMainToolbarItemTypeMore, FSMainToolbarItemTypeSearch,
  FSMainToolbarItemTypePan, FSMainToolbarItemTypeAddTool, FSMainToolbarItemTypeRedo, FSMainToolbarItemTypeUndo,
  FSMainToolbarItemTypeProperty, FSMainToolbarItemTypeMultiSelect, FSMainToolbarItemTypeDivide, FSMainToolbarItemTypePanel,
  FSMainToolbarItemTypeViewSettings, FSMainToolbarItemTypeThumbnail, FSMainToolbarItemTypeReadingBookmark, FSMainToolbarItemTypeSortTool
}
 Defines existing-supplied images for main tool bar items.. More...
 
enum  FSMainTopbarToolTag {
  FSMainTopbarToolTagHome, FSMainTopbarToolTagEdit, FSMainTopbarToolTagComment, FSMainTopbarToolTagDrawing,
  FSMainTopbarToolTagView, FSMainTopbarToolTagForm, FSMainTopbarToolTagSign, FSMainTopbarToolTagProtect,
  FSMainTopbarToolTagCustom
}
 The tool tag. 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  FSMarkupMeasureType {
  FSMarkupMeasureTypeX = 0, FSMarkupMeasureTypeY = 1, FSMarkupMeasureTypeD = 2, FSMarkupMeasureTypeA = 3,
  FSMarkupMeasureTypeT = 4, FSMarkupMeasureTypeS = 5
}
 Enumeration for annotation's measure type.
More...
 
enum  FSMarkupState {
  FSMarkupStateNone = 0, FSMarkupStateMarked = 1, FSMarkupStateUnmarked = 2, FSMarkupStateAccepted = 3,
  FSMarkupStateRejected = 4, FSMarkupStateCancelled = 5, FSMarkupStateCompleted = 6, FSMarkupStateDeferred = 7,
  FSMarkupStateFuture = 8
}
 Enumeration for markup annotation's state.
More...
 
enum  FSMarkupStateModel { FSMarkupStateModelMarked = 1, FSMarkupStateModelReview = 2 }
 Enumeration for markup annotation's state model.
More...
 
enum  FSMeasurementUnits { FSMeasurementInch, FSMeasurementCM, FSMeasurementMM }
 Enumeration for measurement units of page size information. More...
 
enum  FSMediaSettingsPlayerWindowType { FSMediaSettingsPlayerWindowTypeDockedPage = 1, FSMediaSettingsPlayerWindowTypeFloating = 2, FSMediaSettingsPlayerWindowTypeFullScreen = 4 }
 Enumeration for the type of window that the media should play in.
More...
 
enum  FSMenuControlScene { FSMenuControlSceneSelectedText, FSMenuControlSceneBlankSpace }
 The scene of menucontrol show. More...
 
enum  FSMenuViewType {
  FSMenuViewTypeThumbnailInsertBlankPagePop = 0, FSMenuViewTypeExtract, FSMenuViewTypeSaveAs, FSMenuViewTypeViewSecurityPermission,
  FSMenuViewTypeUnsupported
}
 
enum  FSModuleName {
  FSModuleNameConnectedPDF = 1, FSModuleNameXFA = 2, FSModuleNameRedaction = 3, FSModuleNameRMS = 4,
  FSModuleNameOCR = 5, FSModuleNameComparison = 6, FSModuleNameCompliance = 7, FSModuleNameOptimizer = 8,
  FSModuleNameConversion = 9, FSModuleNameLayoutRecognition = 10, FSModuleNameAccessibility = 11, FSModuleNameTableMaker = 12,
  FSModuleNameDWG2PDF = 13, FSModuleNameAdvEdit = 14, FSModuleNamePDF2Office = 15, FSModuleName3D = 16,
  FSModuleNameOFD = 17, FSModuleNameOffice2PDF = 18, FSModuleNamePrint2PDF = 19
}
 Enumeration for module name which is used in license information.
More...
 
enum  FSMonoImageSettingsMonoImageCompressMode {
  FSMonoImageSettingsImageCompressCCITT3 = 10001, FSMonoImageSettingsImageCompressCCITT4 = 10002, FSMonoImageSettingsImageCompressHigh = 10003, FSMonoImageSettingsImageCompressjbig2 = 10004,
  FSMonoImageSettingsImageCompressRetain = 10007, FSMonoImageSettingsImageCompressRunLength = 10008
}
 Enumeration for compression mode used for monochrome image.
More...
 
enum  FSMonoImageSettingsMonoImageCompressQuality { FSMonoImageSettingsImageCompressQualityLossless = 1, FSMonoImageSettingsImageCompressQualityLossy = 2 }
 Enumeration for compression quality used for monochrome image.
More...
 
enum  FSMonoImageSettingsStretchMode {
  FSMonoImageSettingsStretchDefault = -1, FSMonoImageSettingsStretchOff = 0x00, FSMonoImageSettingsStretchInterpol = 0x20, FSMonoImageSettingsStretchDownsample = 0x04,
  FSMonoImageSettingsStretchBicubic = 0x80, FSMonoImageSettingsStretchNoSmooth = 0x100
}
 Enumeration for stretch mode.
More...
 
enum  FSNightColorMode { FSNightColorModeDefault, FSNightColorModeMappingGray }
 
enum  FSOptimizerSettingsCleanUpOptions { FSOptimizerSettingsCleanUpUseFlateForNonEncodedStream = 0x01, FSOptimizerSettingsCleanUpUseFlateInsteadOfLZW = 0x02, FSOptimizerSettingsCleanUpRemoveInvalidBookmarks = 0x04, FSOptimizerSettingsCleanUpRemoveInvalidLinks = 0x08 }
 Enumeration for cleaning up options.
More...
 
enum  FSOptimizerSettingsDiscardObjectsOptions {
  FSOptimizerSettingsDiscardObjectsFormActions = 0x01, FSOptimizerSettingsDiscardObjectsFlattenFormFields = 0x02, FSOptimizerSettingsDiscardObjectsJavaScriptActions = 0x04, FSOptimizerSettingsDiscardObjectsEmbeddedPageThumbnails = 0x08,
  FSOptimizerSettingsDiscardObjectsEmbeddedPrintSettings = 0x10, FSOptimizerSettingsDiscardObjectsBookmarks = 0x20, FSOptimizerSettingsDiscardObjectsAlternateImages = 0x40, FSOptimizerSettingsDiscardObjectsDocumentTags = 0x80,
  FSOptimizerSettingsDiscardObjectsEmbeddedSearchIndex = 0x100
}
 Enumeration for discarding objects options.
More...
 
enum  FSOptimizerSettingsDiscardUserDataOptions {
  FSOptimizerSettingsDiscardUserDataAllAnnotsFormsAndMultimedia = 0x01, FSOptimizerSettingsDiscardUserDataExternalCrossReferences = 0x02, FSOptimizerSettingsDiscardUserDataDocumentInfoAndMetaData = 0x04, FSOptimizerSettingsDiscardUserDataFileAttchments = 0x08,
  FSOptimizerSettingsDiscardUserDataPrivateDataOfOtherApp = 0x10, FSOptimizerSettingsDiscardUserDataLayer = 0x20
}
 Enumeration for discarding user data options.
More...
 
enum  FSOptimizerSettingsOptimizerOptions {
  FSOptimizerSettingsOptimizerCompressImages = 0x01, FSOptimizerSettingsOptimizerCleanUp = 0x02, FSOptimizerSettingsOptimizerDiscardObjects = 0x04, FSOptimizerSettingsOptimizerUnembeddedFonts = 0x08,
  FSOptimizerSettingsOptimizerDiscardUserData = 0x10
}
 Enumeration for optimizer options.
More...
 
enum  FSOutputPreviewColorantType { FSOutputPreviewColorantTypeProcess = 0, FSOutputPreviewColorantTypeSpot = 1 }
 Enumeration for colorant type.
More...
 
enum  FSOutputPreviewShowType {
  FSOutputPreviewShowAll = 0, FSOutputPreviewShowDeviceCMYK = 1, FSOutputPreviewShowNotDeviceCMYK = 2, FSOutputPreviewShowICCBasedCMYK = 3,
  FSOutputPreviewShowSpotColor = 4, FSOutputPreviewShowDeviceCMYKAndSpot = 5, FSOutputPreviewShowNotDeviceCMYKOrSpot = 6, FSOutputPreviewShowDeviceN = 7,
  FSOutputPreviewShowCMYK = 8, FSOutputPreviewShowRGB = 9, FSOutputPreviewShowDeviceRGB = 10, FSOutputPreviewShowICCBasedRGB = 11,
  FSOutputPreviewShowGray = 12, FSOutputPreviewShowDeviceGray = 13, FSOutputPreviewShowCalGray = 14, FSOutputPreviewShowCalibrated = 15,
  FSOutputPreviewShowLab = 16, FSOutputPreviewShowDevice = 17, FSOutputPreviewShowImages = 18, FSOutputPreviewShowSolidColor = 19,
  FSOutputPreviewShowSmoothShades = 20, FSOutputPreviewShowRegistrationColor = 21, FSOutputPreviewShowText = 22, FSOutputPreviewShowLineArt = 23
}
 Enumeration for show type.
More...
 
enum  FSPageLabelsStyle {
  FSPageLabelsNone = 0, FSPageLabelsDecimalNums = 1, FSPageLabelsUpperRomanNums = 2, FSPageLabelsLowerRomanNums = 3,
  FSPageLabelsUpperLetters = 4, FSPageLabelsLowerLetters = 5
}
 Enumeration for page label style.
More...
 
enum  FSPagingSealConfigPagingSealPosition { FSPagingSealConfigPagingSealPositionLeft = 1, FSPagingSealConfigPagingSealPositionRight = 2, FSPagingSealConfigPagingSealPositionTop = 3, FSPagingSealConfigPagingSealPositionBottom = 4 }
 Enumeration for paging seal position.
More...
 
enum  FSPagingSealConfigPagingSealStyle { FSPagingSealConfigPagingSealStyleMultipleSignatures = 0, FSPagingSealConfigPagingSealStyleOneSignature = 1 }
 Enumeration for paging seal signature style.
More...
 
enum  FSPagingSealSignaturePagingSealAPState {
  FSPagingSealSignaturePagingSealAPStateUnknown = 0, FSPagingSealSignaturePagingSealAPStateUnsigned = 1, FSPagingSealSignaturePagingSealAPStateSigned = 2, FSPagingSealSignaturePagingSealAPStateValid = 3,
  FSPagingSealSignaturePagingSealAPStateInvalid = 4
}
 Enumeration for paging seal signature state to set appearance.
More...
 
enum  FSPanelType {
  FSPanelTypeAnnotation = 1, FSPanelTypeAttachment, FSPanelTypeOutline, FSPanelTypeReadingBookmark,
  FSPanelTypeDigitalSignature, FSPanelTypeCustom
}
 Panel types. More...
 
enum  FSPathPointType {
  FSPathTypeMoveTo = 1, FSPathTypeLineTo = 2, FSPathTypeLineToCloseFigure = 3, FSPathTypeBezierTo = 4,
  FSPathTypeBezierToCloseFigure = 5
}
 Enumeration for point type in path.
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  FSPDFDocExtractPagesOptions {
  FSPDFDocExtractPagesOptionAnnotation = 0x0001, FSPDFDocExtractPagesOptionStructureTree = 0x0002, FSPDFDocExtractPagesOptionJavascript = 0x0004, FSPDFDocExtractPagesOptionOCProperties = 0x0008,
  FSPDFDocExtractPagesOptionObjectStream = 0x0010, FSPDFDocExtractPagesOptionAttachFiles = 0x0020
}
 Enumeration for options used for extracting pages.
More...
 
enum  FSPDFDocImportPageFlags { FSPDFDocImportFlagNormal = 0, FSPDFDocImportFlagWithLayers = 0x0001, FSPDFDocImportFlagShareStream = 0x0002 }
 Enumeration for flags used for importing pages.
More...
 
enum  FSPDFDocInsertDocOptions { FSPDFDocInsertDocOptionAttachments = 0x0001 }
 Enumeration for options used for inserting a PDF document to another.
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, FSPDFDocSaveFlagNoUpdatingMetadataDateTime = 0x0020
}
 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, FSPDFNameTreePages = 4,
  FSPDFNameTreeTemplates = 5
}
 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  FSPDFScanToolbarType { FSPDFScanToolbarTypeBottombar }
 
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  FSPermissionState { FSPermissionStateShow, FSPermissionStateNo, FSPermissionStateHide }
 
enum  FSPortfolioInitialViewMode { FSPortfolioInitialViewUnknownMode = 0, FSPortfolioInitialViewDetailMode = 1, FSPortfolioInitialViewTileMode = 2, FSPortfolioInitialViewHidden = 3 }
 Enumeration for initial view mode for a portfolio PDF document.
More...
 
enum  FSPortfolioNodeType { FSPortfolioNodeTypeUnknown = 0, FSPortfolioNodeTypeFolder = 1, FSPortfolioNodeTypeFile = 2 }
 Enumeration for portfolio node type.
More...
 
enum  FSPrintDeviceSettingDataOrientationFlag { FSPrintDeviceSettingDataPortrait = 0, FSPrintDeviceSettingDataLandscape = 1 }
 Enumeration for specifying the orientation of the printer.
More...
 
enum  FSPrintParamsBookletBinding { FSPrintParamsBookletBindingRight = 0, FSPrintParamsBookletBindingLeft = 1, FSPrintParamsBookletBindingLeftTall = 2, FSPrintParamsBookletBindingRightTall = 3 }
 Enumeration for the values used to determine the duplex printing mode when printing a booklet.
More...
 
enum  FSPrintParamsBookletDuplexMode { FSPrintParamsBookletDuplexModeBothSides = 0, FSPrintParamsBookletDuplexModeFrontSideOnly = 1, FSPrintParamsBookletDuplexModeBackSideOnly = 2 }
 Enumeration for the values used to determine the duplex printing mode when printing a booklet.
More...
 
enum  FSPrintParamsDuplexType { FSPrintParamsDuplexTypeSimplex = 0, FSPrintParamsDuplexTypeDuplexFlipLongEdge = 1, FSPrintParamsDuplexTypeDuplexFlipShortEdge = 2 }
 Enumeration for the values used to set the printing duplex mode.
More...
 
enum  FSPrintParamsPageOrder { FSPrintParamsPageOrderHorizontal = 0, FSPrintParamsPageOrderHorizontalReversed = 1, FSPrintParamsPageOrderVertical = 2 }
 Enumeration for the values used to determine how the multiple pages are laid out on the sheet.
More...
 
enum  FSPrintParamsPrintContent { FSPrintParamsPrintContentDocument = 0, FSPrintParamsPrintContentDocAndAnnots = 1, FSPrintParamsPrintContentFormFieldsOnly = 2 }
 Enumeration for the values used to set the contents of the print job.
More...
 
enum  FSPrintParamsPrintHandling {
  FSPrintParamsPrintHandlingNone = 0, FSPrintParamsPrintHandlingFitPaper = 1, FSPrintParamsPrintHandlingReducePaper = 2, FSPrintParamsPrintHandlingMultiplePages = 3,
  FSPrintParamsPrintHandlingTileLargePages = 4, FSPrintParamsPrintHandlingBooklet = 5
}
 Enumeration for the values used to determine how the multiple pages are laid out on the sheet.
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  FSReadToolbarItemType { FSReadToolbarItemTypeExist, FSReadToolbarItemTypeCustom }
 The read tool item type. More...
 
enum  FSReadToolSettingsType {
  FSReadToolSettingsTypeText = 1, FSReadToolSettingsTypeImage, FSReadToolSettingsTypeAudio, FSReadToolSettingsTypeVideo,
  FSReadToolSettingsTypeLink, FSReadToolSettingsTypeNote = 100, FSReadToolSettingsTypeAttachments, FSReadToolSettingsTypeStamp,
  FSReadToolSettingsTypeTypewriter, FSReadToolSettingsTypeTextbox, FSReadToolSettingsTypeCallout, FSReadToolSettingsTypeHighlight,
  FSReadToolSettingsTypeUnderline, FSReadToolSettingsTypeSquiggly, FSReadToolSettingsTypeStrikeout, FSReadToolSettingsTypeReplaceText,
  FSReadToolSettingsTypeInsertText, FSReadToolSettingsTypeAreaHighlight, FSReadToolSettingsTypeMeasure, FSReadToolSettingsTypeImageAnnotation,
  FSReadToolSettingsTypePencil = 200, FSReadToolSettingsTypeHighlighter, FSReadToolSettingsTypeEraser, FSReadToolSettingsTypeRectangle,
  FSReadToolSettingsTypeOval, FSReadToolSettingsTypeLine, FSReadToolSettingsTypeArrow, FSReadToolSettingsTypePolygon,
  FSReadToolSettingsTypePolyLine, FSReadToolSettingsTypeCloud, FSReadToolSettingsTypeTextField = 300, FSReadToolSettingsTypeCheckBox,
  FSReadToolSettingsTypeRadioButton, FSReadToolSettingsTypeComboBox, FSReadToolSettingsTypeListBox, FSReadToolSettingsTypeSignatureField,
  FSReadToolSettingsTypeImageField, FSReadToolSettingsTypeFillSignText = 400, FSReadToolSettingsTypeFillSignSegText, FSReadToolSettingsTypeFillSignProfile,
  FSReadToolSettingsTypeFillSignCheckMark, FSReadToolSettingsTypeFillSignCrossMark, FSReadToolSettingsTypeFillSignDot, FSReadToolSettingsTypeFillSignLine,
  FSReadToolSettingsTypeFillSignRoundRectangle, FSReadToolSettingsTypeDigitalSignature = 500, FSReadToolSettingsTypeRedact, FSReadToolSettingsTypePassWord,
  FSReadToolSettingsTypeTrutedCertificates, FSReadToolSettingsTypeRMS, FSReadToolSettingsTypeAIP, FSReadToolSettingsTypeViewSingle = 700,
  FSReadToolSettingsTypeViewDay, FSReadToolSettingsTypeViewColor, FSReadToolSettingsTypeViewFitPage, FSReadToolSettingsTypeViewFitWidth,
  FSReadToolSettingsTypeViewReflow, FSReadToolSettingsTypeViewCrop, FSReadToolSettingsTypeViewSpeak, FSReadToolSettingsTypeViewAutoFlip,
  FSReadToolSettingsTypeViewRotate, FSReadToolSettingsTypeViewPanZoom
}
 The read tool settings type. More...
 
enum  FSReflowPageFlags { FSReflowPageNormal = 0x0, FSReflowPageWithImage = 0x1, FSReflowPageNoTruncate = 0x2 }
 Enumeration for parsing flags used for a reflow page.
More...
 
enum  FSRendererColorMode { FSRendererColorModeNormal = 0, FSRendererColorModeMappingGray = 1, 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  FSResponseResponseType { FSResponseTypeNone = 0, FSResponseTypeCRL = 1, FSResponseTypeOCSP = 2 }
 Enumeration for response type.
More...
 
enum  FSRichTextStyleCornerMarkStyle { FSRichTextStyleCornerMarkNone = 1, FSRichTextStyleCornerMarkSuperscript = 2, FSRichTextStyleCornerMarkSubscript = 3 }
 Enumeration for corner mark style.
More...
 
enum  FSRotation {
  FSRotation0 = 0, FSRotation90 = 1, FSRotation180 = 2, FSRotation270 = 3,
  FSRotationUnknown = 4
}
 Enumeration for rotation.
More...
 
enum  FSRotationPointOptions {
  FSRotationPointCenter = 0, FSRotationPointLeftTop = 1, FSRotationPointRightTop = 2, FSRotationPointLeftBottom = 3,
  FSRotationPointRightBottom = 4
}
 Enumeration for rotation point options.
More...
 
enum  FSScanCameraControllerItemType {
  FSScanCameraControllerItemTypeFlashLight, FSScanCameraControllerItemTypeSingleShooting, FSScanCameraControllerItemTypePhotos, FSScanCameraControllerItemTypeAutoDection,
  FSScanCameraControllerItemTypeFormatPageSize
}
 
enum  FSSearchOptionWordMatching { FSSearchOptionWordMatchingMatchPhrase = 0, FSSearchOptionWordMatchingMatchAllWords = 1, FSSearchOptionWordMatchingMatchAnyWord = 2 }
 Enumeration for word matching.
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, FSSignatureAPFlagFoxitEditorFlag = 0x0200, FSSignatureAPFlagProducer = 0x0400
}
 Enumeration for signature appearance flags.
More...
 
enum  FSSignatureDigestAlgorithm { FSSignatureDigestSHA1 = 0, FSSignatureDigestSHA256 = 1, FSSignatureDigestSHA384 = 2, FSSignatureDigestSHA512 = 3 }
 Enumeration for signature digest algorithm.
More...
 
enum  FSSignatureDocPermission { FSSignatureDocPermUnrestricted = 0, FSSignatureDocPermNoChangesAllowed = 1, FSSignatureDocPermFillingFormAndSigning = 2, FSSignatureDocPermFillingFormSigningAndAnnotating = 3 }
 Enumeration for signature document permission.
More...
 
enum  FSSignatureFieldMDPAction { FSSignatureFieldMDPActionNone = 0, FSSignatureFieldMDPActionAll = 1, FSSignatureFieldMDPActionInclude = 2, FSSignatureFieldMDPActionExclude = 3 }
 Enumeration for signature FieldMDP("MDP" means modification detection and prevention) action type.
More...
 
enum  FSSignatureKeyName {
  FSSignatureKeyNameSigner = 0, FSSignatureKeyNameLocation = 1, FSSignatureKeyNameReason = 2, FSSignatureKeyNameContactInfo = 3,
  FSSignatureKeyNameDN = 4, FSSignatureKeyNameText = 5, FSSignatureKeyNameProducer = 6
}
 Enumeration for signature key name.
More...
 
enum  FSSignatureLabelName {
  FSSignatureLabelNameSigner = 0, FSSignatureLabelNameLocation = 1, FSSignatureLabelNameReason = 2, FSSignatureLabelNameSignTime = 3,
  FSSignatureLabelNameDN = 4, FSSignatureLabelNameProducer = 6
}
 Enumeration for signature label name.
More...
 
enum  FSSignaturePAdESLevel {
  FSSignaturePAdESLevelNotPAdES = 0, FSSignaturePAdESLevelNone = 1, FSSignaturePAdESLevelBB = 2, FSSignaturePAdESLevelBT = 3,
  FSSignaturePAdESLevelBLT = 4, FSSignaturePAdESLevelBLTA = 5
}
 Enumeration for PAdES level.
More...
 
enum  FSSignatureSignatureType { FSSignatureSignatureTypeOrdinary = 0, FSSignatureSignatureTypeTimeStamp = 3, FSSignatureSignatureTypePagingSeal = 4 }
 Enumeration for signature type.
More...
 
enum  FSSignatureStates {
  FSSignatureStateUnknown = 0x80000000, 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, FSSignatureStateCertCannotGetVRI = 0x04000000, FSSignatureStateVerifyChangeLegal = 0x08000000,
  FSSignatureStateVerifyChangeIllegal = 0x10000000
}
 Enumeration for signature states.
More...
 
enum  FSSignatureVerifyResultLTVState { FSSignatureVerifyResultLTVStateInactive = 0, FSSignatureVerifyResultLTVStateEnable = 1, FSSignatureVerifyResultLTVStateNotEnable = 2 }
 Enumeration for LTV state that indicates if a signature is a LTV signature.
More...
 
enum  FSSoundSampleEncodingFormat { FSSoundSampleEncodingFormatRaw = 0, FSSoundSampleEncodingFormatSigned = 1, FSSoundSampleEncodingFormatMuLaw = 2, FSSoundSampleEncodingFormatALaw = 3 }
 Enumeration for encoding format of sound sample data.
More...
 
enum  FSStdSecurityHandlerModifyFlag { FSStdSecurityHandlerModifyPermission = 0x01, FSStdSecurityHandlerModifyUserPassword = 0x02, FSStdSecurityHandlerModifyOwnerPassword = 0x04 }
 (Only for AES-256) Enumeration for modify flag used to decide which security data or password will be modified during encryption process
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  FSTextPageCharInfoTextCharFlag {
  FSTextPageCharInfoUnknown = -1, FSTextPageCharInfoNormal = 0, FSTextPageCharInfoGenerated = 1, FSTextPageCharInfoUnUnicode = 2,
  FSTextPageCharInfoHyphen = 3, FSTextPageCharInfoComboWord = 4
}
 Enumeration for PDF textpage character flag.
More...
 
enum  FSTextPageTextOrderFlag { FSTextPageTextStreamOrder = 0, FSTextPageTextDisplayOrder = 1 }
 Enumeration for text order flag which is used when getting text content of a PDF page.
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,
  FSTextSearchSearchNotMatchFullWidth = 0x20
}
 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  FSTiledWatermarkSettingsFlags {
  FSTiledWatermarkSettingsFlagAsPageContents = 0x0000, FSTiledWatermarkSettingsFlagAsAnnot = 0x0001, FSTiledWatermarkSettingsFlagOnTop = 0x0002, FSTiledWatermarkSettingsFlagNoPrint = 0x0004,
  FSTiledWatermarkSettingsFlagInvisible = 0x0008
}
 Enumeration for tiled watermark setting flags.
More...
 
enum  FSTimeStampServerSendRequestResult {
  FSTimeStampServerSendResultSuccess = 0, FSTimeStampServerSendResultFailToCreateSocket = 1, FSTimeStampServerSendResultFailToConnect = 2, FSTimeStampServerSendResultFailToSendData = 3,
  FSTimeStampServerSendResultFailToReceiveData = 4, FSTimeStampServerSendResultFailToRequest = 5, FSTimeStampServerSendResultFailToGetData = 6, FSTimeStampServerSendResultOutOfMemory = 7
}
 Enumeration for the result of sending time stamp request.
More...
 
enum  FSToolbarType { FSTopBar = 1, FSBottomBar }
 Panel types. More...
 
enum  FSTopbarSubitemContentViewPosition { FSTopbarSubitemContentViewPositionTop, FSTopbarSubitemContentViewPositionLeft, FSTopbarSubitemContentViewPositionRight }
 The subbar is in the bar. More...
 
enum  FSUIElementType {
  FSUIElementReadingPanel = 20000, FSUIElementReadingPanelBookmark, FSUIElementReadingPanelOutline, FSUIElementReadingPanelComment,
  FSUIElementReadingPanelAttachment, FSUIElementReadingPanelDigitalSignature, FSUIElementReadingView, FSUIElementReadingViewSinglePage,
  FSUIElementReadingViewFacing, FSUIElementReadingViewCoverFacing, FSUIElementReadingViewDay, FSUIElementReadingViewNight,
  FSUIElementReadingViewPageColor, FSUIElementReadingViewContinuousScrolling, FSUIElementReadingViewFitPage, FSUIElementReadingViewFitWidth,
  FSUIElementReadingViewReflow, FSUIElementReadingViewCropMode, FSUIElementReadingViewSpeak, FSUIElementReadingViewAutoFlip,
  FSUIElementReadingViewRotateView, FSUIElementReadingViewPanZoom, FSUIElementReadingViewPageRTL, FSUIElementReadingThumbnial,
  FSUIElementReadingBookmark, FSUIElementReadingShare, FSUIElementReadingRecentList, FSUIElementReadingToolsTabHome,
  FSUIElementReadingToolsTabEdit, FSUIElementReadingToolsTabComment, FSUIElementReadingToolsTabDrawing, FSUIElementReadingToolsTabView,
  FSUIElementReadingToolsTabForm, FSUIElementReadingToolsTabFillSign, FSUIElementReadingHomeBarAddTools, FSUIElementReadingToolbarMultipleSelection,
  FSUIElementReadingEditBarText, FSUIElementReadingEditBarImage, FSUIElementReadingEditBarAudio, FSUIElementReadingEditBarVideo,
  FSUIElementReadingCommentBarNote, FSUIElementReadingCommentBarAttachment, FSUIElementReadingCommentBarStamp, FSUIElementReadingCommentBarTypeWriter,
  FSUIElementReadingCommentBarCallout, FSUIElementReadingCommentBarTextbox, FSUIElementReadingCommentBarHighlight, FSUIElementReadingCommentBarUnderline,
  FSUIElementReadingCommentBarSquiggly, FSUIElementReadingCommentBarStrikeout, FSUIElementReadingCommentBarInsertText, FSUIElementReadingCommentBarReplaceText,
  FSUIElementReadingCommentBarAreaHighlight, FSUIElementReadingCommentBarDistance, FSUIElementReadingCommentBarImage, FSUIElementReadingDrawingBarPencil,
  FSUIElementReadingDrawingBarHighlight, FSUIElementReadingDrawingBarEraser, FSUIElementReadingDrawingBarRectangle, FSUIElementReadingDrawingBarOval,
  FSUIElementReadingDrawingBarLine, FSUIElementReadingDrawingBarArrow, FSUIElementReadingDrawingBarPolyline, FSUIElementReadingDrawingBarPolygon,
  FSUIElementReadingDrawingBarCloud, FSUIElementReadingFormBarTextField, FSUIElementReadingFormBarCheckBox, FSUIElementReadingFormBarRadioButton,
  FSUIElementReadingFormBarListBox, FSUIElementReadingFormBarComboBox, FSUIElementReadingFormBarSignatureField, FSUIElementReadingFormBarImageField,
  FSUIElementReadingFormBarReset, FSUIElementReadingAnnotPopMenuAppearance, FSUIElementReadingAnnotPopMenuDelete, FSUIElementReadingFillSignTypeWriter,
  FSUIElementReadingFillSignComboText, FSUIElementReadingFillSignV, FSUIElementReadingFillSignX, FSUIElementReadingFillSignDot,
  FSUIElementReadingFillSignRectangle, FSUIElementReadingFillSignLine, FSUIElementReadingFillSignPredefined, FSUIElementReadingFillSignSign,
  FSUIElementReadingSearch, FSUIElementReadingMoreFileProperty, FSUIElementReadingMoreProtectRedaction, FSUIElementReadingMoreProtectFileEncryption,
  FSUIElementReadingMoreProtectTrustedCertificates, FSUIElementReadingMoreProtectCertificateProtect, FSUIElementReadingMoreProtectRMSProtect, FSUIElementReadingMoreCommentFieldImortComments,
  FSUIElementReadingMoreCommentFieldExportComments, FSUIElementReadingMoreCommentFieldSummarizeComments, FSUIElementReadingMoreCommentFieldExportHighlightedText, FSUIElementReadingMoreCommentFieldResetFormFields,
  FSUIElementReadingMoreCommentFieldImportFormFields, FSUIElementReadingMoreCommentFieldExportFormFields, FSUIElementReadingMoreSaveAs, FSUIElementReadingMoreExportPDF,
  FSUIElementReadingMoreReduceFileSize, FSUIElementReadingMoreTags, FSUIElementReadingMorePrint, FSUIElementReadingMoreFlatten,
  FSUIElementReadingMoreScreenCapture, FSUIElementReadingLongPressComment, FSUIElementReadingLongPressRedaction, FSUIElementReadingLongPressSign,
  FSUIElementReadingLongPressCopyText, FSUIElementReadingLongPressHighlight, FSUIElementReadingLongPressUnderline, FSUIElementReadingLongPressStrikeout,
  FSUIElementReadingLongPressSquiggly, FSUIElementReadingLongPressSpeak, FSUIElementReadingGotoPage, FSUIElementReadingFullScreenBookmark,
  FSUIElementReadingFullScreenToolbar, FSUIElementReadingFullScreenToolbarDrag, FSUIElementReadingToolbarDrag, FSUIElementReadingFreeTrial,
  FSUIElementReadingInkRecognitionText
}
 ui emlement types. More...
 
enum  FSUIManagerState {
  FSUIManagerStateNormal = 1, FSUIManagerStateReflow, FSUIManagerStateSearch, FSUIManagerStateAnnotTool,
  FSUIManagerStatePanZoom, FSUIManagerStateCreateForm, FSUIManagerStateSpeech, FSUIManagerStateFillSign,
  FSUIManagerStateAutoFlip, FSUIManagerStateRedaction, FSUIManagerStateComparision, FSUIManagerStateEditor
}
 States of extensions manager. More...
 
enum  FSWatermarkTextPropertiesFontStyle { FSWatermarkTextPropertiesFontStyleNormal = 0, FSWatermarkTextPropertiesFontStyleUnderline = 1 }
 Enumeration for watermark font style.
More...
 
enum  FSWidgetLineSpacingStyle {
  FSWidgetLineSpacingSingle = 0, FSWidgetLineSpacingOneAndHalf = 1, FSWidgetLineSpacingDouble = 2, FSWidgetLineSpacingExactValue = 3,
  FSWidgetLineSpacingAuto = 4
}
 Enumeration for line spacing 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  FSXFAWidgetWidgetEdgePosition { FSXFAWidgetWidgetEdgePositionTop = 0, FSXFAWidgetWidgetEdgePositionRight = 1, FSXFAWidgetWidgetEdgePositionBottom = 2, FSXFAWidgetWidgetEdgePositionLeft = 3 }
 Enumeration for the positon of XFA widget edge position.
More...
 
enum  FSXFAWidgetWidgetHAlignType {
  FSXFAWidgetWidgethAlignTypeCenter = 128, FSXFAWidgetWidgethAlignTypeJustify = 156, FSXFAWidgetWidgethAlignTypeJustifyAll = 61, FSXFAWidgetWidgethAlignTypeLeft = 252,
  FSXFAWidgetWidgethAlignTypeRadix = 231, FSXFAWidgetWidgethAlignTypeRight = 54
}
 Enumeration for the type of text horizontal alignment of XFA widget.
More...
 
enum  FSXFAWidgetWidgetNameType { FSXFAWidgetWidgetNameTypeField = 0, FSXFAWidgetWidgetNameTypeCaption = 1, FSXFAWidgetWidgetNameTypeFullName = 2 }
 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,
  FSXFAWidgetWidgetTypeImage = 16
}
 Enumeration for the type of XFA widget.
More...
 
enum  FSXFAWidgetWidgetVAlignType { FSXFAWidgetWidgetvAlignTypeTop = 33, FSXFAWidgetWidgetvAlignTypeBottom = 85, FSXFAWidgetWidgetvAlignTypeMiddle = 161 }
 Enumeration for the type of text vertical alignment of XFA widget.
More...
 
enum  PDF_CERT_ERROR_CODE { PDF_CERT_ERROR_SUCESSS = 0, PDF_CERT_ERROR_FILE, PDF_CERT_ERROR_PASSWORD }
 Enumeration for certificate related error code. More...
 
enum  PDF_CROP_MODE { PDF_CROP_MODE_NONE = -1, PDF_CROP_MODE_CONTENTSBOX, PDF_CROP_MODE_DETECTION, PDF_CROP_MODE_CUSTOMIZED }
 Enumeration for page crop mode. More...
 
enum  PDF_DISPLAY_ZOOMMODE { PDF_DISPLAY_ZOOMMODE_UNKNOWN = 0, PDF_DISPLAY_ZOOMMODE_FITPAGE, PDF_DISPLAY_ZOOMMODE_FITWIDTH, PDF_DISPLAY_ZOOMMODE_FITHEIGHT }
 Enumeration for PDF display zoom mode. More...
 
enum  PDF_LAYOUT_MODE {
  PDF_LAYOUT_MODE_UNKNOWN = 0, PDF_LAYOUT_MODE_SINGLE, PDF_LAYOUT_MODE_TWO, PDF_LAYOUT_MODE_REFLOW,
  PDF_LAYOUT_MODE_TWO_LEFT, PDF_LAYOUT_MODE_TWO_RIGHT, PDF_LAYOUT_MODE_TWO_MIDDLE
}
 Enumeration for PDF layout mode. More...
 
enum  PDF_PAGE_BINDING_EDGE { PDF_PAGE_BINDING_UNKNOWN = 0, PDF_PAGE_BINDING_LEFT_EDGE = 1, PDF_PAGE_BINDING_RIGHT_EDGE = 2 }
 Enumeration for page binding edge. More...
 
enum  PDF_PAGE_STYLE_TYPE {
  PDF_PAGE_STYLE_TYPE_BLANK = 0, PDF_PAGE_STYLE_TYPE_LINED, PDF_PAGE_STYLE_TYPE_GRID, PDF_PAGE_STYLE_TYPE_GRAPH,
  PDF_PAGE_STYLE_TYPE_MUSIC
}
 Enumeration for page style direction. More...
 
enum  PDF_REFLOW_REFLOWMODE { PDF_REFLOW_NONE = 0, PDF_REFLOW_WITHIMAGE = 1, PDF_REFLOW_ONLYTEXT }
 Enumeration for page reflow mode. More...
 
enum  PDFScanMenuViewType { PDFScanMenuViewTypeThumbnailInsertBlankPagePop = 0, PDFScanMenuViewTypeExtract, PDFScanMenuViewTypeSaveAs }
 
enum  SettingItemType {
  SINGLE, DOUBLEPAGE, COVERPAGE, DAYMODE,
  PAGECOLOR, NIGHTMODE, CONTINUOUS, PAGERTL,
  FITPAGE, FITWIDTH, REFLOW, CROPPAGE,
  SPEECH, AUTOFLIP, ROTATE, PANZOOM
}
 Enumeration for item types in setting bar. More...
 

Detailed Description

Enumeration Type Documentation

◆ FS_PAGESPACING_DIRECTION

Enumeration for page spacing direction.

Enumerator
FS_PAGESPACING_HORIZONTAL 

PageSpcaing horizontal direction.

FS_PAGESPACING_VERTICAL 

PageSpcaing vertical direction.

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

◆ FSAnnotationSummarySettingsFontSizeType

Enumeration for options used for font size type in result document.

Values of this enumeration can be used alone.

Enumerator
FSAnnotationSummarySettingsFontSizeSmall 

If set, that means to use small font size in result document.

FSAnnotationSummarySettingsFontSizeMedium 

If set, that means to use medium font size in result document.

FSAnnotationSummarySettingsFontSizeLarge 

If set, that means to use large font size in result document.

◆ FSAnnotationSummarySettingsSortType

Enumeration for options used for sorting annotation in result document.

Values of this enumeration can be used alone.

Enumerator
FSAnnotationSummarySettingsTypeSortByAuthor 

If set, that means to sort annotation by author in result document.

FSAnnotationSummarySettingsTypeSortByDate 

If set, that means to sort annotation by date in result document.

FSAnnotationSummarySettingsTypeSortByPage 

If set, that means to sort annotation by page in result document.

FSAnnotationSummarySettingsTypeSortByAnnotationType 

If set, that means to sort annotation by annotation type in result document.

◆ FSAnnotationSummarySettingsSummaryLayout

Enumeration for options used for annotation summary layout.

Values of this enumeration can be used alone.

Enumerator
FSAnnotationSummarySettingsSummaryLayoutSeparatePagesWithLine 

If set, that means to layout document and annotations with connector lines on separate pages.

FSAnnotationSummarySettingsSummaryLayoutSinglePageWithLine 

If set, that means to layout document and annotations with connector lines on single pages.

FSAnnotationSummarySettingsSummaryLayoutAnnotationOnly 

If set, that means to layout annotations only.

FSAnnotationSummarySettingsSummaryLayoutSeparatePagesWithSequenceNumber 

If set, that means to layout document and annotations with sequence numbers on separate pages.

FSAnnotationSummarySettingsSummaryLayoutSinglePageWithSequenceNumber 

If set, that means to layout document and annotations with sequence numbers on separate pages.

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

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.

Free text annotation can have border color property but not support to remove this property from free text annotation.

FSAnnotPropertyFillColor 

Annotation property: fill color.

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

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

FSAnnotRichMedia 

Annotation type: rich media annotation.

FSAnnotPagingSeal 

Annotation type: paging seal annotation. A Foxit PDF SDK custom annotation type (not a standard annotation type).

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

FSBitmapDIB1bpp 

DIB format: 1bpp format, two color RGB bitmap.It does not support format conversion between bitmaps.

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.

FSBitmapDIBCmyk 

DIB format: 32bpp CMYK format, with bits order "Cyan, Magenta, Yellow, Black". Cyan is in the lowest order.

FSBitmapDIB8bppMask 

DIB format: 8bpp alpha mask.

FSBitmapDIB8bpp 

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

FSBitmapDIB8bppGray 

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

FSBitmapDIBAbgr 

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

FSBitmapDIBRgb565 

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

◆ FSBitmapFadeOutEnhancementAlgorithm

Enumeration for bitmap enhancement algorithm for fading out.

Values of this enumeration should be used alone.

◆ FSBitmapFadeOutThresholdAlogrithm

Enumeration for bitmap threshold algorithm for fading out.

Values of this enumeration should be used alone.

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

◆ FSCertVerifyResultCertStatus

Enumeration for certificate status.

Values of this enumeration should be used alone.

Enumerator
FSCertVerifyResultCertStatusValid 

This means certificate is valid.

FSCertVerifyResultCertStatusRevoked 

This means certificate is revoked.

FSCertVerifyResultCertStatusExpired 

This means certificate is expired.

FSCertVerifyResultCertStatusUnknown 

This means certificate status is unknown.

◆ FSCertVerifyResultResponseInfoLocation

Enumeration for response information location.

Values of this enumeration should be used alone.

Enumerator
FSCertVerifyResultLocationNotSet 

Location is not set.

FSCertVerifyResultLocationDSS 

Response information is found in DSS dictionary.

FSCertVerifyResultLocationSignature 

Response information is found in signature content.

FSCertVerifyResultLocationOnline 

Response information is got by online request.

◆ FSCertVerifyResultRevocationReason

Enumeration for revocation reason for a certificate.

Values of this enumeration should be used alone.

Enumerator
FSCertVerifyResultReasonNoStatus 

Revocatoin reason: ceritifcate has no status.

FSCertVerifyResultReasonUnspecified 

Revocatoin reason: unspecified reason.

FSCertVerifyResultReasonKeyCompromise 

Revocatoin reason: key compromise.

FSCertVerifyResultReasonCACompromise 

Revocatoin reason: CA compromise.

FSCertVerifyResultReasonAffiliationChanged 

Revocatoin reason: affiliation changed.

FSCertVerifyResultReasonSuperseded 

Revocatoin reason: superseded.

FSCertVerifyResultReasonCessationOfOperation 

Revocatoin reason: cessation of operation.

FSCertVerifyResultReasonCertificateHold 

Revocatoin reason: certificate hold.

FSCertVerifyResultReasonRemoveFromCRL 

Revocatoin reason: remove from CRL.

FSCertVerifyResultReasonPrivilegeWithDrawn 

Revocatoin reason: privilege with drawn.

FSCertVerifyResultReasonAACompromise 

Revocatoin reason: AA compromise.

◆ FSColorSpaceRenderingIntent

Enumeration for rendering intent.

Values of this enumeration should be used alone.
Rendering intent can be used for color conversion. Please refer to Section 8.6.5.8 "Rendering intents" in the reference doucment for PDF 2.0 for more details.

Enumerator
FSColorSpaceRenderIntentPerceptual 

Rendering intent: Perceptual.

FSColorSpaceRenderIntentRelColorimetric 

Rendering intent: Relative Colorimetric.

FSColorSpaceRenderIntentSaturation 

Rendering intent: Saturation.

FSColorSpaceRenderIntentAbsColorimetric 

Rendering intent: Absolute Colorimetric.

◆ FSColorSpaceType

Enumeration for color space.

Values of this enumeration should be used alone.

Enumerator
FSColorSpaceInvalid 

Color space: Invalid.

FSColorSpaceDeviceGray 

Color space: DeviceGray. (1 component, gray)

FSColorSpaceDeviceRGB 

Color space: DeviceRGB. (3 components, R, G, B)

FSColorSpaceDeviceCMYK 

Color space: DeviceCMYK. (4 components, C, M, Y, K)

FSColorSpaceCalGray 

Color space: CalGray. (1 component, A)

FSColorSpaceCalRGB 

Color space: CalRGB. (3 components, A, B, C)

FSColorSpaceLab 

Color space: Lab. (3 components, A, B, C)

FSColorSpaceICCBased 

Color space: ICCBased.

FSColorSpaceSeparation 

Color space: Separation.

FSColorSpaceDeviceN 

Color space: DeviceN.

FSColorSpaceIndexed 

Color space: Indexed.

FSColorSpacePattern 

Color space: Pattern.

FSColorSpaceICCBasedDeviceGray 

Color space: ICCBased DeviceGray. (1 component, gray)

FSColorSpaceICCBasedDeviceRGB 

Color space: ICCBased DeviceRGB. (3 components, R, G, B)

FSColorSpaceICCBasedDeviceCMYK 

Color space: ICCBased DeviceCMYK. (4 components, C, M, Y, K)

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

FSCompareResultInfoCompareResultTypeDeleteImage 

Result type: delete image.

FSCompareResultInfoCompareResultTypeInsertImage 

Result type: insert image.

FSCompareResultInfoCompareResultTypeReplaceImage 

Result type: replace image.

FSCompareResultInfoCompareResultTypeDeletePath 

Result type: delete path.

FSCompareResultInfoCompareResultTypeInsertPath 

Result type: insert path.

FSCompareResultInfoCompareResultTypeReplacePath 

Result type: replace path.

FSCompareResultInfoCompareResultTypeDeleteShading 

Result type: delete shading.

FSCompareResultInfoCompareResultTypeInsertShading 

Result type: insert shading.

FSCompareResultInfoCompareResultTypeReplaceShading 

Result type: replace shading.

FSCompareResultInfoCompareResultTypeDeleteAnnot 

Result type: delete annotation.

FSCompareResultInfoCompareResultTypeInsertAnnot 

Result type: insert annotation.

FSCompareResultInfoCompareResultTypeReplaceAnnot 

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 and some values can be used in combination.

Enumerator
FSComparisonCompareTypeAll 

Compare all content. This value should be used alone.

FSComparisonCompareTypeText 

Compare text only.

FSComparisonCompareTypeAnnotation 

Compare annotation only.

◆ FSDataSortComparison

Constants that indicate sort order.

Enumerator
FSDataSortOrderedAscending 

The left operand is smaller than the right operand.

FSDataSortOrderedDescending 

The left operand is greater than the right operand.

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

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

◆ FSDWG2PDFSettingDataDWG2PDFColorPolicy

Enumeration for color policy used for converting DWG to PDF.

Values of this enumeration should be used alone.

Enumerator
FSDWG2PDFSettingDataDWG2PDFColorPolicyNoPolicy 

Color policy: No color policy. A drawing is exported with its native color palette (as is).

FSDWG2PDFSettingDataDWG2PDFColorPolicyMono 

Color policy: Drawing is exported to a monochrome PDF file.

FSDWG2PDFSettingDataDWG2PDFColorPolicyGrayscale 

Color policy: Drawing is exported to a grayscale PDF file. Native colors are converted into grayscale.

◆ FSDWG2PDFSettingDataDWG2PDFExportFlags

Enumeration for flags of DWG to PDF export.

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

Enumerator
FSDWG2PDFSettingDataFlagEmbededTTF 

Bit 1. Enable embedding of TTF(True Type Font) program to PDF file. The whole TTF font file will be embedded (huge PDF size).

FSDWG2PDFSettingDataFlagTTFTextAsGeometry 

Bit 2. Enable TTF font text to geometry conversion.

FSDWG2PDFSettingDataFlagSHXTextAsGeometry 

Bit 3. Enable SHX font text to geometry conversion.

FSDWG2PDFSettingDataFlagSimpleGeomOptimization 

Bit 4. Enable simple geometry optimization (separated segments to one polyline, Bezier curve control points).

FSDWG2PDFSettingDataFlagEnableLayers 

Bit 5. If enabled, layer support will be added to PDF file (1.5 version required).

FSDWG2PDFSettingDataFlagIncludeOffLayers 

Bit 6. If enabled, invisible layers will be added to PDF file (1.5 version required).

FSDWG2PDFSettingDataFlagEmbededOptimizedTTF 

Bit 7. Enable embedding of TTF font program to PDF file. The TTF font will be reduced by removing unused parts (smaller PDF file size, but limited editing).

FSDWG2PDFSettingDataFlagUseHLR 

Bit 8. Determines whether software uses vector hidden-line removal for corresponding viewports.

FSDWG2PDFSettingDataFlagFlateCompression 

Bit 9. Enable compression of internal PDF streams.

FSDWG2PDFSettingDataFlagASCIIHexEncoding 

Bit 10. Enable ASCIIHex encoding of internal PDF streams.

FSDWG2PDFSettingDataFlagExportHyperlinks 

Bit 11. Enable hyperlinks export.

FSDWG2PDFSettingDataFlagZoomToExtentsMode 

Bit 12. If enabled, layout geometry will be zoomed to paper size, else layout settings will be applied.

Note
This mode works like some Layout settings: "Plot Area" - "Extents", "Fit to Paper", "Center the plot", these settings applied to specified paper size and orientation, but some settings like "Plot lineweight", "Plot style" are still applying from Layout settings.
FSDWG2PDFSettingDataFlagLinearized 

Bit 13. Create linearized PDF file.

FSDWG2PDFSettingDataFlagMeasuring 

Bit 15. Enable measuring scale in pdf.

◆ FSDWG2PDFSettingDataDWG2PDFExportHatchesType

Enumeration for hatches export type used for converting DWG to PDF.

Values of this enumeration should be used alone.

Enumerator
FSDWG2PDFSettingDataDWG2PDFExportHatchesTypeBitmap 

Hatches export type: Exports hatch as a bitmap.

FSDWG2PDFSettingDataDWG2PDFExportHatchesTypeDrawing 

Hatches export type: Exports hatch as a set of triangles (vectorizer).

FSDWG2PDFSettingDataDWG2PDFExportHatchesTypePdfPaths 

Hatches export type: Exports hatch as a PDF path (solid hatches only).

FSDWG2PDFSettingDataDWG2PDFExportHatchesTypePolygons 

Hatches export type: Exports hatch as a polygon (solid hatches only).

◆ FSDWG2PDFSettingDataDWG2PDFSearchableTextType

Enumeration for searchable text type used for converting DWG to PDF.

Values of this enumeration should be used alone.

Enumerator
FSDWG2PDFSettingDataDWG2PDFSearchableTextTypeNoSearch 

Searchable text type: No searchable text.

FSDWG2PDFSettingDataDWG2PDFSearchableTextTypeSHX 

Searchable text type: Only text displayed with SHX font is searchable.

FSDWG2PDFSettingDataDWG2PDFSearchableTextTypeTTF 

Searchable text type: Only text displayed with TTF font is searchable.

◆ FSErrorCode

Intent: converted result file will be used for printing.

Intent: converted result file will be used for showing on screen.

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.

FSErrTimeStampServerMgrNotInit 

Time stamp server manager has not been initialized successfully.

FSErrLTVVerifyModeNotSet 

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

FSErrLTVRevocationCallbackNotSet 

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

FSErrLTVCannotSwitchVersion 

(For LTV only) Fail to switch PDF verion.

FSErrLTVCannotCheckDTS 

(For LTV only) Fail to check DTS.

FSErrLTVCannotLoadDSS 

(For LTV only) Fail to load DSS.

FSErrLTVCannotLoadDTS 

(For LTV only) Fail to load DTS.

FSErrNeedSigned 

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

FSErrComplianceResourceFile 

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

FSErrTimeStampServerMgrNoDefaltServer 

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

FSErrDefaultTimeStampServer 

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

FSErrNoConnectedPDFModuleRight 

No "ConnectedPDF" module right.

FSErrNoXFAModuleRight 

No "XFA" module right.

FSErrNoRedactionModuleRight 

No "Redaction" module right.

FSErrNoRMSModuleRight 

No "RMS" module right.

FSErrNoOCRModuleRight 

No "OCR" module right.

FSErrNoComparisonModuleRight 

No "Comparison" module right.

FSErrNoComplianceModuleRight 

No "Compliance" module right.

FSErrNoOptimizerModuleRight 

No "Optimizer" module right.

FSErrNoConversionModuleRight 

No "Conversion" module right.

FSErrOfficeComNotInit 

(For Office-to-PDF conversion only) Office COM has not been initialized successfully.

FSErrNoMicroOfficeInstalled 

(For Office-to-PDF conversion only) No Microsoft Office is installed in current system.

FSErrExcelHasNoContent 

(For Excel-to-PDF conversion only) Excel document does not have any content so it cannot be converted to PDF file.

FSErrNoLayoutRecognitionModuleRight 

No "LayoutRecognition" module right.

FSErrWPSEngineNotFound 

(For Office-to-PDF conversion only) WPS office engine is not found.

FSErrLibreofficeEngineNotFound 

(For Office-to-PDF conversion only) Libre office engine is not found.

FSErrNoAccessibilityModuleRight 

No "Accessibility" module right.

FSErrODAEngineNotFound 

(For DWG-to-PDF conversion only) ODA engine is not found.

FSErrNoTableMakerModuleRight 

No "TableMaker" module right.

FSErrNoDWG2PDFModuleRight 

No "DWG2PDF" module right.

FSErrNoAdvEditModuleRight 

No "AdvEdit" module right.

FSErrNoPDF2OfficeModuleRight 

No "PDF2Office" module right.

FSErrURLInBlackList 

(For converting html to pdf only) The converted URL is on blacklist.

FSErrOFDEngineNotInit 

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

FSErrNoOFDModuleRight 

No "OFD" module right.

FSErrNo3DModuleRight 

No "3D" module right.

FSErrInvalidRegex 

Invalid regular expression.

FSErrNoDocumentPermission 

No document permission to operate.

FSErrNoOffice2PDFModuleRight 

No "Office2PDF" module right.

FSErrMIPUPEEngineInitFailed 

MIP engine: add upe engine failed.

FSErrMIPProtectionEngineInitFailed 

MIP engine: add upe engine failed.

FSErrMIPCreateProtectionHandlerFailed 

MIP engine: create protection handler failed.

FSErrMIPGetExtendedLabelInfoByIdFailed 

MIP engine: get extended label information by id failed.

FSErrNoPrint2PDFModuleRight 

No "Print2PDF" module right.

◆ 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.
FSFieldFlagTextFileSelect 

(Only useful for text field) If set, the text entered in the field represents the pathname of a file whose contents are to be submitted as the value of the field.

FSFieldFlagTextNoSpellCheck 

(Only useful for text field) If set, text entered in the field is not spell-checked.

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.

FSFieldFlagChoiceMultiSelect 

(Only useful for 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.

FSFieldFlagTextRichText 

(Only useful for text field) If set, the value of this field should be represented as a rich text string.

FSFieldFlagChoiceSort 

(Only useful for choice field) If set, the field's option items should be sorted alphabetically.

FSFieldFlagChoiceCommitOnSelChange 

(Only useful for choice field) If set, the new value is committed as soon as a selection is made with the pointing device; if clear, the new value is not committed until the user exits the field.

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

◆ FSFileFormatType

Enumeration for file format type.

Values of this enumeration can be used alone.

Enumerator
FSFileFormatTypeFDF 

File format type: FDF.

FSFileFormatTypeXFDF 

File format type: XFDF.

FSFileFormatTypeHTML 

File format type: HTML.

FSFileFormatTypeXDP 

File format type: XDP.

FSFileFormatTypeXML 

File format type: XML.

FSFileFormatTypeXFD 

File format type: XFD.

FSFileFormatTypePDF 

File format type: PDF.

FSFileFormatTypeTXT 

File format type: TXT.

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

◆ FSFillSignFillSignObjectType

Enumeration for fill-sign object type.

Values of this enumeration can be used alone.

Enumerator
FSFillSignFillSignObjectTypeText 

Text fill-sign object.

FSFillSignFillSignObjectTypeCrossMark 

Cross mark fill-sign object.

FSFillSignFillSignObjectTypeCheckMark 

Check mark fill-sign object.

FSFillSignFillSignObjectTypeRoundRectangle 

Round rectangle fill-sign object.

FSFillSignFillSignObjectTypeLine 

Line fill-sign object.

FSFillSignFillSignObjectTypeDot 

Dot fill-sign object.

FSFillSignFillSignObjectTypeSignature 

Signature fill-sign object.

FSFillSignFillSignObjectTypeInitialsSignature 

Initials signature fill-sign object.

◆ FSFloatingInfoOffScreenAction

Enumeration for the action can be taken if the floating window is positioned totally or partially offscreen.

Values of this enumeration should be used alone.

Enumerator
FSFloatingInfoOffScreenAllow 

Off screen action: take no action.

FSFloatingInfoOffScreenForceOnScreen 

Off screen action: move or resize the window so that it is on-screen.

FSFloatingInfoOffScreenCancel 

Off screen action: cancel playing the media clip.

◆ FSFloatingInfoRelativeTarget

Enumeration for the values used to set relative position of floating window.

Values of this enumeration should be used alone.

Enumerator
FSFloatingInfoRelativeTargetPageWindow 

Relative type: align the floating window relative to the document (page) window.

FSFloatingInfoRelativeTargetAppWindow 

Relative type: align the floating window relative to the application window.

FSFloatingInfoRelativeTargetDesktop 

Relative type: align the floating window relative to the full virtual desktop.

FSFloatingInfoRelativeTargetMonitor 

Relative type: align the floating window relative to the (selected) monitor display screen.

◆ FSFloatingInfoResizeType

Enumeration for the resize type, which specifies whether a floating window may be resized by the user.

Values of this enumeration should be used alone.

Enumerator
FSFloatingInfoResizeTypeNo 

Resize type: may not be resized.

FSFloatingInfoResizeTypeKeepRatio 

Resize type: may be resized only if the aspect ratio is preserved.

FSFloatingInfoResizeTypeYes 

Resize type: may be resized without preserving the aspect ratio.

◆ FSFloatingInfoWindowPosition

Enumeration for the window position used for media player.

Values of this enumeration should be used alone.

Enumerator
FSFloatingInfoWindowPositionTopLeft 

Window position: at the top left corner.

FSFloatingInfoWindowPositionTopCenter 

Window position: at the top center.

FSFloatingInfoWindowPositionTopRight 

Window position: at the top right corner.

FSFloatingInfoWindowPositionCenterLeft 

Window position: at the center left.

FSFloatingInfoWindowPositionCenter 

Window position: at the center.

FSFloatingInfoWindowPositionCenterRight 

Window position: at the center right.

FSFloatingInfoWindowPositionBottomLeft 

Window position: at the bottom left corner.

FSFloatingInfoWindowPositionBottomCenter 

Window position: at the bottom center.

FSFloatingInfoWindowPositionBottomRight 

Window position: at the bottom right corner.

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

◆ FSFontCIDCharset

Enumeration for CID font charset.

Values of this enumeration should be used alone.

Enumerator
FSFontCIDCharsetUnknown 

CID Font charset: Unknown.

FSFontCIDCharsetGB1 

CID Font charset: Adobe-GB1.

FSFontCIDCharsetCNS1 

CID Font charset: Adobe-CNS1.

FSFontCIDCharsetJAPAN1 

CID Font charset: Adobe-Japan1.

FSFontCIDCharsetKOREA1 

CID Font charset: Adobe-Korea1.

FSFontCIDCharsetUNICODE 

CID Font charset: Unicode.

◆ FSFontFontTypes

Enumeration for font type.

Values of this enumeration can be used alone .

Enumerator
FSFontFontTypeType1 

Font type: Type1.

FSFontFontTypeTrueType 

Font type: TrueType.

FSFontFontTypeType3 

Font type: Type3.

FSFontFontTypeCIDFont 

Font type: CID font.

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

◆ FSFunction

enum FSFunction
Enumerator
FSFunctionMultiMediaEdit 

The function is mobile delete multimedia annotation.

The function is edit document Information

The function is edit document Information

FSFunctionDocInfoEdit 

The function is edit.

FSFunctionEdit 

The function is reduce.

FSFunctionReduce 

The function is pdf sign and add certificate file function.

FSFunctionPDFDigitalSignAdd 

The function is RMS encryption function.

FSFunctionRMS 
FSFunctionDigitalSignField 
FSFunctionRedaction 
FSFunctionCanSaveToLocal 
FSFunctionStandEncrypt 
FSFunctionFlatten 
FSFunctionPDFSign 
FSFunctionPDFBookMark 
FSFunctionSmallBottomBarToolItem 
FSFunctionImageAnnoteItem 
FSFunctionAttachmentsPanelAddItem 
FSFunctionAttachmentsPanelEditItem 
FSFunctionPDFEsign 
FSFunctionDocumentAttachmentCanEdit 
FSFunctionInkRecognize 
FSFunction3DView 

◆ FSGestureLockOptions

Enumerator
FSGestureLockOptionNone 

Unset, requires a separate value.

FSGestureLockOptionSingleTap 

Lock single-tap gesture.

FSGestureLockOptionDoubleTap 

Lock double-tap gesture.

FSGestureLockOptionLongPress 

Lock long press gesture.

FSGestureLockOptionPinch 

Lock pinch-to-zoom gesture.

FSGestureLockOptionPan 

Lock pan gesture.

FSGestureLockOptionAll 

Lock all gestures.

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

◆ FSGraphicsObjectsTextMergeOption

Enumeration for text merge.

Values of this enumeration should be used alone.

Enumerator
FSGraphicsObjectsTextMergeNone 

No text merge.

FSGraphicsObjectsTextMergeTJY 

Merge consecutive text-showing operators with equal y coordinates.

FSGraphicsObjectsTextMergeBTET 

Merge consecutive BTETs as a new one.

'/BT' is an operator in the content stream that indicates the start of a text object. '/ET' is an operator in the content stream that indicates the end of a text object. If the merge option is used, it will merge multiple consecutive '/BT' and '/ET' as a new one.

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

◆ FSHeaderFooterContentGeneratorDateFormatType

Enumeration for date format type.

Values of this enumeration can be used alone.

Enumerator
FSHeaderFooterContentGeneratorDateFormatMSlashD 

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

FSHeaderFooterContentGeneratorDateFormatMSlashDSlashYY 

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

FSHeaderFooterContentGeneratorDateFormatMSlashDSlashYYYY 

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

FSHeaderFooterContentGeneratorDateFormatMMSlashDDSlashYY 

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

FSHeaderFooterContentGeneratorDateFormatMMSlashDDSlashYYYY 

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

FSHeaderFooterContentGeneratorDateFormatDSlashMSlashYY 

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

FSHeaderFooterContentGeneratorDateFormatDSlashMSlashYYYY 

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

FSHeaderFooterContentGeneratorDateFormatDDSlashMMSlashYY 

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

FSHeaderFooterContentGeneratorDateFormatDDSlashMMSlashYYYY 

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

FSHeaderFooterContentGeneratorDateFormatMMSlashYY 

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

FSHeaderFooterContentGeneratorDateFormatMMSlashYYYY 

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

FSHeaderFooterContentGeneratorDateFormatMDotDDotYY 

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

FSHeaderFooterContentGeneratorDateFormatMDotDDotYYYY 

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

FSHeaderFooterContentGeneratorDateFormatMMDotDDDotYY 

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

FSHeaderFooterContentGeneratorDateFormatMMDotDDDotYYYY 

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

FSHeaderFooterContentGeneratorDateFormatMMDotYY 

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

FSHeaderFooterContentGeneratorDateFormatDDotMDotYYYY 

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

FSHeaderFooterContentGeneratorDateFormatDDDotMMDotYY 

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

FSHeaderFooterContentGeneratorDateFormatDDDotMMDotYYYY 

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

FSHeaderFooterContentGeneratorDateFormatYYHyphenMMHyphenDD 

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

FSHeaderFooterContentGeneratorDateFormatYYYYHyphenMMHyphenDD 

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

◆ FSHeaderFooterContentGeneratorPageNumberFormat

Enumeration for page number format type.

Values of this enumeration can be used alone.

Enumerator
FSHeaderFooterContentGeneratorPageNumberFormatDefault 

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

FSHeaderFooterContentGeneratorPageNumberFormatNumberOfCount 

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

FSHeaderFooterContentGeneratorPageNumberFormatNumberSlashCount 

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

FSHeaderFooterContentGeneratorPageNumberFormatPageNumber 

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

FSHeaderFooterContentGeneratorPageNumberFormatPageNumberOfCount 

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

◆ FSHistoryDataSortKey

History data sort by key.

Copyright (C) 2003-2025, Foxit Software Inc.. All Rights Reserved.

http://www.foxitsoftware.com

The following code is copyrighted and is the proprietary of Foxit Software Inc.. It is not allowed to distribute any parts of Foxit PDF SDK for iOS to third party or public without permission unless an agreement is signed between Foxit Software Inc. and customers to explicitly grant customers permissions. Review legal.txt for additional license and legal information.

Enumerator
FSHistoryDataSortKeyDefault 

According to the default key.

FSHistoryDataSortKeyDate 

According to the date.

FSHistoryDataSortKeyChar 

According to the char.

◆ FSHistoryDataSortRule

History data match rules.

Enumerator
FSHistoryDataMatchNormal 

Contains chars.

FSHistoryDataMatchCase 

Case sensitive.

FSHistoryDataMatcConsecutive 

consecutive chars

◆ FSIconFitScaleWayType

Enumeration for the type of icon scaling way.

Values of this enumeration should be used alone.

Enumerator
FSIconFitScaleWayNone 

No scaling way is specified.

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.

◆ FSImageOrientation

Enumeration for image orientation.

Values of this enumeration should be used alone.

Enumerator
FSImageOrientationNone 

No orientation.

FSImageOrientationNormal 

Normal orientation.

FSImageOrientationFlipH 

Flip Horizontal.

FSImageOrientationRotate180 

Rotate 180 degrees in clockwise direction.

FSImageOrientationFlipV 

Flip Vertical.

FSImageOrientationRotate90FlipH 

First rotate 90 in clockwise direction and then flip horizontal.

FSImageOrientationRotate90 

Rotate 90 degrees in clockwise direction.

FSImageOrientationRotate270FlipH 

First rotate 90 in counter-clockwise direction and then flip horizontal.

FSImageOrientationRotate270 

Rotate 90 degrees in counter-clockwise direction.

◆ FSImageSettingsImageCompressMode

Enumeration for compression mode used for color or gray image.

Values of this enumeration should be used alone.

Enumerator
FSImageSettingsImageCompressHigh 

Compression mode: high.

FSImageSettingsImageCompressjpeg 

Compression mode: jpeg.

FSImageSettingsImageCompressjpeg2000 

Compression mode: jpeg2000.

FSImageSettingsImageCompressRetain 

Compression mode: retain, which means no compression.

◆ FSImageSettingsImageCompressQuality

Enumeration for loss compression quality used for color or gray image.

Values of this enumeration should be used alone.

Enumerator
FSImageSettingsImageCompressQualityMinimum 

Compression quality: Minimum.

FSImageSettingsImageCompressQualityLow 

Compression quality: Low.

FSImageSettingsImageCompressQualityMedium 

Compression quality: Medium.

FSImageSettingsImageCompressQualityHigh 

Compression quality: High.

FSImageSettingsImageCompressQualityMaximum 

Compression quality: Maximum.

◆ FSImageSettingsStretchMode

Enumeration for stretch mode.

Values of this enumeration should be used alone.

Enumerator
FSImageSettingsStretchDefault 

When this is set, that means to do default stretching.

FSImageSettingsStretchOff 

When this is set, that means to do without stretching.

FSImageSettingsStretchInterpol 

When this is set, that means to do interpolation for zooming.

FSImageSettingsStretchDownsample 

When this is set, that means not to do halftone for shrinking or rotating.

FSImageSettingsStretchBicubic 

When this is set, that means to do bicubic interpolation for zooming.

FSImageSettingsStretchNoSmooth 

When this is set, that means not to do any interpolation for stretching.

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

◆ FSInteractiveScene

Interactive scene.

Enumerator
FSInteractiveSceneUndefine 

Undefine.

FSInteractiveSceneFillingForms 

When filling out the form.

◆ FSItemContentType

The FSMainToolbarItem content type.

Enumerator
FSItemContentTypeCustom 
FSItemContentTypeImage 
FSItemContentTypeText 
FSItemContentTypeImageAndText 

◆ 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

◆ FSLocaleID

enum FSLocaleID

Enumeration for locale ID.

Values of this enumeration can be used alone.

Enumerator
FSLocaleIDUnspecified 

Locale ID: Unspecified, used when locale is not specified.

FSLocaleIDHongKong 

Locale ID for region: HongKong.

FSLocaleIDTaiwan 

Locale ID for region: Taiwan.

FSLocaleIDNetherlands 

Locale ID for country: Netherlands.

FSLocaleIDFrance 

Locale ID for country: France.

FSLocaleIDGermany 

Locale ID for country: Germany.

FSLocaleIDItaly 

Locale ID for country: Italy.

FSLocaleIDKorea 

Locale ID for country: Korea.

FSLocaleIDJapan 

Locale ID for country: Japan.

◆ FSLTVVerifierTimeType

Enumeration for time type.

Values of this enumeration should be used alone.

Enumerator
FSLTVVerifierSignatureCreationTime 

Use signature creation time.

FSLTVVerifierSignatureTSTTime 

Use the time of signature time stamp token.

FSLTVVerifierCurrentTime 

Use current time.

FSLTVVerifierVRICreationTime 

Use the creation time of VRI dictionary of a signature.

Note
VRI means "validation-related information".

◆ FSLTVVerifierVerifyMode

Enumeration for verifying mode.

Values of this enumeration should be used alone.

Enumerator
FSLTVVerifierVerifyModeAcrobat 

Use Acrobat validation process.

◆ FSMainToolbarItemPosition

The item is in the bar.

Enumerator
FSMainToolbarItemPositionLeft 

The item is on the left.

FSMainToolbarItemPositionCenter 

The item is on the center.

FSMainToolbarItemPositionRight 

The item is on the right.

◆ FSMainToolbarItemType

Defines existing-supplied images for main tool bar items..

Enumerator
FSMainToolbarItemTypeUnknown 

The unknown item.

FSMainToolbarItemTypeBack 

The bark item.

FSMainToolbarItemTypeMore 

The more item.

FSMainToolbarItemTypeSearch 

The search item.

FSMainToolbarItemTypePan 

The pan item.

FSMainToolbarItemTypeAddTool 

The add tool item.

FSMainToolbarItemTypeRedo 

The redo item.

FSMainToolbarItemTypeUndo 

The undo item.

FSMainToolbarItemTypeProperty 

The property item.

FSMainToolbarItemTypeMultiSelect 

The multi-select item.

FSMainToolbarItemTypeDivide 

The divide item.

FSMainToolbarItemTypePanel 

The panel item.

FSMainToolbarItemTypeViewSettings 

The view settings item.

FSMainToolbarItemTypeThumbnail 

The Thumbnai item.

FSMainToolbarItemTypeReadingBookmark 

The bookmark item.

FSMainToolbarItemTypeSortTool 

The sort tool item.

◆ FSMainTopbarToolTag

The tool tag.

Enumerator
FSMainTopbarToolTagHome 

The home tag.

FSMainTopbarToolTagEdit 

The edit tag.

FSMainTopbarToolTagComment 

The comment tag.

FSMainTopbarToolTagDrawing 

The drawing tag.

FSMainTopbarToolTagView 

The view tag.

FSMainTopbarToolTagForm 

The form tag.

FSMainTopbarToolTagSign 

The sign tag.

FSMainTopbarToolTagProtect 

The protect tag.

FSMainTopbarToolTagCustom 

The custom tag.

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

◆ FSMarkupMeasureType

Enumeration for annotation's measure type.

Values of this enumeration should be used alone.

Enumerator
FSMarkupMeasureTypeX 

Measurement of change along the x axis.

FSMarkupMeasureTypeY 

Measurement of change along the y axis.

FSMarkupMeasureTypeD 

Measurement of distance in any direction.

FSMarkupMeasureTypeA 

Measurement of area.

FSMarkupMeasureTypeT 

Measurement of angles.

FSMarkupMeasureTypeS 

Measurement of the slope of a line.

◆ FSMarkupState

Enumeration for markup annotation's state.

Values of this enumeration should be used alone.

Enumerator
FSMarkupStateNone 

(Used with state model FSMarkupStateModelReview) The user has indicated nothing about the change.

FSMarkupStateMarked 

(Used with state model FSMarkupStateModelMarked) The annotation has been marked by the user.

FSMarkupStateUnmarked 

(Used with state model FSMarkupStateModelMarked) The annotation has not been marked by the user.

FSMarkupStateAccepted 

(Used with state model FSMarkupStateModelReview) The user agrees with the change.

FSMarkupStateRejected 

(Used with state model FSMarkupStateModelReview) The user disagrees with the change.

FSMarkupStateCancelled 

(Used with state model FSMarkupStateModelReview) The change has been cancelled.

FSMarkupStateCompleted 

(Used with state model FSMarkupStateModelReview) The change has been completed.

FSMarkupStateDeferred 

(Used with state model FSMarkupStateModelReview) The change has been deferred.

FSMarkupStateFuture 

(Used with state model FSMarkupStateModelReview) The change will be working in the future.

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

◆ FSMeasurementUnits

Enumeration for measurement units of page size information.

Values of this enumeration should be used alone.

Enumerator
FSMeasurementInch 

Inch.

FSMeasurementCM 

Centermeters.

FSMeasurementMM 

Millimeters.

◆ FSMediaSettingsPlayerWindowType

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

Values of this enumeration should be used alone.

Enumerator
FSMediaSettingsPlayerWindowTypeDockedPage 

Window type: a docked page window.

FSMediaSettingsPlayerWindowTypeFloating 

Window type: a floating window.

FSMediaSettingsPlayerWindowTypeFullScreen 

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

◆ FSMenuControlScene

The scene of menucontrol show.

Enumerator
FSMenuControlSceneSelectedText 

The scene of menucontrol show for selected text.

The scene of menucontrol show for clicked in blank space.

The scene of menucontrol show for clicked in blank space.

FSMenuControlSceneBlankSpace 

◆ FSMenuViewType

Copyright (C) 2003-2025, Foxit Software Inc.. All Rights Reserved.

http://www.foxitsoftware.com

The following code is copyrighted and is the proprietary of Foxit Software Inc.. It is not allowed to distribute any parts of Foxit PDF SDK for iOS to third party or public without permission unless an agreement is signed between Foxit Software Inc. and customers to explicitly grant customers permissions. Review legal.txt for additional license and legal information.

Enumerator
FSMenuViewTypeThumbnailInsertBlankPagePop 

The thumbnail controller clicks on the insertBlankPage pop-up view.

Extraction controller

Extraction controller

FSMenuViewTypeExtract 

Save as controller.

FSMenuViewTypeSaveAs 

View security permission.

FSMenuViewTypeViewSecurityPermission 

Unsupported type.

FSMenuViewTypeUnsupported 

◆ FSModuleName

Enumeration for module name which is used in license information.

Values of this enumeration should be used alone.

Enumerator
FSModuleNameConnectedPDF 

(Reserved, currently, this module is not provided) Name for module "ConnectedPDF".

FSModuleNameXFA 

Name for module "XFA".

FSModuleNameRedaction 

Name for module "Redaction".

FSModuleNameRMS 

Name for module "RMS".

FSModuleNameOCR 

Name for module "OCR".

FSModuleNameComparison 

Name for module "Comparison".

FSModuleNameCompliance 

Name for module "Compliance".

FSModuleNameOptimizer 

Name for module "Optimizer".

FSModuleNameConversion 

Name for module "Conversion".

FSModuleNameLayoutRecognition 

(Reserved, currently, this module is not provided) Name for module "LayoutRecognition".

FSModuleNameAccessibility 

Name for module "Accessibility".

FSModuleNameTableMaker 

Name for module "TableMaker".

FSModuleNameDWG2PDF 

Name for module "DWG2PDF".

FSModuleNameAdvEdit 

Name for module "AdvEdit".

FSModuleNamePDF2Office 

Name for module "PDF2Office".

FSModuleName3D 

Name for module "3D".

FSModuleNameOFD 

Name for module "OFD".

FSModuleNameOffice2PDF 

Name for module "Office2PDF".

FSModuleNamePrint2PDF 

Name for module "Print2PDF".

◆ FSMonoImageSettingsMonoImageCompressMode

Enumeration for compression mode used for monochrome image.

Values of this enumeration should be used alone.

Enumerator
FSMonoImageSettingsImageCompressCCITT3 

Compression mode: CCITT Group 3.

FSMonoImageSettingsImageCompressCCITT4 

Compression mode: CCITT Group 4.

FSMonoImageSettingsImageCompressHigh 

Compression mode: high.

FSMonoImageSettingsImageCompressjbig2 

Compression mode: jbig2.

FSMonoImageSettingsImageCompressRetain 

Compression mode: retain, which means no compression.

FSMonoImageSettingsImageCompressRunLength 

Compression mode: run-length.

◆ FSMonoImageSettingsMonoImageCompressQuality

Enumeration for compression quality used for monochrome image.

Values of this enumeration should be used alone.

Enumerator
FSMonoImageSettingsImageCompressQualityLossless 

Compression quality: Lossless.

FSMonoImageSettingsImageCompressQualityLossy 

Compression quality: Lossy.

◆ FSMonoImageSettingsStretchMode

Enumeration for stretch mode.

Values of this enumeration should be used alone.

Enumerator
FSMonoImageSettingsStretchDefault 

When this is set, that means to do default stretching.

FSMonoImageSettingsStretchOff 

When this is set, that means to do without stretching.

FSMonoImageSettingsStretchInterpol 

When this is set, that means to do interpolation for zooming.

FSMonoImageSettingsStretchDownsample 

When this is set, that means not to do halftone for shrinking or rotating.

FSMonoImageSettingsStretchBicubic 

When this is set, that means to do bicubic interpolation for zooming.

FSMonoImageSettingsStretchNoSmooth 

When this is set, that means not to do any interpolation for stretching.

◆ FSNightColorMode

Enumerator
FSNightColorModeDefault 

Night color mode: defaul.

Night color mode: mapping gray

Night color mode: mapping gray

FSNightColorModeMappingGray 

◆ FSOptimizerSettingsCleanUpOptions

Enumeration for cleaning up options.

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

Enumerator
FSOptimizerSettingsCleanUpUseFlateForNonEncodedStream 

Use Flate to encode streams that are not encoded.

FSOptimizerSettingsCleanUpUseFlateInsteadOfLZW 

In streams that use LZW encoding, use Flate instead.

FSOptimizerSettingsCleanUpRemoveInvalidBookmarks 

Remove invalid bookmarks.

FSOptimizerSettingsCleanUpRemoveInvalidLinks 

Remove invalid links.

◆ FSOptimizerSettingsDiscardObjectsOptions

Enumeration for discarding objects options.

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

Enumerator
FSOptimizerSettingsDiscardObjectsFormActions 

Discard all form submission, import and reset actions.

FSOptimizerSettingsDiscardObjectsFlattenFormFields 

Flatten form fields.

FSOptimizerSettingsDiscardObjectsJavaScriptActions 

Discard all JavaScript actions.

Currently, it can not remove the javascript action in "OpenAction" of catalog.

FSOptimizerSettingsDiscardObjectsEmbeddedPageThumbnails 

Discard embedded page thumbnails.

FSOptimizerSettingsDiscardObjectsEmbeddedPrintSettings 

Discard embedded print settings.

FSOptimizerSettingsDiscardObjectsBookmarks 

Discard bookmarks.

FSOptimizerSettingsDiscardObjectsAlternateImages 

Discard all alternate images.

Some PDF documents include multiple versions of the same image for different purposes, such as low-resolution on-screen viewing and high-resolution printing. If this option value is set to be used, that means to remove all versions of an image except the one destined for on-screen viewing.

FSOptimizerSettingsDiscardObjectsDocumentTags 

Discard document tags.

FSOptimizerSettingsDiscardObjectsEmbeddedSearchIndex 

Discard embedded search index.

◆ FSOptimizerSettingsDiscardUserDataOptions

Enumeration for discarding user data options.

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

Enumerator
FSOptimizerSettingsDiscardUserDataAllAnnotsFormsAndMultimedia 

Discard all annotations, forms and multimedia.

FSOptimizerSettingsDiscardUserDataExternalCrossReferences 

Discard external cross references.

FSOptimizerSettingsDiscardUserDataDocumentInfoAndMetaData 

Discard document information and metadata.

FSOptimizerSettingsDiscardUserDataFileAttchments 

Discard file attachments.

FSOptimizerSettingsDiscardUserDataPrivateDataOfOtherApp 

Discard private data of other applications.

FSOptimizerSettingsDiscardUserDataLayer 

Discard hidden layer content and flatten visible layers.

◆ FSOptimizerSettingsOptimizerOptions

Enumeration for optimizer options.

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

Enumerator
FSOptimizerSettingsOptimizerCompressImages 

Optimize PDF document by compressing images.

FSOptimizerSettingsOptimizerCleanUp 

Optimize PDF document by cleaning up.

FSOptimizerSettingsOptimizerDiscardObjects 

Optimize PDF document by discarding objects.

FSOptimizerSettingsOptimizerUnembeddedFonts 

Optimize PDF document by unembedding some embedded fonts.

FSOptimizerSettingsOptimizerDiscardUserData 

Optimize PDF document by discarding user data.

◆ FSOutputPreviewColorantType

Enumeration for colorant type.

Values of this enumeration should be used alone.

Enumerator
FSOutputPreviewColorantTypeProcess 

Colorant type: process.

FSOutputPreviewColorantTypeSpot 

Colorant type: spot.

◆ FSOutputPreviewShowType

Enumeration for show type.

Values of this enumeration should be used alone.

Enumerator
FSOutputPreviewShowAll 

If set, show all.

FSOutputPreviewShowDeviceCMYK 

If set, only show with DeviceCMYK.

FSOutputPreviewShowNotDeviceCMYK 

If set, only show without DeviceCMYK.

FSOutputPreviewShowICCBasedCMYK 

If set, only show with ICCBased CMYK.

FSOutputPreviewShowSpotColor 

If set, only show with spot color.

FSOutputPreviewShowDeviceCMYKAndSpot 

If set, only show with DeviceCMYK and spot.

FSOutputPreviewShowNotDeviceCMYKOrSpot 

If set, only show with DeviceCMYK or spot.

FSOutputPreviewShowDeviceN 

If set, only show with DeviceN.

FSOutputPreviewShowCMYK 

If set, only show with CMYK.

FSOutputPreviewShowRGB 

If set, only show with RGB.

FSOutputPreviewShowDeviceRGB 

If set, only show with DeviceRGB.

FSOutputPreviewShowICCBasedRGB 

If set, only show with ICCBased RGB.

FSOutputPreviewShowGray 

If set, only show with Gray.

FSOutputPreviewShowDeviceGray 

If set, only show with DeviceGray.

FSOutputPreviewShowCalGray 

If set, only show with CalGray.

FSOutputPreviewShowCalibrated 

If set, only show with Calibrated.

FSOutputPreviewShowLab 

If set, only show with Lab.

FSOutputPreviewShowDevice 

If set, only show with Device.

FSOutputPreviewShowImages 

If set, only show images.

FSOutputPreviewShowSolidColor 

If set, only show solid color.

FSOutputPreviewShowSmoothShades 

If set, only show smooth shades.

FSOutputPreviewShowRegistrationColor 

If set, only show registration color.

FSOutputPreviewShowText 

If set, only show text.

FSOutputPreviewShowLineArt 

If set, only show line art.

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

◆ FSPagingSealConfigPagingSealPosition

Enumeration for paging seal position.

Values of this enumeration should be used alone.

Enumerator
FSPagingSealConfigPagingSealPositionLeft 

Left Paging Seal.

FSPagingSealConfigPagingSealPositionRight 

Right Paging Seal.

FSPagingSealConfigPagingSealPositionTop 

Top Paging Seal.

FSPagingSealConfigPagingSealPositionBottom 

Bottom Paging Seal.

◆ FSPagingSealConfigPagingSealStyle

Enumeration for paging seal signature style.

Values of this enumeration should be used alone.

Enumerator
FSPagingSealConfigPagingSealStyleMultipleSignatures 

Add multiple signatures. Use the FSSignature to display the appearance of paging seal signature, and these signatures share the same signature data.

FSPagingSealConfigPagingSealStyleOneSignature 

Only add one signature. This signature is used for signature and verification and will be hidden in the PDF document. Use the FSPagingSeal annotation to display the appearance of paging seal signature.

◆ FSPagingSealSignaturePagingSealAPState

Enumeration for paging seal signature state to set appearance.

Values of this enumeration should be used alone.

Enumerator
FSPagingSealSignaturePagingSealAPStateUnknown 

Unknown signature.

FSPagingSealSignaturePagingSealAPStateUnsigned 

Unsigned signature.

FSPagingSealSignaturePagingSealAPStateSigned 

Signed signature.

FSPagingSealSignaturePagingSealAPStateValid 

Verification state of a signature is valid.

FSPagingSealSignaturePagingSealAPStateInvalid 

Verification state of a signature is invalid.

◆ FSPanelType

Panel types.

Enumerator
FSPanelTypeAnnotation 

Annotation panel type.

FSPanelTypeAttachment 

Attachment panel type.

FSPanelTypeOutline 

Outline panel type.

FSPanelTypeReadingBookmark 

Reading bookmark panel type.

FSPanelTypeDigitalSignature 

Reading digital signature panel type.

FSPanelTypeCustom 

Custom panel type.

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

◆ 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 

(Reserved, currently, this value is not used.) Encryption type: Foxit connected PDF DRM encryption.

◆ FSPDFDocExtractPagesOptions

Enumeration for options used for extracting pages.

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

Enumerator
FSPDFDocExtractPagesOptionAnnotation 

If set, that means annotations related to extracted pages will be extracted as well.

FSPDFDocExtractPagesOptionStructureTree 

If set, that means structure tree will be extracted as well.

FSPDFDocExtractPagesOptionJavascript 

If set, that means Javascript will be extracted as well.

FSPDFDocExtractPagesOptionOCProperties 

If set, that means OCProperties will be extracted as well.

FSPDFDocExtractPagesOptionObjectStream 

If set, that means to use FSPDFDocSaveFlagXRefStream saving flag for the result file in order to reduce the size of result file.

FSPDFDocExtractPagesOptionAttachFiles 

If set, that means attachment files will be extracted as well.

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

◆ FSPDFDocInsertDocOptions

Enumeration for options used for inserting a PDF document to another.

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

Enumerator
FSPDFDocInsertDocOptionAttachments 

If set, that means attachments will be inserted to target document as well.

◆ 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 combined with flag PDFDoc::e_SaveFlagNoUpdatingMetadataDateTime.

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 except FSPDFDocSaveFlagNoUpdatingMetadataDateTime.. This can only be used for function FSPDFDoc::saveAs: or FSPDFDoc::startSaveAs:.

FSPDFDocSaveFlagRemoveRedundantObjects 

Save document with removing redundant PDF objects.

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

FSPDFDocSaveFlagNoUpdatingMetadataDateTime 

Save document without updating metadata "ModDate" and "CreationDate".

This can be used alone or be combined with other saving flags. This can only be used for function FSPDFDoc::saveAs: and FSPDFDoc::startSaveAs:.

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

FSPDFNameTreePages 

"Pages" name tree.

FSPDFNameTreeTemplates 

"Templates" 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.

◆ FSPDFScanToolbarType

Copyright (C) 2003-2025, Foxit Software Inc.. All Rights Reserved.

http://www.foxitsoftware.com

The following code is copyrighted and is the proprietary of Foxit Software Inc.. It is not allowed to distribute any parts of Foxit PDF SDK for iOS to third party or public without permission unless an agreement is signed between Foxit Software Inc. and customers to explicitly grant customers permissions. Review legal.txt for additional license and legal information.

Enumerator
FSPDFScanToolbarTypeBottombar 

The bottom toolbar of document editing viewcontroller.

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

◆ FSPermissionState

Copyright (C) 2003-2025, Foxit Software Inc.. All Rights Reserved.

http://www.foxitsoftware.com

The following code is copyrighted and is the proprietary of Foxit Software Inc.. It is not allowed to distribute any parts of Foxit PDF SDK for iOS to third party or public without permission unless an agreement is signed between Foxit Software Inc. and customers to explicitly grant customers permissions. Review legal.txt for additional license and legal information.

Enumerator
FSPermissionStateShow 

The permission state is to show.

The permission state is no permission

The permission state is no permission

FSPermissionStateNo 

The permission state is to hide.

FSPermissionStateHide 

◆ FSPortfolioInitialViewMode

Enumeration for initial view mode for a portfolio PDF document.

Values of this enumeration should be used alone.

Enumerator
FSPortfolioInitialViewUnknownMode 

Unknown initial view mode.

FSPortfolioInitialViewDetailMode 

Initial view mode: details mode, with all information (specified by schema fields) presented in a multicolumn format.

Note
This mode provides the most information to the user.
FSPortfolioInitialViewTileMode 

Initial view mode: tile mode, with each file and folder node denoted by a small icon and a subset of information (specified by schema fields).

Note
This mode provides top-level information about embedded files to the user.
FSPortfolioInitialViewHidden 

Initial view mode: hidden mode.

◆ FSPortfolioNodeType

Enumeration for portfolio node type.

Values of this enumeration should be used alone.

Enumerator
FSPortfolioNodeTypeUnknown 

Unknown portfolio node type.

FSPortfolioNodeTypeFolder 

Portfolio node type: folder.

FSPortfolioNodeTypeFile 

Portfolio node type: file.

◆ FSPrintDeviceSettingDataOrientationFlag

Enumeration for specifying the orientation of the printer.

Values of this enumeration should be used alone.

Enumerator
FSPrintDeviceSettingDataPortrait 

Portrait orientation for printing.

FSPrintDeviceSettingDataLandscape 

Landscape orientation for printing.

◆ FSPrintParamsBookletBinding

Enumeration for the values used to determine the duplex printing mode when printing a booklet.

Values of this enumeration should be used alone.

Enumerator
FSPrintParamsBookletBindingRight 

Booklet Binding: Left-side binding for Western-style left-to-right reading direction. The paper is folded on the short side.

FSPrintParamsBookletBindingLeft 

Booklet Binding: Right-side binding for text with right-to-left reading direction or Japanese-style vertical writing. The paper is folded on the short side.

FSPrintParamsBookletBindingLeftTall 

Booklet Binding: Left-side binding for Western-style left-to-right reading direction. The paper is folded on the long side producing long and narrow pages.

FSPrintParamsBookletBindingRightTall 

Booklet Binding: Right-side binding for text with right-to-left reading direction or Japanese-style vertical writing. The paper is folded on the long side producing long and narrow pages.

◆ FSPrintParamsBookletDuplexMode

Enumeration for the values used to determine the duplex printing mode when printing a booklet.

Values of this enumeration should be used alone.

Enumerator
FSPrintParamsBookletDuplexModeBothSides 

Booklet Duplex Mode: automatically prints both sides of the paper.

FSPrintParamsBookletDuplexModeFrontSideOnly 

Booklet Duplex Mode: only prints all pages that appear on the front side of the paper.

FSPrintParamsBookletDuplexModeBackSideOnly 

Booklet Duplex Mode: only prints all pages that appear on the back side of the paper.

◆ FSPrintParamsDuplexType

Enumeration for the values used to set the printing duplex mode.

Values of this enumeration should be used alone.

Enumerator
FSPrintParamsDuplexTypeSimplex 

Duplex type: prints on one side of the paper.

FSPrintParamsDuplexTypeDuplexFlipLongEdge 

Duplex type: prints on both sides of the paper; the paper flips along the long edge.

FSPrintParamsDuplexTypeDuplexFlipShortEdge 

Duplex type: prints on both sides of the paper; the paper flips along the short edge.

◆ FSPrintParamsPageOrder

Enumeration for the values used to determine how the multiple pages are laid out on the sheet.

Values of this enumeration should be used alone.

Enumerator
FSPrintParamsPageOrderHorizontal 

Page Order type: pages are placed from left to right, from top to bottom.

FSPrintParamsPageOrderHorizontalReversed 

Page Order type: pages are placed from right to left, from top to bottom.

FSPrintParamsPageOrderVertical 

Page Order type: pages are placed from top to bottom, from left to right.

◆ FSPrintParamsPrintContent

Enumeration for the values used to set the contents of the print job.

Values of this enumeration should be used alone.

Enumerator
FSPrintParamsPrintContentDocument 

Print Content: print the document contents, not comments.

FSPrintParamsPrintContentDocAndAnnots 

Print Content: print the document contents and comments.

FSPrintParamsPrintContentFormFieldsOnly 

Print Content: print the contents of form fields only. Useful for printing onto pre-preprinted forms.

◆ FSPrintParamsPrintHandling

Enumeration for the values used to determine how the multiple pages are laid out on the sheet.

Values of this enumeration should be used alone.

Enumerator
FSPrintParamsPrintHandlingNone 

Print Handling: No page scaling is applied.

FSPrintParamsPrintHandlingFitPaper 

Print Handling: Pages are enlarged or shrunk to fit the printe's paper.

FSPrintParamsPrintHandlingReducePaper 

Print Handling: Small pages are printed small, and large pages are shrunk to fit on the printer's paper.

FSPrintParamsPrintHandlingMultiplePages 

Print Handling: Pages are rescaled to print multiple pages on each printer page.

FSPrintParamsPrintHandlingTileLargePages 

Print Handling: Small or normal pages are printed in the original size and large pages are printed on multiple sheets of paper.

FSPrintParamsPrintHandlingBooklet 

Print Handling: Prints multiple pages on the same sheet of paper in the order required to read correctly when folded.

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

◆ FSReadToolbarItemType

The read tool item type.

Enumerator
FSReadToolbarItemTypeExist 

This item is an existing type.

FSReadToolbarItemTypeCustom 

This item is custom type.

◆ FSReadToolSettingsType

The read tool settings type.

Copyright (C) 2003-2025, Foxit Software Inc.. All Rights Reserved.

http://www.foxitsoftware.com

The following code is copyrighted and is the proprietary of Foxit Software Inc.. It is not allowed to distribute any parts of Foxit PDF SDK for iOS to third party or public without permission unless an agreement is signed between Foxit Software Inc. and customers to explicitly grant customers permissions. Review legal.txt for additional license and legal information.

Enumerator
FSReadToolSettingsTypeText 

The text tool settings.

FSReadToolSettingsTypeImage 

The image tool settings.

FSReadToolSettingsTypeAudio 

The audio tool settings.

FSReadToolSettingsTypeVideo 

The video tool settings.

FSReadToolSettingsTypeLink 

The link tool settings.

FSReadToolSettingsTypeNote 

The note tool settings.

FSReadToolSettingsTypeAttachments 

The attachments tool settings.

FSReadToolSettingsTypeStamp 

The stamp tool settings.

FSReadToolSettingsTypeTypewriter 

The typewriter tool settings.

FSReadToolSettingsTypeTextbox 

The textbox tool settings.

FSReadToolSettingsTypeCallout 

The callout tool settings.

FSReadToolSettingsTypeHighlight 

The highlight tool settings.

FSReadToolSettingsTypeUnderline 

The underline tool settings.

FSReadToolSettingsTypeSquiggly 

The squiggly tool settings.

FSReadToolSettingsTypeStrikeout 

The strikeout tool settings.

FSReadToolSettingsTypeReplaceText 

The replace text tool settings.

FSReadToolSettingsTypeInsertText 

The insert text tool settings.

FSReadToolSettingsTypeAreaHighlight 

The area highlight tool settings.

FSReadToolSettingsTypeMeasure 

The measure tool settings.

FSReadToolSettingsTypeImageAnnotation 

The image annotation tool settings.

FSReadToolSettingsTypePencil 

The pencil tool settings.

FSReadToolSettingsTypeHighlighter 

The highlighter tool settings.

FSReadToolSettingsTypeEraser 

The eraser tool settings.

FSReadToolSettingsTypeRectangle 

The rectangele tool settings.

FSReadToolSettingsTypeOval 

The oval tool settings.

FSReadToolSettingsTypeLine 

The line tool settings.

FSReadToolSettingsTypeArrow 

The arrow tool settings.

FSReadToolSettingsTypePolygon 

The polygon tool settings.

FSReadToolSettingsTypePolyLine 

The polyLine tool settings.

FSReadToolSettingsTypeCloud 

The cloud tool settings.

FSReadToolSettingsTypeTextField 

The text filed tool settings.

FSReadToolSettingsTypeCheckBox 

The check box tool settings.

FSReadToolSettingsTypeRadioButton 

The radio button tool settings.

FSReadToolSettingsTypeComboBox 

The combo box tool settings.

FSReadToolSettingsTypeListBox 

The list box tool settings.

FSReadToolSettingsTypeSignatureField 

The signature field tool settings.

FSReadToolSettingsTypeImageField 

The image field tool settings.

FSReadToolSettingsTypeFillSignText 

The fill sign text tool settings.

FSReadToolSettingsTypeFillSignSegText 

The fill sign seg text tool settings.

FSReadToolSettingsTypeFillSignProfile 

The fill sign profile text tool settings.

FSReadToolSettingsTypeFillSignCheckMark 

The fill sign check mark tool settings.

FSReadToolSettingsTypeFillSignCrossMark 

The fill sign cross mark tool settings.

FSReadToolSettingsTypeFillSignDot 

The fill sign sign dot tool settings.

FSReadToolSettingsTypeFillSignLine 

The fill sign line tool settings.

FSReadToolSettingsTypeFillSignRoundRectangle 

The fill sign round rectangle tool settings.

FSReadToolSettingsTypeDigitalSignature 

The digital signature tool settings.

FSReadToolSettingsTypeRedact 

The redact tool settings.

FSReadToolSettingsTypePassWord 

The PassWord tool settings.

FSReadToolSettingsTypeTrutedCertificates 

The TrutedCertificates tool settings.

FSReadToolSettingsTypeRMS 

The RMS tool settings.

FSReadToolSettingsTypeAIP 

The AIP tool settings.

FSReadToolSettingsTypeViewSingle 
FSReadToolSettingsTypeViewDay 
FSReadToolSettingsTypeViewColor 
FSReadToolSettingsTypeViewFitPage 
FSReadToolSettingsTypeViewFitWidth 
FSReadToolSettingsTypeViewReflow 
FSReadToolSettingsTypeViewCrop 
FSReadToolSettingsTypeViewSpeak 
FSReadToolSettingsTypeViewAutoFlip 
FSReadToolSettingsTypeViewRotate 
FSReadToolSettingsTypeViewPanZoom 

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

FSRendererColorModeMappingGray 

Map gray/white/black color value to background/foreground; for other colors, no change.

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.

◆ FSResponseResponseType

Enumeration for response type.

Values of this enumeration should be used alone.

Enumerator
FSResponseTypeNone 

No response.

FSResponseTypeCRL 

CRL response.

FSResponseTypeOCSP 

OCSP response.

◆ FSRichTextStyleCornerMarkStyle

Enumeration for corner mark style.

Values of this enumeration should be used alone.

Enumerator
FSRichTextStyleCornerMarkNone 

Corner mark style: none.

FSRichTextStyleCornerMarkSuperscript 

Corner mark style: superscript.

FSRichTextStyleCornerMarkSubscript 

Corner mark style: subscript.

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

◆ FSRotationPointOptions

Enumeration for rotation point options.

Values of this enumeration indicate the reference point for rotation. Each value should be used separately.

Enumerator
FSRotationPointCenter 

Rotate the text block based on the center point.

FSRotationPointLeftTop 

Rotate the text block based on the left-top point of the rectangle.

FSRotationPointRightTop 

Rotate the text block based on the right-top point of the rectangle.

FSRotationPointLeftBottom 

Rotate the text block based on the left-bottom point of the rectangle.

FSRotationPointRightBottom 

Rotate the text block based on the right-bottom point of the rectangle.

◆ FSScanCameraControllerItemType

Copyright (C) 2003-2025, Foxit Software Inc.. All Rights Reserved.

http://www.foxitsoftware.com

The following code is copyrighted and is the proprietary of Foxit Software Inc.. It is not allowed to distribute any parts of Foxit PDF SDK for iOS to third party or public without permission unless an agreement is signed between Foxit Software Inc. and customers to explicitly grant customers permissions. Review legal.txt for additional license and legal information.

Enumerator
FSScanCameraControllerItemTypeFlashLight 

The Flash of light item in the top bar of camera viewcontroller.

The Single shooting item in the top bar of camera viewcontroller.

The Single shooting item in the top bar of camera viewcontroller.

FSScanCameraControllerItemTypeSingleShooting 

The photos item in the top bar of camera viewcontroller.

FSScanCameraControllerItemTypePhotos 

The auto dection item in the top bar of camera viewcontroller.

FSScanCameraControllerItemTypeAutoDection 

The format pagesize item in the top bar of camera viewcontroller.

FSScanCameraControllerItemTypeFormatPageSize 

◆ FSSearchOptionWordMatching

Enumeration for word matching.

Values of this enumeration should be used alone.

Enumerator
FSSearchOptionWordMatchingMatchPhrase 

Word matching: match phrase.

FSSearchOptionWordMatchingMatchAllWords 

Word matching: match all words.

FSSearchOptionWordMatchingMatchAnyWord 

Word matching: match any word.

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

FSSignatureAPFlagFoxitEditorFlag 

If set, show Foxit Editor content on signature appearance.

FSSignatureAPFlagProducer 

If set, show producer 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.

◆ FSSignatureDocPermission

Enumeration for signature document permission.

Values of this enumeration should be used alone.

Enumerator
FSSignatureDocPermUnrestricted 

No restriction.

FSSignatureDocPermNoChangesAllowed 

No changes to the PDF document (which is signed by the signture) are permitted. Any change to this kind of PDF document will invalidate the signature.

FSSignatureDocPermFillingFormAndSigning 

Permitted changes are filling in forms, instantiating page templates, and signing. Other changes will invalidate the signature.

FSSignatureDocPermFillingFormSigningAndAnnotating 

Permitted changes are the same as for 2, as well as annotation creation, deletion, and modification. Other changes will invalidate the signature.

◆ FSSignatureFieldMDPAction

Enumeration for signature FieldMDP("MDP" means modification detection and prevention) action type.

Values of this enumeration should be used alone.

Enumerator
FSSignatureFieldMDPActionNone 

No Field MDP action.

FSSignatureFieldMDPActionAll 

All form fields' flags will be set read-only.

FSSignatureFieldMDPActionInclude 

Specified form fields' flags will be set read-only.

Note
"Specified form fields" can be get/set by functions FSSignature::getFieldMDPActionFields and FSSignature::setFieldMDPActionFields:field_array:. Please refer to these functions for more details.
FSSignatureFieldMDPActionExclude 

Flags of form fields (except specified form fields) will be set read-only.

Note
"Specified form fields" can be get/set by functions FSSignature::getFieldMDPActionFields and FSSignature::setFieldMDPActionFields:field_array:. Please refer to these functions for more details.

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

FSSignatureKeyNameProducer 

Signature key name: producer content.

◆ FSSignatureLabelName

Enumeration for signature label name.

Values of this enumeration should be used alone.

Enumerator
FSSignatureLabelNameSigner 

Signature label name for signer.

Note
Default label name for signer is "Digitally signed by " in Foxit PDF SDK.
FSSignatureLabelNameLocation 

Signature label name for location.

Note
Default label name for location is "Location: " in Foxit PDF SDK.
FSSignatureLabelNameReason 

Signature label name for reason.

Note
Default label name for reason is "Reason: " in Foxit PDF SDK.
FSSignatureLabelNameSignTime 

Signature label name for sign time.

Note
Default label name for sign time is "Date: " in Foxit PDF SDK.
FSSignatureLabelNameDN 

Signature key name for distinguish name.

Note
Default label name for distinguish name is "DN: " in Foxit PDF SDK.
FSSignatureLabelNameProducer 

Signature key name for producer name.

Note
Default label name for producer name is empty in Foxit PDF SDK.

◆ FSSignaturePAdESLevel

Enumeration for PAdES level.

Values of this enumeration should be used alone.

Enumerator
FSSignaturePAdESLevelNotPAdES 

Not a PAdES signature.

FSSignaturePAdESLevelNone 

PAdES level: none.

FSSignaturePAdESLevelBB 

PAdES level: B-B.

FSSignaturePAdESLevelBT 

PAdES level: B-T.

FSSignaturePAdESLevelBLT 

PAdES level: B-LT.

FSSignaturePAdESLevelBLTA 

PAdES level: B-LTA.

◆ FSSignatureSignatureType

Enumeration for signature type.

Values of this enumeration should be used alone.

Enumerator
FSSignatureSignatureTypeOrdinary 

Signature type: ordinary.

FSSignatureSignatureTypeTimeStamp 

Signature type: time stamp.

FSSignatureSignatureTypePagingSeal 

Signature type: paging seal.

◆ 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.It means that there is not "V" entry in the signature dictionary.

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. (This indicates that signature is invalid.)

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 time stamp or not check time stamp.

FSSignatureStateVerifyTimestampDoc 

The signature is a time stamp signature.

FSSignatureStateVerifyTimestampValid 

Verification state of the time stamp is valid.

FSSignatureStateVerifyTimestampInvalid 

Verification state of the time stamp is invalid.

FSSignatureStateVerifyTimestampExpire 

Verification state of the time stamp is expired.

FSSignatureStateVerifyTimestampIssueUnknown 

Verification state of the time stamp issuer is unknown.

FSSignatureStateVerifyTimestampIssueValid 

Verification state of the time stamp issuer is valid.

FSSignatureStateVerifyTimestampTimeBefore 

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

FSSignatureStateCertCannotGetVRI 

Cannot get verify relevant information.

FSSignatureStateVerifyChangeLegal 

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

FSSignatureStateVerifyChangeIllegal 

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

◆ FSSignatureVerifyResultLTVState

Enumeration for LTV state that indicates if a signature is a LTV signature.

Values of this enumeration should be used alone.

Enumerator
FSSignatureVerifyResultLTVStateInactive 

This means LTV is inactive.

FSSignatureVerifyResultLTVStateEnable 

This means LTV is enabled.

FSSignatureVerifyResultLTVStateNotEnable 

This means LTV is not enabled.

◆ FSSoundSampleEncodingFormat

Enumeration for encoding format of sound sample data.

Values of this enumeration must be used alone.

Enumerator
FSSoundSampleEncodingFormatRaw 

Unspecified or unsigned values in the range 0 to (2^B - 1).

FSSoundSampleEncodingFormatSigned 

Twos-complement values.

FSSoundSampleEncodingFormatMuLaw 

μ-law-encoded samples

FSSoundSampleEncodingFormatALaw 

A-law-encoded samples.

◆ FSStdSecurityHandlerModifyFlag

(Only for AES-256) Enumeration for modify flag used to decide which security data or password will be modified during encryption process

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

Enumerator
FSStdSecurityHandlerModifyPermission 

If set, user permissions and "is encrypt metadata" values (which are defined in FSStdEncryptData ) will be modified during encryption process.

FSStdSecurityHandlerModifyUserPassword 

If set, user password and owner password will be modified during encryption process.

FSStdSecurityHandlerModifyOwnerPassword 

If set, only owner password will be modified during encryption process.

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

◆ FSTextPageCharInfoTextCharFlag

Enumeration for PDF textpage character flag.

Values of this enumeration should be used alone.

Enumerator
FSTextPageCharInfoUnknown 

Character flag: Unknown.

FSTextPageCharInfoNormal 

Character flag: Normal.

FSTextPageCharInfoGenerated 

Character flag: Generated.

FSTextPageCharInfoUnUnicode 

Character flag: UnUnicode.

FSTextPageCharInfoHyphen 

Character flag: Hyphen.

FSTextPageCharInfoComboWord 

Character flag: ComboWord.

◆ FSTextPageTextOrderFlag

Enumeration for text order flag which is used when getting text content of a PDF page.

Values of this enumeration can be used alone.

Enumerator
FSTextPageTextStreamOrder 

If this is set, that means to get text content of a PDF page by the stream order.

FSTextPageTextDisplayOrder 

If this is set, that means to get text content of a PDF page by the display order.

◆ FSTextPageTextParseFlags

Enumeration for parsing flags used for text page.

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

Enumerator
FSTextPageParseTextNormal 

Parse the text content of a PDF page by normalizing characters based on their positions in the PDF 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".

FSTextSearchSearchNotMatchFullWidth 

If set, to ignore full-width characters and treat all characters as standard ASCII or standard-width characters during searches.

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

◆ FSTiledWatermarkSettingsFlags

Enumeration for tiled watermark setting flags.

Enumeration for watermark setting flags.

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

Values of this enumeration can be used alone or in combination. For more details about form xobjects, please refer to Section 4.9 "Form XObjects" in <PDF Reference 1.7>.

Enumerator
FSTiledWatermarkSettingsFlagAsPageContents 

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

FSTiledWatermarkSettingsFlagAsAnnot 

If set, the watermark will be an annotation when inserted to a PDF page, and the watermark will be show above other content.

FSTiledWatermarkSettingsFlagOnTop 

If set, show watermark above other page content.

FSTiledWatermarkSettingsFlagNoPrint 

If set, do not print a watermark.

FSTiledWatermarkSettingsFlagInvisible 

If set, do not display a watermark.

◆ FSTimeStampServerSendRequestResult

Enumeration for the result of sending time stamp request.

Values of this enumeration should be used alone.

Enumerator
FSTimeStampServerSendResultSuccess 

Send request successfully.

FSTimeStampServerSendResultFailToCreateSocket 

Fail to create socket during sending request process.

FSTimeStampServerSendResultFailToConnect 

Fail to connect during sending request process.

FSTimeStampServerSendResultFailToSendData 

Fail to send data during sending request process.

FSTimeStampServerSendResultFailToReceiveData 

Fail to receive data during sending request process.

FSTimeStampServerSendResultFailToRequest 

Fail to request during sending request process.

FSTimeStampServerSendResultFailToGetData 

Fail to get data during sending request process.

FSTimeStampServerSendResultOutOfMemory 

Out of memory during sending request process.

◆ FSToolbarType

Panel types.

Enumerator
FSTopBar 

The top tool bar.

FSBottomBar 

The bottom tool bar.

◆ FSTopbarSubitemContentViewPosition

The subbar is in the bar.

Enumeration for watermark position in a PDF page.

Values of this enumeration should be used alone.

Enumerator
FSTopbarSubitemContentViewPositionTop 

The subbar is on the top.

FSTopbarSubitemContentViewPositionLeft 

The subbar is on the left.

FSTopbarSubitemContentViewPositionRight 

The subbar is on the right.

◆ FSUIElementType

ui emlement types.

Enumerator
FSUIElementReadingPanel 

The FSUIElementReadingPanel.

FSUIElementReadingPanelBookmark 

The FSUIElementReadingPanelBookmark.

FSUIElementReadingPanelOutline 

The FSUIElementReadingPanelOutline.

FSUIElementReadingPanelComment 

The FSUIElementReadingPanelComment.

FSUIElementReadingPanelAttachment 

The FSUIElementReadingPanelAttachment.

FSUIElementReadingPanelDigitalSignature 

The FSUIElementReadingPanelDigitalSignature.

FSUIElementReadingView 

The FSUIElementReadingView.

FSUIElementReadingViewSinglePage 

The FSUIElementReadingViewSinglePage.

FSUIElementReadingViewFacing 

The FSUIElementReadingViewFacing.

FSUIElementReadingViewCoverFacing 

The FSUIElementReadingViewCoverFacing.

FSUIElementReadingViewDay 

The FSUIElementReadingViewDay.

FSUIElementReadingViewNight 

The FSUIElementReadingViewNight.

FSUIElementReadingViewPageColor 

The FSUIElementReadingViewPageColor.

FSUIElementReadingViewContinuousScrolling 

The FSUIElementReadingViewContinuousScrolling.

FSUIElementReadingViewFitPage 

The FSUIElementReadingViewFitPage.

FSUIElementReadingViewFitWidth 

The FSUIElementReadingViewFitWidth.

FSUIElementReadingViewReflow 

The FSUIElementReadingViewReflow.

FSUIElementReadingViewCropMode 

The FSUIElementReadingViewCropMode.

FSUIElementReadingViewSpeak 

The FSUIElementReadingViewSpeak.

FSUIElementReadingViewAutoFlip 

The FSUIElementReadingViewAutoFlip.

FSUIElementReadingViewRotateView 

The FSUIElementReadingViewRotateView.

FSUIElementReadingViewPanZoom 

The FSUIElementReadingViewPanZoom.

FSUIElementReadingViewPageRTL 

The FSUIElementReadingViewPageRTL.

FSUIElementReadingThumbnial 

The FSUIElementReadingThumbnial.

FSUIElementReadingBookmark 

The FSUIElementReadingBookmark.

FSUIElementReadingShare 

The FSUIElementReadingShare.

FSUIElementReadingRecentList 

The FSUIElementReadingRecentList.

FSUIElementReadingToolsTabHome 

The FSUIElementReadingToolsTabHome.

FSUIElementReadingToolsTabEdit 

The FSUIElementReadingToolsTabEdit.

FSUIElementReadingToolsTabComment 

The FSUIElementReadingToolsTabComment.

FSUIElementReadingToolsTabDrawing 

The FSUIElementReadingToolsTabDrawing.

FSUIElementReadingToolsTabView 

The FSUIElementReadingToolsTabView.

FSUIElementReadingToolsTabForm 

The FSUIElementReadingToolsTabForm.

FSUIElementReadingToolsTabFillSign 

The FSUIElementReadingToolsTabFillSign.

FSUIElementReadingHomeBarAddTools 

The FSUIElementReadingHomeBarAddTools.

FSUIElementReadingToolbarMultipleSelection 

The FSUIElementReadingToolbarMultipleSelection.

FSUIElementReadingEditBarText 

The FSUIElementReadingEditBarText.

FSUIElementReadingEditBarImage 

The FSUIElementReadingEditBarImage.

FSUIElementReadingEditBarAudio 

The FSUIElementReadingEditBarAudio.

FSUIElementReadingEditBarVideo 

The FSUIElementReadingEditBarVideo.

FSUIElementReadingCommentBarNote 

The FSUIElementReadingCommentBarNote.

FSUIElementReadingCommentBarAttachment 

The FSUIElementReadingCommentBarAttachment.

FSUIElementReadingCommentBarStamp 

The FSUIElementReadingCommentBarStamp.

FSUIElementReadingCommentBarTypeWriter 

The FSUIElementReadingCommentBarTypeWriter.

FSUIElementReadingCommentBarCallout 

The FSUIElementReadingCommentBarCallout.

FSUIElementReadingCommentBarTextbox 

The FSUIElementReadingCommentBarTextbox.

FSUIElementReadingCommentBarHighlight 

The FSUIElementReadingCommentBarHighlight.

FSUIElementReadingCommentBarUnderline 

The FSUIElementReadingCommentBarUnderline.

FSUIElementReadingCommentBarSquiggly 

The FSUIElementReadingCommentBarSquiggly.

FSUIElementReadingCommentBarStrikeout 

The FSUIElementReadingCommentBarStrikeout.

FSUIElementReadingCommentBarInsertText 

The FSUIElementReadingCommentBarInsertText.

FSUIElementReadingCommentBarReplaceText 

The FSUIElementReadingCommentBarReplaceText.

FSUIElementReadingCommentBarAreaHighlight 

The FSUIElementReadingCommentBarAreaHighlight.

FSUIElementReadingCommentBarDistance 

The FSUIElementReadingCommentBarDistance.

FSUIElementReadingCommentBarImage 

The FSUIElementReadingCommentBarImage.

FSUIElementReadingDrawingBarPencil 

The FSUIElementReadingDrawingBarPencil.

FSUIElementReadingDrawingBarHighlight 

The FSUIElementReadingDrawingBarHighlight.

FSUIElementReadingDrawingBarEraser 

The FSUIElementReadingDrawingBarEraser.

FSUIElementReadingDrawingBarRectangle 

The FSUIElementReadingDrawingBarRectangle.

FSUIElementReadingDrawingBarOval 

The FSUIElementReadingDrawingBarOval.

FSUIElementReadingDrawingBarLine 

The FSUIElementReadingDrawingBarLine.

FSUIElementReadingDrawingBarArrow 

The FSUIElementReadingDrawingBarArrow.

FSUIElementReadingDrawingBarPolyline 

The FSUIElementReadingDrawingBarPolyline.

FSUIElementReadingDrawingBarPolygon 

The FSUIElementReadingDrawingBarPolygon.

FSUIElementReadingDrawingBarCloud 

The FSUIElementReadingDrawingBarCloud.

FSUIElementReadingFormBarTextField 

The FSUIElementReadingFormBarTextField.

FSUIElementReadingFormBarCheckBox 

The FSUIElementReadingFormBarCheckBox.

FSUIElementReadingFormBarRadioButton 

The FSUIElementReadingFormBarRadioButton.

FSUIElementReadingFormBarListBox 

The FSUIElementReadingFormBarListBox.

FSUIElementReadingFormBarComboBox 

The FSUIElementReadingFormBarComboBox.

FSUIElementReadingFormBarSignatureField 

The FSUIElementReadingFormBarSignatureField.

FSUIElementReadingFormBarImageField 

The FSUIElementReadingFormBarImageField.

FSUIElementReadingFormBarReset 

The FSUIElementReadingFormBarReset.

FSUIElementReadingAnnotPopMenuAppearance 

The FSUIElementReadingAnnotPopMenuAppearance.

FSUIElementReadingAnnotPopMenuDelete 

The FSUIElementReadingAnnotPopMenuDelete.

FSUIElementReadingFillSignTypeWriter 

The FSUIElementReadingFillSignTypeWriter.

FSUIElementReadingFillSignComboText 

The FSUIElementReadingFillSignComboText.

FSUIElementReadingFillSignV 

The FSUIElementReadingFillSignV.

FSUIElementReadingFillSignX 

The FSUIElementReadingFillSignX.

FSUIElementReadingFillSignDot 

The FSUIElementReadingFillSignDot.

FSUIElementReadingFillSignRectangle 

The FSUIElementReadingFillSignRectangle.

FSUIElementReadingFillSignLine 

The FSUIElementReadingFillSignLine.

FSUIElementReadingFillSignPredefined 

The FSUIElementReadingFillSignPredefined.

FSUIElementReadingFillSignSign 

The FSUIElementReadingFillSignSign.

FSUIElementReadingSearch 

The FSUIElementReadingSearch.

FSUIElementReadingMoreFileProperty 

The FSUIElementReadingMoreFileProperty.

FSUIElementReadingMoreProtectRedaction 

The FSUIElementReadingMoreProtectRedaction.

FSUIElementReadingMoreProtectFileEncryption 

The FSUIElementReadingMoreProtectFileEncryption.

FSUIElementReadingMoreProtectTrustedCertificates 

The FSUIElementReadingMoreProtectTrustedCertificates.

FSUIElementReadingMoreProtectCertificateProtect 

The FSUIElementReadingMoreProtectCertificateProtect.

FSUIElementReadingMoreProtectRMSProtect 

The FSUIElementReadingMoreProtectRMSProtect.

FSUIElementReadingMoreCommentFieldImortComments 

The FSUIElementReadingMoreCommentFieldImortComments.

FSUIElementReadingMoreCommentFieldExportComments 

The FSUIElementReadingMoreCommentFieldExportComments.

FSUIElementReadingMoreCommentFieldSummarizeComments 

The FSUIElementReadingMoreCommentFieldSummarizeComments.

FSUIElementReadingMoreCommentFieldExportHighlightedText 

The FSUIElementReadingMoreCommentFieldExportHighlightedText.

FSUIElementReadingMoreCommentFieldResetFormFields 

The FSUIElementReadingMoreCommentFieldResetFormFields.

FSUIElementReadingMoreCommentFieldImportFormFields 

The FSUIElementReadingMoreCommentFieldImportFormFields.

FSUIElementReadingMoreCommentFieldExportFormFields 

The FSUIElementReadingMoreCommentFieldExportFormFields.

FSUIElementReadingMoreSaveAs 

The FSUIElementReadingMoreSaveAs.

FSUIElementReadingMoreExportPDF 

The FSUIElementReadingMoreExportPDF.

FSUIElementReadingMoreReduceFileSize 

The FSUIElementReadingMoreReduceFileSize.

FSUIElementReadingMoreTags 

The FSUIElementReadingMoreTags.

FSUIElementReadingMorePrint 

The FSUIElementReadingMorePrint.

FSUIElementReadingMoreFlatten 

The FSUIElementReadingMoreFlatten.

FSUIElementReadingMoreScreenCapture 

The FSUIElementReadingMoreScreenCapture.

FSUIElementReadingLongPressComment 

The FSUIElementReadingLongPressComment.

FSUIElementReadingLongPressRedaction 

The FSUIElementReadingLongPressRedaction.

FSUIElementReadingLongPressSign 

The FSUIElementReadingLongPressSign.

FSUIElementReadingLongPressCopyText 

The FSUIElementReadingLongPressCopyText.

FSUIElementReadingLongPressHighlight 

The FSUIElementReadingLongPressHighlight.

FSUIElementReadingLongPressUnderline 

The FSUIElementReadingLongPressUnderline.

FSUIElementReadingLongPressStrikeout 

The FSUIElementReadingLongPressStrikeout.

FSUIElementReadingLongPressSquiggly 

The FSUIElementReadingLongPressSquiggly.

FSUIElementReadingLongPressSpeak 

The FSUIElementReadingLongPressSpeak.

FSUIElementReadingGotoPage 

The FSUIElementReadingGotoPage.

FSUIElementReadingFullScreenBookmark 

The FSUIElementReadingFullScreenBookmark.

FSUIElementReadingFullScreenToolbar 

The FSUIElementReadingFullScreenToolbar.

FSUIElementReadingFullScreenToolbarDrag 

The FSUIElementReadingFullScreenToolbarDrag.

FSUIElementReadingToolbarDrag 

The FSUIElementReadingToolbarDrag.

FSUIElementReadingFreeTrial 

The FSUIElementReadingFreeTrial.

FSUIElementReadingInkRecognitionText 

◆ FSUIManagerState

States of extensions manager.

Enumerator
FSUIManagerStateNormal 

tag of normal ui state

tag of reflow ui state

tag of reflow ui state

FSUIManagerStateReflow 

tag of search ui state

FSUIManagerStateSearch 

tag of annottool ui state

FSUIManagerStateAnnotTool 

tag of panandzoom state

FSUIManagerStatePanZoom 

tag of create form state

FSUIManagerStateCreateForm 

tag of panandzoom state

FSUIManagerStateSpeech 

tag of fill sign state

FSUIManagerStateFillSign 

tag of auto flip

FSUIManagerStateAutoFlip 

tag of redaction ui state

FSUIManagerStateRedaction 

tag of redaction pdf comparision

FSUIManagerStateComparision 

tag of editor state

FSUIManagerStateEditor 

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

◆ FSWidgetLineSpacingStyle

Enumeration for line spacing style.

Values of this enumeration should be used alone.

Enumerator
FSWidgetLineSpacingSingle 

Line spacing style: single line spacing.

FSWidgetLineSpacingOneAndHalf 

Line spacing style: one and half times line spacing.

FSWidgetLineSpacingDouble 

Line spacing style: double line spacing.

FSWidgetLineSpacingExactValue 

Line spacing style: exact value line spacing.

FSWidgetLineSpacingAuto 

Line spacing style: auto line spacing.

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

◆ FSXFAWidgetWidgetEdgePosition

Enumeration for the positon of XFA widget edge position.

Values of this enumeration should be used alone.

Enumerator
FSXFAWidgetWidgetEdgePositionTop 

Egde position: top.

FSXFAWidgetWidgetEdgePositionRight 

Egde position: right.

FSXFAWidgetWidgetEdgePositionBottom 

Egde position: bottom.

FSXFAWidgetWidgetEdgePositionLeft 

Egde position: left.

◆ FSXFAWidgetWidgetHAlignType

Enumeration for the type of text horizontal alignment of XFA widget.

Values of this enumeration should be used alone.

Enumerator
FSXFAWidgetWidgethAlignTypeCenter 

Center the text horizontally within the available region.

FSXFAWidgetWidgethAlignTypeJustify 

Left-align the last line and spread-justify the rest.

FSXFAWidgetWidgethAlignTypeJustifyAll 

Spread-justify all lines to fill the available region.

FSXFAWidgetWidgethAlignTypeLeft 

Align the text to the left edge of the available region.

FSXFAWidgetWidgethAlignTypeRadix 

Align the radix indicator.

FSXFAWidgetWidgethAlignTypeRight 

Align the text to the right edge of the available region.

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

FSXFAWidgetWidgetNameTypeFullName 

Name type: full name.

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

FSXFAWidgetWidgetTypeImage 

XFA widget type: image.

◆ FSXFAWidgetWidgetVAlignType

Enumeration for the type of text vertical alignment of XFA widget.

Values of this enumeration should be used alone.

Enumerator
FSXFAWidgetWidgetvAlignTypeTop 

Align the text to the top of the available region.

FSXFAWidgetWidgetvAlignTypeBottom 

Align the text to the bottom of the available region.

FSXFAWidgetWidgetvAlignTypeMiddle 

Align the text so that it is centered between the top and bottom of the available region.

◆ PDF_CERT_ERROR_CODE

Enumeration for certificate related error code.

Enumerator
PDF_CERT_ERROR_SUCESSS 
PDF_CERT_ERROR_FILE 

File format error or invalid file.

PDF_CERT_ERROR_PASSWORD 

Invalid password.

◆ PDF_CROP_MODE

Enumeration for page crop mode.

Values of this enumeration should be used alone.

Enumerator
PDF_CROP_MODE_NONE 

No crop.

PDF_CROP_MODE_CONTENTSBOX 

Crop margin according to bounding box of all contents.

PDF_CROP_MODE_DETECTION 

Crop margin by detecting paths or images.

PDF_CROP_MODE_CUSTOMIZED 

Crop margin with specified pages & rects.

◆ PDF_DISPLAY_ZOOMMODE

Enumeration for PDF display zoom mode.

Values of this enumeration should be used alone.

Enumerator
PDF_DISPLAY_ZOOMMODE_UNKNOWN 

Zoom mode: unknown.

PDF_DISPLAY_ZOOMMODE_FITPAGE 

Zoom mode: fit page.

PDF_DISPLAY_ZOOMMODE_FITWIDTH 

Zoom mode: fit page width.

PDF_DISPLAY_ZOOMMODE_FITHEIGHT 

Zoom mode: fit page height.

◆ PDF_LAYOUT_MODE

Enumeration for PDF layout mode.

Values of this enumeration should be used alone.

Enumerator
PDF_LAYOUT_MODE_UNKNOWN 

Unknown page mode.

PDF_LAYOUT_MODE_SINGLE 

Single page mode.

PDF_LAYOUT_MODE_TWO 

Facing mode.

PDF_LAYOUT_MODE_REFLOW 

Reflow mode.

PDF_LAYOUT_MODE_TWO_LEFT 

Facing mode. Cover page left.

PDF_LAYOUT_MODE_TWO_RIGHT 

Facing mode. Cover page right.

PDF_LAYOUT_MODE_TWO_MIDDLE 

Facing mode. Cover page middle.

◆ PDF_PAGE_BINDING_EDGE

Enumeration for page binding edge.

Values of this enumeration should be used alone..

Enumerator
PDF_PAGE_BINDING_UNKNOWN 

The document doesn’t explicitly define a page binding, so the behavior is the same as it is with LEFT_EDGE or RIGHT_EDGE.

The document doesn’t explicitly define a page binding, so the behavior is the same as it is with LEFT_EDGE or RIGHT_EDGE.

PDF_PAGE_BINDING_LEFT_EDGE 

The document flows from left to right.

The document flows from left to right.

PDF_PAGE_BINDING_RIGHT_EDGE 

The document flows from right to left.

The document flows from right to left.

◆ PDF_PAGE_STYLE_TYPE

Enumeration for page style direction.

Enumerator
PDF_PAGE_STYLE_TYPE_BLANK 

Insert page blank style.

PDF_PAGE_STYLE_TYPE_LINED 

Insert page lined style.

PDF_PAGE_STYLE_TYPE_GRID 

Insert page grid style.

PDF_PAGE_STYLE_TYPE_GRAPH 

Insert page graph style.

PDF_PAGE_STYLE_TYPE_MUSIC 

Insert page music style.

◆ PDF_REFLOW_REFLOWMODE

Enumeration for page reflow mode.

Values of this enumeration should be used alone.

Enumerator
PDF_REFLOW_NONE 

No reflow.

PDF_REFLOW_WITHIMAGE 

Reflow both text and image on PDF page.

PDF_REFLOW_ONLYTEXT 

Reflow just text on PDF page.

◆ PDFScanMenuViewType

Copyright (C) 2003-2025, Foxit Software Inc.. All Rights Reserved.

http://www.foxitsoftware.com

The following code is copyrighted and is the proprietary of Foxit Software Inc.. It is not allowed to distribute any parts of Foxit PDF SDK for iOS to third party or public without permission unless an agreement is signed between Foxit Software Inc. and customers to explicitly grant customers permissions. Review legal.txt for additional license and legal information.

Enumerator
PDFScanMenuViewTypeThumbnailInsertBlankPagePop 

The thumbnail controller clicks on the insertBlankPage pop-up view.

Extraction controller.

Extraction controller.

PDFScanMenuViewTypeExtract 

Save as controller.

PDFScanMenuViewTypeSaveAs 

◆ SettingItemType

Enumeration for item types in setting bar.

Values of this enumeration should be used alone.

Enumerator
SINGLE 

Single page layout button.

DOUBLEPAGE 

Double page layout button.

COVERPAGE 

Cover page layout button.

DAYMODE 

Day mode button.

PAGECOLOR 

Page color mode button.

NIGHTMODE 

Night mode button.

CONTINUOUS 

Continuous page layout button.

PAGERTL 

Page from right to left button.

FITPAGE 

Fitpage button.

FITWIDTH 

Fitwidth button.

REFLOW 

Reflow button.

CROPPAGE 

Crop page button.

SPEECH 

Speak button.

AUTOFLIP 

Auto flip button.

ROTATE 

rotate button.

PANZOOM 

Pan&zoom button.