Foxit PDF SDK

Classes | Variables
FSDK Namespace Reference

Foxit PDF SDK namespace. More...

## Classes
class | Action
class | ActionCallback
class | AdditionalAction
class | Annot
class | AnnotArray
class | AnnotationSummary
class | AnnotationSummaryCallback
class | AnnotationSummarySettings
class | ApplyRedactionCallback
class | AppProviderCallback
class | AssociatedFiles
class | AsyncReaderCallback
class | Attachments
class | AuditSpaceSize
class | Barcode
class | Bitmap
class | Bookmark
class | BorderInfo
class | ButtonItem
class | Caret
class | CertChainResolverCallback
class | CertificateEncryptData
class | CertificateSecurityCallback
class | CertificateSecurityHandler
class | CertIssuerPair
class | CertVerifyResult
class | CertVerifyResultArray
class | ChoiceOption
class | ChoiceOptionArray
class | Circle
class | Codec
class | Color
class | ColorSpace
class | ColorState
class | Combination
class | CombineDocumentInfo
class | CombineDocumentInfoArray
class | CompareResultInfo
class | CompareResultInfoArray
class | CompareResults
class | Comparison
class | ComplianceEngine
class | Control
class | Convert
class | ConvertCallback
class | ConvertCheckCallback
class | CustomEncryptData
class | CustomSecurityCallback
class | CustomSecurityHandler
class | DateTime
class | DefaultAppearance
class | Destination
class | DialogDescriptionConfig
class | DialogDescriptionElement
class | DialogDescriptionElementArray
class | DocEventCallback
class | DocProviderCallback
class | DocumentsSource
class | DocViewerPrefs
class | DRMEncryptData
class | DRMSecurityCallback
class | DRMSecurityHandler
class | DWG2PDFProgressCallback
class | DWG2PDFSettingData
class | EmbeddedFontData
class | EmbeddedGotoAction
class | EmbeddedGotoTarget
class | Excel2PDFConfig
class | Excel2PDFSettingData
class | FDFDoc
class | Field
class | FieldArray
class | FileAttachment
class | FileReaderCallback
class | FileSpec
class | FileWriterCallback
class | Filler
class | FillerAssistCallback
class | FillSign
class | FillSignObject
class | FindOption
class | FixupData
class | FloatArray
class | FloatingInfo
class | Font
class | FontMapperCallback
class | FontMapResult
class | Form
class | FormCombination
class | FormFileInfo
class | FormFileInfoArray
class | FormXObject
class | FreeText
class | FSFloatFArray
| An array of float values. More...
class | FullTextSearch
class | GotoAction
class | GraphicsObject
class | GraphicsObjectArray
class | GraphicsObjects
class | GraphState
class | HeaderFooter
class | HeaderFooterContent
class | HeaderFooterContentGenerator
class | HiddenInfoSettingData
| Configuration settings for removing hidden or sensitive data from a PDF document. More...
class | HideAction
class | Highlight
class | HitData
class | HTML2PDFRelatedResource
class | HTML2PDFRelatedResourceArray
class | HTML2PDFSettingData
class | IconFit
class | IconProviderCallback
class | IdentityProperties
class | Image
class | ImageCompressionCallback
class | ImageObject
class | ImageSettings
class | ImportDataAction
class | Ink
class | Int32Array
class | JavaScriptAction
class | JavascriptModifyItemInfo
class | JoinSplit
class | LaunchAction
class | LayerContext
class | LayerNode
class | LayerNodeArray
class | LayerPrintData
class | LayerTree
class | LayerZoomData
class | Library
class | Line
class | Link
class | LRContentElement
class | LRContext
class | LRElement
class | LRGraphicsObjectElement
class | LRStructureElement
class | LTVVerifier
class | MarkedContent
class | Markup
class | MarkupArray
class | Matrix2D
class | MediaPlayer
class | MediaPlayerCallback
class | MediaSettings
class | MenuItemConfig
class | MenuItemEx
class | MenuItemExArray
class | MenuList
class | MenuListArray
class | Metadata
class | MonoImageSettings
class | NamedAction
class | Note
class | NoteArray
class | NotifierCallback
class | OCR
class | OCRCallback
class | OCRConfig
class | OCREngine
class | OCRProgressCallback
class | OCRSettingData
class | OCRSettingDataArray
class | OCRSuspectInfo
class | OCRSuspectInfoArray
class | OFDConvertParam
class | OFDDoc
class | OFDPage
class | OFDRenderer
class | Office2PDF
class | Office2PDFSettingData
class | Optimizer
class | OptimizerSettings
class | OptimizeScannedPDFSettings
class | OutputPreview
class | PageBasicInfo
class | PageBasicInfoArray
class | PageLabels
class | PageNumberRange
class | PageTextLinks
class | PagingSeal
class | PagingSealConfig
class | PagingSealSignature
class | ParagraphEditing
class | ParagraphEditingMgr
class | ParagraphEditingProviderCallback
class | ParagraphEditingUndoItem
class | Path
class | PathArray
class | PathObject
class | PauseCallback
class | PayLoadData
class | PDF2ExcelSettingData
class | PDF2Office
class | PDF2OfficeSettingData
class | PDF2PowerPointSettingData
class | PDF2WordSettingData
class | PDFACompliance
class | PDFArray
class | PDFDictionary
class | PDFDictionaryArray
class | PDFDoc
class | PDFECompliance
class | PDFNameTree
class | PDFNumberTree
class | PDFObject
class | PDFPage
class | PDFStream
class | PDFStructTree
class | PDFXCompliance
class | PlayerArgs
class | Point
class | PointF
class | PointFArray
class | Polygon
class | PolyLine
class | Popup
class | Portfolio
class | PortfolioFileNode
class | PortfolioFolderNode
class | PortfolioNode
class | PortfolioNodeArray
class | PowerPoint2PDFSettingData
class | Preflight
class | PreflightReportSettingData
class | PreflightSettingData
class | PrintParams
class | ProgressCallback
class | Progressive
class | PSI
class | PSICallback
class | PSInk
class | QuadPoints
class | QuadPointsArray
class | Range
class | ReadingBookmark
class | RectF
class | RectFArray
| An array of RectF objects. More...
class | RectI
class | Redact
class | Redaction
class | ReflowPage
class | RemoteGotoAction
class | RenderConfig
class | Renderer
class | Rendition
class | RenditionAction
class | ReplaceCallback
class | ResetFormAction
class | Response
class | ResultInformation
class | RevocationArrayInfo
class | RevocationCallback
class | RichTextStyle
class | RMSEncryptData
class | RMSSecurityCallback
class | RMSSecurityHandler
class | SchemaField
class | SchemaFieldArray
class | Screen
class | SearchCallback
class | SearchCancelCallback
class | SearchIndexConfig
class | SearchOption
class | SecurityCallback
class | SecurityHandler
class | SetOCGStateAction
class | ShadingColor
class | ShadingObject
class | Signature
class | SignatureArray
class | SignatureCallback
class | SignatureFillSignObject
class | SignatureVerifyResult
class | SignatureVerifyResultArray
class | SnappedPoint
class | SnapPointMgr
class | SOAPAuthenticateInfo
class | SOAPRequestProperties
class | SOAPResponseInfo
class | Sound
class | Square
class | Squiggly
class | Stamp
class | StdEncryptData
class | StdSecurityHandler
class | StreamCallback
| File stream interface, reading & writing. More...
class | StrikeOut
class | StringArray
class | StructElement
class | StructMarkedContent
class | StructObjectContent
class | StructTreeEntity
class | SubmitFormAction
class | TableBorderInfo
class | TableCellData
class | TableCellDataArray
class | TableCellDataColArray
| This class represents an array of FSDK.TableCellData objects,inserted in the order of the displayed table from left to right. More...
class | TableCellIndexArray
| An array of table cell index. More...
class | TableData
class | TableGenerator
class | TableGeneratorCallback
class | TableOfContentsConfig
class | TabOrderMgr
class | TaggedPDF
class | TaggedPDFCallback
class | TextFillSignObject
class | TextFillSignObjectData
class | TextFillSignObjectDataArray
class | TextLink
class | TextMarkup
class | TextObject
class | TextObjectArray
class | TextPage
class | TextPageCharInfo
class | TextSearch
class | TextSearchReplace
class | TextState
class | TiledWatermarkSettings
class | TimeRange
class | TimerCallback
class | TimeStampCallback
class | TimeStampServer
class | TimeStampServerMgr
class | TrustedCertStoreCallback
class | TXT2PDFSettingData
class | UInt32Array
class | Underline
class | UnembeddedFontSettings
class | URIAction
class | Watermark
class | WatermarkSettings
class | WatermarkTextProperties
class | Widget
class | WidgetChoiceOption
class | WidgetChoiceOptionArray
class | WidgetMenu
class | Word2PDFConfig
class | Word2PDFSettingData
class | WrapperData
class | WStringArray
class | XFADoc
class | XFAPage
class | XFAWidget
class | XFAWidgetModifyInfo

## Variables
const | e_AlignmentCenter
| Center alignment.
const | e_AlignmentLeft
| Enumeration for alignment (horizontal). More...
const | e_AlignmentRight
| Right alignment.
const | e_ColorSpaceCalGray
| Color space: CalGray. (1 component, A)
const | e_ColorSpaceCalRGB
| Color space: CalRGB. (3 components, A, B, C)
const | e_ColorSpaceDeviceCMYK
| Color space: DeviceCMYK. (4 components, C, M, Y, K)
const | e_ColorSpaceDeviceGray
| Color space: DeviceGray. (1 component, gray)
const | e_ColorSpaceDeviceN
| Color space: DeviceN.
const | e_ColorSpaceDeviceRGB
| Color space: DeviceRGB. (3 components, R, G, B)
const | e_ColorSpaceICCBasedDeviceCMYK
| Color space: ICCBased DeviceCMYK. (4 components, C, M, Y, K)
const | e_ColorSpaceICCBasedDeviceGray
| Color space: ICCBased DeviceGray. (1 component, gray)
const | e_ColorSpaceICCBasedDeviceRGB
| Color space: ICCBased DeviceRGB. (3 components, R, G, B)
const | e_ColorSpaceInvalid
| Enumeration for color space. More...
const | e_ColorSpaceLab
| Color space: Lab. (3 components, A, B, C)
const | e_ColorSpacePattern
| Color space: Pattern.
const | e_ColorSpaceSeparation
| Color space: Separation.
const | e_ErrCanNotConnectToServer
| (For ConnectedPDF only) Cannot connect to ConnectedPDF server.
const | e_ErrCanNotGetACL
| (For ConnectedPDF only) Cannot get the ACL from ConnectedPDF server.
const | e_ErrCanNotGetClientID
| (For ConnectedPDF only) Cannot get client ID from ConnectedPDF server.
const | e_ErrCanNotGetUserToken
| (For ConnectedPDF only) Cannot get user token from ConnectedPDF server.
const | e_ErrCanNotRemoveSecurityFromServer
| (For ConnectedPDF only) Cannot remove the security from ConnectedPDF server.
const | e_ErrCanNotSetACL
| (For ConnectedPDF only) Cannot set the ACL to ConnectedPDF server.
const | e_ErrCanNotUploadCDRMInfo
| (For ConnectedPDF only) Cannot upload ConnectedPDF DRM document info to ConnectedPDF server.
const | e_ErrCanNotUploadDocInfo
| (For ConnectedPDF only) Cannot upload ConnectedPDF document info to ConnectedPDF server.
const | e_ErrCertificate
| Certificate error: PDF document is encrypted by digital certificate but current user does not have the correct certificate.
const | e_ErrComplianceEngineInitFailed
| (For compliance only) Fail to initialize compliance engine.
const | e_ErrComplianceEngineInvalidUnlockCode
| (For compliance only) Invalid unlock code is used to initialize compliance engine.
const | e_ErrComplianceEngineNotInit
| (For compliance only) Compliance engine has not been initialized successfully.
const | e_ErrComplianceResourceFile
| (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.
const | e_ErrConflict
| New data conflicts with existed data.
const | e_ErrDataNotReady
| Data is not ready. Usually this is used as an exception error code when loading document in asynchronous way.
const | e_ErrDefaultTimeStampServer
| Cannot use current default time stamp server. Please check if default time stamp server can be used.
const | e_ErrDeviceLimitation
| (For ConnectedPDF only) Current device is limited to open the ConnectedPDF DRM document.
const | e_ErrDiskFull
| (For OCR only) Not enough disk space.
const | e_ErrExcelHasNoContent
| (For Excel-to-PDF conversion only) Excel document does not have any content so it cannot be converted to PDF file.
const | e_ErrFile
| File cannot be found or could not be opened.
const | e_ErrFilePathNotExist
| File or folder path does not exist.
const | e_ErrFormat
| Format is invalid. For files, this may also mean that file is corrupted.
const | e_ErrHandle
| Error handle.
const | e_ErrInvalidACL
| (For ConnectedPDF only) Input ACL is invalid.
const | e_ErrInvalidClientID
| (For ConnectedPDF only) Input client ID is invalid.
const | e_ErrInvalidData
| Data of current object is invalid.
const | e_ErrInvalidLicense
| Invalid license is used to initialize Foxit PDF SDK library.
const | e_ErrInvalidRegex
| Invalid regular expression.
const | e_ErrInvalidState
| Invalid or incorrect state.
const | e_ErrInvalidType
| The type of input object or current object is invalid.
const | e_ErrInvalidUserToken
| (For ConnectedPDF only) Input user token is invalid.
const | e_ErrInvalidWrapper
| (For ConnectedPDF only) The input ConnectedPDF DRM wrapper document is invalid.
const | e_ErrIsAlreadyCDRM
| (For ConnectedPDF only) Loaded document is already a ConnectedPDF DRM document.
const | e_ErrIsAlreadyCPDF
| (For ConnectedPDF only) Loaded document is already a ConnectedPDF document.
const | e_ErrLibreofficeEngineNotFound
| (For Office-to-PDF conversion only) Libre office engine is not found.
const | e_ErrLTVCannotCheckDTS
| (For LTV only) Fail to check DTS.
const | e_ErrLTVCannotLoadDSS
| (For LTV only) Fail to load DSS.
const | e_ErrLTVCannotLoadDTS
| (For LTV only) Fail to load DTS.
const | e_ErrLTVCannotSwitchVersion
| (For LTV only) Fail to switch PDF verion.
const | e_ErrLTVRevocationCallbackNotSet
| (For LTV only) Revocation callback for LTV has not been set.
const | e_ErrLTVVerifyModeNotSet
| (For LTV only) LTV verify mode has not been set.
const | e_ErrNeedSigned
| (For signature only) The signature being operated needs to be signed.
const | e_ErrNoAccessibilityModuleRight
| No "Accessibility" module right.
const | e_ErrNoAdvEditModuleRight
| No "AdvEdit" module right.
const | e_ErrNoComparisonModuleRight
| No "Comparison" module right.
const | e_ErrNoComplianceModuleRight
| No "Compliance" module right.
const | e_ErrNoConnectedPDFModuleRight
| No "ConnectedPDF" module right.
const | e_ErrNoConversionModuleRight
| No "Conversion" module right.
const | e_ErrNoDocumentPermission
| No document permission to operate.
const | e_ErrNoDWG2PDFModuleRight
| No "DWG2PDF" module right.
const | e_ErrNoLayoutRecognitionModuleRight
| No "LayoutRecognition" module right.
const | e_ErrNoMicroOfficeInstalled
| (For Office-to-PDF conversion only) No Microsoft Office is installed in current system.
const | e_ErrNoOCRModuleRight
| No "OCR" module right.
const | e_ErrNoOptimizerModuleRight
| No "Optimizer" module right.
const | e_ErrNoPDF2OfficeModuleRight
| No "PDF2Office" module right.
const | e_ErrNoRedactionModuleRight
| No "Redaction" module right.
const | e_ErrNoRights
| (For ConnectedPDF only) Current user has no right to open the ConnectedPDF DRM document.
const | e_ErrNoRMSModuleRight
| No "RMS" module right.
const | e_ErrNoTableMakerModuleRight
| No "TableMaker" module right.
const | e_ErrNotCDRM
| (For ConnectedPDF only) The loaded document is not a ConnectedPDF DRM document.
const | e_ErrNotFound
| Expected data or object is not found.
const | e_ErrNotLoaded
| Current object has not been loaded yet.
const | e_ErrNotParsed
| Content has not been parsed yet. Usually, this represents PDF page has not been parsed yet.
const | e_ErrNoXFAModuleRight
| No "XFA" module right.
const | e_ErrOCREngineNotInit
| (For OCR only) OCR engine has not been initialized successfully.
const | e_ErrOCRTrialIsEnd
| (For OCR only) The trial for OCR module is end.
const | e_ErrODAEngineNotFound
| (For DWG-to-PDF conversion only) ODA engine is not found.
const | e_ErrOFDEngineNotInit
| (For OFD only) OFD engine has not been initialized successfully.
const | e_ErrOfficeComNotInit
| (For Office-to-PDF conversion only) Office COM has not been initialized successfully.
const | e_ErrOutOfMemory
| Out-of-memory error occurs.
const | e_ErrParam
| Parameter error: value of any input parameter for a function is invalid.
const | e_ErrPassword
| 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.
const | e_ErrRightsExpired
| (For ConnectedPDF only) The rights of Current user has expired.
const | e_ErrSecurityHandler
| PDF document is encrypted by some unsupported security handler.
const | e_ErrSuccess
| Success, and no error occurs.
const | e_ErrTimeStampServerMgrNoDefaltServer
| No default server has been set to time stamp server manager yet.
const | e_ErrTimeStampServerMgrNotInit
| Time stamp server manager has not been initialized successfully.
const | e_ErrUnknown
| Any unknown error occurs.
const | e_ErrUnknownState
| Any unknown state occurs.
const | e_ErrUnsupported
| Some types are not supported.
const | e_ErrURLInBlackList
| (For converting html to pdf only) The converted URL is on blacklist.
const | e_ErrWPSEngineNotFound
| (For Office-to-PDF conversion only) WPS office engine is not found.
const | e_ErrXFALoadError
| XFA loading error.
const | e_FileFormatTypeFDF
| Enumeration for file format type. More...
const | e_FileFormatTypeHTML
| File format type: HTML.
const | e_FileFormatTypePDF
| File format type: PDF.
const | e_FileFormatTypeTXT
| File format type: TXT.
const | e_FileFormatTypeXDP
| File format type: XDP.
const | e_FileFormatTypeXFD
| File format type: XFD.
const | e_FileFormatTypeXFDF
| File format type: XFDF.
const | e_FileFormatTypeXML
| File format type: XML.
const | e_FillModeAlternate
| Alternate fill mode, in which the system fills this area between odd-numbered and even-numbered polygon sides on each scan line.
const | e_FillModeNone
| Enumeration for filling mode type, mainly for path graphics object. More...
const | e_FillModeWinding
| Winding fill mode, in which the system uses a direction in which a figure is drawn to determine whether to fill an area.
const | e_LocaleIDFrance
| Locale ID for country: France.
const | e_LocaleIDGermany
| Locale ID for country: Germany.
const | e_LocaleIDHongKong
| Locale ID for region: HongKong.
const | e_LocaleIDItaly
| Locale ID for country: Italy.
const | e_LocaleIDJapan
| Locale ID for country: Japan.
const | e_LocaleIDKorea
| Locale ID for country: Korea.
const | e_LocaleIDNetherlands
| Locale ID for country: Netherlands.
const | e_LocaleIDTaiwan
| Locale ID for region: Taiwan.
const | e_LocaleIDUnspecified
| Enumeration for locale ID. More...
const | e_ModuleNameAccessibility
| Name for module "Accessibility".
const | e_ModuleNameAdvEdit
| Name for module "AdvEdit".
const | e_ModuleNameComparison
| Name for module "Comparison".
const | e_ModuleNameCompliance
| Name for module "Compliance".
const | e_ModuleNameConnectedPDF
| Enumeration for module name which is used in license information. More...
const | e_ModuleNameConversion
| Name for module "Conversion".
const | e_ModuleNameDWG2PDF
| Name for module "DWG2PDF".
const | e_ModuleNameLayoutRecognition
| (Reserved, currently, this module is not provided) Name for module "LayoutRecognition".
const | e_ModuleNameOCR
| Name for module "OCR".
const | e_ModuleNameOptimizer
| Name for module "Optimizer".
const | e_ModuleNamePDF2Office
| Name for module "PDF2Office".
const | e_ModuleNameRedaction
| Name for module "Redaction".
const | e_ModuleNameRMS
| Name for module "RMS".
const | e_ModuleNameTableMaker
| Name for module "TableMaker".
const | e_ModuleNameXFA
| Name for module "XFA".
const | e_PosBottomCenter
| Position: bottom center.
const | e_PosBottomLeft
| Position: bottom left.
const | e_PosBottomRight
| Position: bottom right.
const | e_PosCenter
| Position: center.
const | e_PosCenterLeft
| Position center left.
const | e_PosCenterRight
| Position: center right.
const | e_PosTopCenter
| Position: top center.
const | e_PosTopLeft
| Enumeration for watermark position in a PDF page. More...
const | e_PosTopRight
| Position: top right.
const | e_Rotation0
| Enumeration for rotation. More...
const | e_Rotation180
| Rotate 180 degrees in clockwise direction.
const | e_Rotation270
| Rotate 270 degrees in clockwise direction.
const | e_Rotation90
| Rotate 90 degrees in clockwise direction.
const | e_RotationPointCenter
| Enumeration for rotation point options. More...
const | e_RotationPointLeftBottom
| Rotate the text block based on the left-bottom point of the rectangle.
const | e_RotationPointLeftTop
| Rotate the text block based on the left-top point of the rectangle.
const | e_RotationPointRightBottom
| Rotate the text block based on the right-bottom point of the rectangle.
const | e_RotationPointRightTop
| Rotate the text block based on the right-top point of the rectangle.
const | e_RotationUnknown
| Unknown rotation.

## Detailed Description

Foxit PDF SDK namespace.

## Variable Documentation

## ◆ e_AlignmentLeft

const FSDK.e_AlignmentLeft

Enumeration for alignment (horizontal).

Values of this enumeration should be used alone.

Left alignment.

## ◆ e_ColorSpaceInvalid

const FSDK.e_ColorSpaceInvalid

Enumeration for color space.

Values of this enumeration should be used alone.

Color space: Invalid.

## ◆ e_FileFormatTypeFDF

const FSDK.e_FileFormatTypeFDF

Enumeration for file format type.

Values of this enumeration can be used alone.

File format type: FDF.

## ◆ e_FillModeNone

const FSDK.e_FillModeNone

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

Values of this enumeration should be used alone.

Fill mode: none.

## ◆ e_LocaleIDUnspecified

const FSDK.e_LocaleIDUnspecified

Enumeration for locale ID.

Values of this enumeration can be used alone.

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

## ◆ e_ModuleNameConnectedPDF

const FSDK.e_ModuleNameConnectedPDF

Enumeration for module name which is used in license information.

Values of this enumeration should be used alone.

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

## ◆ e_PosTopLeft

const FSDK.e_PosTopLeft

Enumeration for watermark position in a PDF page.

Values of this enumeration should be used alone.

Position: top left.

## ◆ e_Rotation0

const FSDK.e_Rotation0

Enumeration for rotation.

Values of this enumeration should be used alone.

No rotation.

## ◆ e_RotationPointCenter

const FSDK.e_RotationPointCenter

Enumeration for rotation point options.

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

Rotate the text block based on the center point.