Foxit PDF SDK
fsdk Namespace Reference

fsdk namespace. More...

Classes

class  Action
 
class  ActionCallback
 
class  AdditionalAction
 
class  Annot
 
class  AnnotArray
 
class  AnnotationSummary
 
class  AnnotationSummaryCallback
 
class  AnnotationSummarySettings
 
class  AppProviderCallback
 
class  AssociatedFiles
 
class  AsyncReaderCallback
 
class  Attachments
 
class  AuditSpaceSize
 Structure of audit space, the unit is byte type. More...
 
class  Barcode
 
class  Base
 
class  Bitmap
 
class  Bookmark
 
class  BorderInfo
 
class  ButtonItem
 
class  Caret
 
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  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
 A callback class used for converting DWG to PDF. More...
 
class  DWG2PDFSettingData
 
class  EmbeddedFontData
 
class  EmbeddedGotoAction
 
class  EmbeddedGotoTarget
 
class  Excel2PDFConfig
 
class  Excel2PDFSettingData
 
class  FDFDoc
 
class  Field
 
class  FieldArray
 
class  FileAttachment
 
class  FileSpec
 
class  Filler
 
class  FillerAssistCallback
 
class  FillSign
 
class  FillSignObject
 
class  FindOption
 
class  FloatArray
 An array of float values. More...
 
class  FloatingInfo
 
class  Font
 
class  FontMapperCallback
 
class  FontMapResult
 
class  Form
 
class  FormCombination
 
class  FormFileInfo
 
class  FormFileInfoArray
 
class  FormXObject
 
class  FreeText
 
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  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
 An array of signed integer values. More...
 
class  JavaScriptAction
 
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  MediaPlayer
 
class  MediaPlayerCallback
 
class  MediaSettings
 
class  MenuItemConfig
 
class  MenuItemEx
 
class  MenuList
 
class  MenuListArray
 
class  Metadata
 
class  MonoImageSettings
 
class  NamedAction
 
class  Note
 
class  NoteArray
 
class  NotifierCallback
 
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  PayLoadData
 
class  PDF2ExcelSettingData
 
class  PDF2Office
 
class  PDF2OfficeSettingData
 
class  PDF2PowerPointSettingData
 
class  PDF2WordSettingData
 
class  PDFArray
 
class  PDFDictionary
 
class  PDFDictionaryArray
 
class  PDFDoc
 
class  PDFNameTree
 
class  PDFNumberTree
 
class  PDFObject
 
class  PDFPage
 
class  PDFStream
 
class  PDFStructTree
 
class  PlayerArgs
 
class  PointFArray
 An array of PointF objects. More...
 
class  Polygon
 
class  PolyLine
 
class  Popup
 
class  Portfolio
 
class  PortfolioFileNode
 
class  PortfolioFolderNode
 
class  PortfolioNode
 
class  PortfolioNodeArray
 
class  PowerPoint2PDFSettingData
 
class  PrintDeviceSettingData
 
class  PrintParams
 
class  Progressive
 
class  PSI
 
class  PSICallback
 
class  PSInk
 
class  QuadPoints
 
class  QuadPointsArray
 
class  Range
 
class  ReadingBookmark
 
class  RectFArray
 An array of RectF objects. More...
 
class  Redact
 
class  Redaction
 
class  ReflowPage
 
class  RemoteGotoAction
 
class  RenderConfig
 
class  Renderer
 
class  Rendition
 
class  RenditionAction
 
class  ReplaceCallback
 
class  ResetFormAction
 
class  Response
 
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  SplitDocumentInfo
 
class  SplitDocumentInfoArray
 
class  SplitFileResult
 
class  SplitFileResultArray
 
class  SplitOutputSettingData
 
class  SplitPDFDoc
 
class  SplitPDFDocCallback
 
class  Square
 
class  Squiggly
 
class  Stamp
 
class  StdEncryptData
 
class  StdSecurityHandler
 
class  StrikeOut
 
class  StructElement
 
class  StructMarkedContent
 
class  StructObjectContent
 
class  StructTreeEntity
 
class  SubmitFormAction
 
class  TableBorderInfo
 
class  TableCellData
 
class  TableCellDataArray
 
class  TableCellDataColArray
 This class represents an array of 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
 An array of unsigned integer values. More...
 
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
 

Functions

def ActionCreate ()
 Create a new action, for specified action type. More...
 
def CodecBase64Decode ()
 Decode the encoded data buffer by Base64 algorithm. More...
 
def CodecBase64Encode ()
 Encode the source data buffer by Base64 algorithm. More...
 
def CodecFlateCompress ()
 Compress the source data buffer by DEFLATE algorithm. More...
 
def CodecFlateDecompress ()
 Decompress the compressed data buffer by DEFLATE algorithm. More...
 
def CombinationStartCombineDocuments ()
 Start to combine PDF files. More...
 
def ConvertFromDWG ()
 Convert a DWG format file to a PDF file. More...
 
def ConvertFromExcel ()
 Convert an Excel format file to a PDF file. More...
 
def ConvertFromHTML ()
 Convert a HTML format file or a URL of a Web page to a PDF file. More...
 
def ConvertFromImage ()
 Convert a Image format file to a PDF file. More...
 
def ConvertFromOFD ()
 Convert OFD file to PDF file. More...
 
def ConvertFromPowerPoint ()
 Convert a PowerPoint format file to a PDF file. More...
 
def ConvertFromTXT ()
 Convert a TXT format file to a PDF file. More...
 
def ConvertFromWord ()
 Convert a Word format file to a PDF file. More...
 
def ConvertToOFD ()
 Convert PDF file to OFD file. More...
 
def ConvertToXML ()
 Convert a PDF file to a XML format file. More...
 
def DateTimeGetLocalTime ()
 Get local time. More...
 
def DateTimeGetUTCTime ()
 Get UTC time. More...
 
def DestinationCreateFitBBox ()
 Create a destination object for zoom mode fsdk.DestinationE_ZoomFitBBox . More...
 
def DestinationCreateFitBHorz ()
 Create a destination object for zoom mode fsdk.DestinationE_ZoomFitBHorz . More...
 
def DestinationCreateFitBVert ()
 Create a destination object for zoom mode fsdk.DestinationE_ZoomFitBVert . More...
 
def DestinationCreateFitHorz ()
 Create a destination object for zoom mode fsdk.DestinationE_ZoomFitHorz . More...
 
def DestinationCreateFitPage ()
 Create a destination object for zoom mode fsdk.DestinationE_ZoomFitPage . More...
 
def DestinationCreateFitRect ()
 Create a destination object for zoom mode fsdk.DestinationE_ZoomFitRect . More...
 
def DestinationCreateFitVert ()
 Create a destination object for zoom mode fsdk.DestinationE_ZoomFitVert . More...
 
def DestinationCreateFromPDFArray ()
 Create a destination object from an existing destination array. More...
 
def DestinationCreateXYZ ()
 Create a destination object for zoom mode fsdk.DestinationE_ZoomXYZ . More...
 
def FormCombinationCombineFormsToCSV ()
 Combine form data and export these data to a CSV file. More...
 
def FormXObjectCreate ()
 Create a new form XObject graphics object. More...
 
def ImageObjectCreate ()
 Create a new image graphics object. More...
 
def ImageObjectCreateFromType3TextObject ()
 Create an image graphics object from a type3 text object. More...
 
def LibraryEnableJavaScript ()
 Enable or disable javascript for PDF. More...
 
def LibraryEnableThreadSafety ()
 Enable thread safety. More...
 
def LibraryExecuteJavaScript ()
 Execute javascript. More...
 
def LibraryFlushLog ()
 Flush the log file. More...
 
def LibraryGetRenderConfig ()
 Get the rendering configuration. More...
 
def LibraryGetVersion ()
 Get the version of current Foxit PDF SDK library. More...
 
def LibraryHasModuleLicenseRight ()
 Check if user has right to use a specified module of Foxit PDF SDK in current used license information (which is used to initialize Foxit PDF SDK). More...
 
def LibraryInitialize ()
 Initialize Foxit PDF SDK Library, with valid license information. More...
 
def LibraryInitializeOFDEngine ()
 Initialize OFD engine. More...
 
def LibraryRegisterSecurityCallback ()
 Register a fsdk.SecurityCallback object to Foxit PDF SDK for decryption of the PDFs with special encryption filters. More...
 
def LibraryRegisterSignatureCallback ()
 Register a third-party fsdk.SignatureCallback object to Foxit PDF SDK for signing and verifying signature, along with the filter and sub filter name of the callback. More...
 
def LibraryRegisterXFAAppProviderCallback ()
 Register an fsdk.AppProviderCallback object to Foxit PDF SDK. More...
 
def LibraryReinitialize ()
 Re-initialize Foxit PDF SDK Library. More...
 
def LibraryRelease ()
 Release all resource allocated by Foxit PDF SDK Library. More...
 
def LibraryReleaseOFDEngine ()
 Release OFD engine. More...
 
def LibrarySetActionCallback ()
 Set a fsdk.ActionCallback object to Foxit PDF SDK, in aid of performing PDF actions. More...
 
def LibrarySetAnnotIconProviderCallback ()
 Set a customized fsdk.IconProviderCallback object to Foxit PDF SDK. More...
 
def LibrarySetCacheSize ()
 Set the upper limit of PDF library cache size. More...
 
def LibrarySetDefaultICCProfilesPath ()
 Set path of folder which contains default ICC profile files. More...
 
def LibrarySetDocEventCallback ()
 Set a DocEventCallback object to Foxit PDF SDK. More...
 
def LibrarySetFontMapperCallback ()
 Set a FontMapperCallback object to Foxit PDF SDK. More...
 
def LibrarySetLogFile ()
 Set the log file path. More...
 
def LibrarySetNotifierCallback ()
 Set a NotifierCallback object to Foxit PDF SDK. More...
 
def LibrarySetRenderConfig ()
 Set the rendering configuration. More...
 
def LibrarySetRenderTextGamma ()
 Set gamma value for text rendering. More...
 
def LibrarySetTimeStampCallback ()
 Set a fsdk.TimeStampCallback object to Foxit PDF SDK, in aid of interacting with time stamp server. More...
 
def LibraryUnregisterSecurityCallback ()
 Unregister a fsdk.SecurityCallback object from Foxit PDF SDK. More...
 
def LibraryUnregisterSignatureCallback ()
 Unregister the third-party fsdk.SignatureCallback object, which is associated with a specific filter and sub-filter, from the Foxit PDF SDK. If a default signature is available, it will be restored together with its filter and sub-filter values. More...
 
def LRElementStringifyElementType ()
 Convert enum value of a specified element type to a short and memorable string (text) representation. More...
 
def LRStructureElementIsArrayAttributeValueType ()
 Check whether input attribute value type represents an array. More...
 
def LRStructureElementParseAttributeType ()
 Parse a string representation for attribute type and retrieve the enum value for this attribute type. More...
 
def LRStructureElementStringifyAttributeType ()
 Convert the enum value of a specified attribute type to a short and memorable string (text) representation. More...
 
def LRStructureElementStringifyEnumVariant ()
 Convert the enum value of a specified attribute value enum to a short and memorable string (text) representation. More...
 
def Office2PDFConvertFromExcel ()
 Convert an Excel format file to a PDF file. More...
 
def Office2PDFConvertFromPowerPoint ()
 Convert a PowerPoint format file to a PDF file. More...
 
def Office2PDFConvertFromWord ()
 Convert a Word format file to a PDF file. More...
 
def Office2PDFInitialize ()
 Initialize Foxit PDF Conversion. More...
 
def Office2PDFRelease ()
 Release all resource allocated by Foxit PDF Conversion. More...
 
def OptimizerComputeAuditSpace ()
 Compute audit space. More...
 
def OptimizerOptimize ()
 Optimize the given PDF document with specified optimizer settings. More...
 
def OptimizerOptimizeScannedPDF ()
 Optimize the scanned PDF document with specified optimizers settings. More...
 
def OptimizerStartSubsetEmbedFont ()
 Start to make subsets for embedded fonts in the given PDF document. More...
 
def PathObjectCreate ()
 Create a new path graphics object. More...
 
def PathObjectCreateFromTextObject ()
 Create a path graphics object from a text object. More...
 
def PDF2OfficeInitialize ()
 Initialize Foxit PDF Conversion. More...
 
def PDF2OfficeRelease ()
 Release all resource allocated by Foxit PDF Conversion. More...
 
def PDF2OfficeSetConvertCheckCallback ()
 Set the callback object to check the PDF to Office conversion conditions. More...
 
def PDF2OfficeStartConvertToExcel ()
 Start to convert a PDF file to a Excel format file. Function fsdk.PDF2OfficeInitialize must be called before calling this function. More...
 
def PDF2OfficeStartConvertToPowerPoint ()
 Start to convert a PDF file to a PowerPoint format file. Function fsdk.PDF2OfficeInitialize must be called before calling this function. More...
 
def PDF2OfficeStartConvertToWord ()
 Start to convert a PDF file to a Word format file. Function fsdk.PDF2OfficeInitialize must be called before calling this function. More...
 
def PDFArrayCreate ()
 Create a new array object. More...
 
def PDFArrayCreateFromMatrix ()
 Create a new array object for a matrix. More...
 
def PDFArrayCreateFromRect ()
 Create a new array object for a rectangle. More...
 
def PDFDictionaryCreate ()
 Create a new dictionary object. More...
 
def PDFObjectCreateFromBoolean ()
 Create a PDF object from a boolean value. More...
 
def PDFObjectCreateFromDateTime ()
 Create a PDF object from date time. More...
 
def PDFObjectCreateFromFloat ()
 Create a PDF object from a float number. More...
 
def PDFObjectCreateFromInteger ()
 Create a PDF object from a integer number. More...
 
def PDFObjectCreateFromName ()
 Create a PDF object from a string which represents a name. More...
 
def PDFObjectCreateFromNameW ()
 Create a PDF object from a string which represents a name. More...
 
def PDFObjectCreateFromString ()
 Create a PDF object from string. More...
 
def PDFObjectCreateReference ()
 Create a reference for an indirect object. More...
 
def PDFStreamCreate ()
 Create a new stream object based on a dictionary. More...
 
def PortfolioCreatePortfolio ()
 Create a PDF portfolio with a new and blank PDF document created automatically. More...
 
def SplitPDFDocStartSplitByFileSize ()
 Start to split the PDF document into multiple PDF documents. More...
 
def TableGeneratorAddTableToPage ()
 Add a new table to the PDF page. More...
 
def TableGeneratorInsertTablePagesToDocument ()
 Insert a new table which is contained in one or multi pages into the document. More...
 
def TextObjectCreate ()
 Create a new text graphics object. More...
 
def TimeStampServerMgrAddServer ()
 Add a time stamp server to the manager. More...
 
def TimeStampServerMgrGetDefaultServer ()
 Get default time stamp server object. More...
 
def TimeStampServerMgrGetServer ()
 Get time stamp server with specified index. More...
 
def TimeStampServerMgrGetServerCount ()
 Get time stamp server count. More...
 
def TimeStampServerMgrGetServerIndex ()
 Get the index of a speicified time stamp server object. More...
 
def TimeStampServerMgrInitialize ()
 Initialize time stamp server manager. More...
 
def TimeStampServerMgrRelease ()
 Release time stamp server manager. More...
 
def TimeStampServerMgrRemoveServer ()
 Remove a time stamp server from the manager, by index. More...
 
def TimeStampServerMgrSetDefaultServer ()
 Set default time stamp server object by index. More...
 

Variables

 ActionCallbackE_AppInfoTypeAppVersion
 Application's app version information.
 
 ActionCallbackE_AppInfoTypeFormsVersion
 Application's forms version information.
 
 ActionCallbackE_AppInfoTypeViewerType
 Application's viewer type information.
 
 ActionCallbackE_AppInfoTypeViewerVariation
 Application's viewer variation information.
 
 ActionCallbackE_AppInfoTypeViewerVersion
 Application's viewer version information.
 
 ActionCallbackE_JSFieldValueChangedByCalculation
 javascript field value changed type : calculation.
 
 ActionCallbackE_JSFieldValueChangedByFillColor
 javascript field value changed type: field fill color.
 
 ActionCallbackE_JSFieldValueChangedByFormat
 javascript field value changed type: format.
 
 ActionCallbackE_JSFieldValueChangedBySetReadOnly
 javascript field value changed type: field set read-only property.
 
 ActionCallbackE_JSFieldValueChangedBySetValue
 javascript field value changed type: field set value.
 
 ActionCallbackE_JSMailResultFailed
 Mailed result: mail failed.
 
 ActionCallbackE_JSMailResultSuccess
 Mailed result: mail success.
 
 ActionCallbackE_JSMailResultUserAbort
 Mailed result: user abort.
 
 ActionCallbackE_JSMediaPlayerStateClose
 media player state: Close.
 
 ActionCallbackE_JSMediaPlayerStateOpen
 media player state: Open.
 
 ActionCallbackE_JSMediaPlayerStatePlaying
 media player state: Playing.
 
 ActionCallbackE_JSMediaPlayerStateStop
 media player state: Stop.
 
 ActionCallbackE_JSMediaPlayerStateSuspend
 media player state: Suspend.
 
 ActionCallbackE_LanguageCHS
 Chinese Simplified.
 
 ActionCallbackE_LanguageCHT
 Chinese Traditional.
 
 ActionCallbackE_LanguageDAN
 Danish.
 
 ActionCallbackE_LanguageDEU
 German.
 
 ActionCallbackE_LanguageENU
 English.
 
 ActionCallbackE_LanguageESP
 Spanish.
 
 ActionCallbackE_LanguageFRA
 French.
 
 ActionCallbackE_LanguageITA
 Italian.
 
 ActionCallbackE_LanguageJPN
 Japanese.
 
 ActionCallbackE_LanguageKOR
 Korean.
 
 ActionCallbackE_LanguageNLD
 Dutch.
 
 ActionCallbackE_LanguageNOR
 Norwegian.
 
 ActionCallbackE_LanguagePTB
 Brazilian Portuguese.
 
 ActionCallbackE_LanguageSUO
 Finnish.
 
 ActionCallbackE_LanguageSVE
 Swedish.
 
 ActionCallbackE_LanguageUnknown
 Unknown language.
 
 ActionCallbackE_LayoutModeContinuous
 Layout mode: continuous page.
 
 ActionCallbackE_LayoutModeContinuousFacing
 Layout mode: continuous two pages.
 
 ActionCallbackE_LayoutModeFacing
 Layout mode: two pages.
 
 ActionCallbackE_LayoutModeSinglePage
 Layout mode: single page.
 
 ActionCallbackE_MailTypeDoc
 Mailed data type: document.
 
 ActionCallbackE_MailTypeForm
 Mailed data type: form.
 
 ActionCallbackE_MailTypeMsg
 Mailed data type: string message.
 
 ActionCallbackE_SearchScopeActiveDoc
 Search scope: active document.
 
 ActionCallbackE_SearchScopeActiveIndexes
 Search scope: active indexes.
 
 ActionCallbackE_SearchScopeFolder
 Search scope: folder.
 
 ActionCallbackE_SearchScopeIndex
 Search scope: index.
 
 ActionE_NewWindowFlagFalse
 "NewWindow" flag is false.
 
 ActionE_NewWindowFlagNone
 No "NewWindow" flag.
 
 ActionE_NewWindowFlagTrue
 "NewWindow" flag is true.
 
 ActionE_TypeGoto
 Action type: go-to action.
 
 ActionE_TypeGoTo3DView
 Action type: go-to-3D-view action.
 
 ActionE_TypeGoToE
 Action type: embedded go-to action.
 
 ActionE_TypeGoToR
 Action type: remote go-to action.
 
 ActionE_TypeHide
 Action type: hide action.
 
 ActionE_TypeImportData
 Action type: import-data action.
 
 ActionE_TypeJavaScript
 Action type: JavaScript action.
 
 ActionE_TypeLaunch
 Action type: launch action.
 
 ActionE_TypeMovie
 Action type: movie action.
 
 ActionE_TypeNamed
 Action type: named action.
 
 ActionE_TypeRendition
 Action type: rendition action.
 
 ActionE_TypeResetForm
 Action type: reset-form action.
 
 ActionE_TypeSetOCGState
 Action type: set-OCG-state action.
 
 ActionE_TypeSound
 Action type: sound action.
 
 ActionE_TypeSubmitForm
 Action type: submit-form action.
 
 ActionE_TypeThread
 Action type: thread action.
 
 ActionE_TypeTrans
 Action type: transition action.
 
 ActionE_TypeUnknown
 Action type: unknown action.
 
 ActionE_TypeURI
 Action type: uniform resource identifier (URI) action.
 
 AdditionalActionE_TriggerAnnotCursorEnter
 Trigger an action to be performed when the cursor enters the annotation's active area. More...
 
 AdditionalActionE_TriggerAnnotCursorExit
 Trigger an action to be performed when the cursor exits the annotation's active area. More...
 
 AdditionalActionE_TriggerAnnotLoseInputFocus
 (Applicable for widget annotation only) Trigger an action to be performed when the annotation loses the input focus. More...
 
 AdditionalActionE_TriggerAnnotMouseButtonPressed
 Trigger an action to be performed when the mouse button is pressed inside the annotation's active area. More...
 
 AdditionalActionE_TriggerAnnotMouseButtonReleased
 Trigger an action to be performed when the mouse button is released inside the annotation's active area. More...
 
 AdditionalActionE_TriggerAnnotPageClosed
 Trigger an action to be performed when the page containing the annotation is closed. More...
 
 AdditionalActionE_TriggerAnnotPageInvisible
 Trigger an action to be performed when the page containing the annotation is no longer visible in the viewer application's user interface. More...
 
 AdditionalActionE_TriggerAnnotPageOpened
 Trigger an action to be performed when the page containing the annotation is opened. More...
 
 AdditionalActionE_TriggerAnnotPageVisible
 Trigger an action to be performed when the page containing the annotation becomes visible in the viewer application's user interface. More...
 
 AdditionalActionE_TriggerAnnotReceiveInputFocus
 (Applicable for widget annotation only) Trigger an action to be performed when the annotation receives the input focus. More...
 
 AdditionalActionE_TriggerDocPrinted
 Trigger a JavaScript action to be performed after printing a document. More...
 
 AdditionalActionE_TriggerDocSaved
 Trigger a JavaScript action to be performed after saving a document. More...
 
 AdditionalActionE_TriggerDocWillClose
 Trigger a JavaScript action to be performed before closing a document. More...
 
 AdditionalActionE_TriggerDocWillPrint
 Trigger a JavaScript action to be performed before printing a document. More...
 
 AdditionalActionE_TriggerDocWillSave
 Trigger a JavaScript action to be performed before saving a document. More...
 
 AdditionalActionE_TriggerFieldKeyStroke
 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. More...
 
 AdditionalActionE_TriggerFieldRecalculateValue
 Trigger a JavaScript action to be performed to recalculate the value of this field when that of another field changes. More...
 
 AdditionalActionE_TriggerFieldValueChanged
 Trigger a JavaScript action to be performed when the field's value is changed. More...
 
 AdditionalActionE_TriggerFieldWillFormat
 Trigger a JavaScript action to be performed before the field is formatted to display its current value. More...
 
 AdditionalActionE_TriggerPageClosed
 Trigger an action to be performed when the page is closed. More...
 
 AdditionalActionE_TriggerPageOpened
 Trigger an action to be performed when the page is opened. More...
 
 AnnotationSummaryCallbackE_AnnotationSummaryStringIDAuthor
 Annotations summary string ID: specify the prefix when author information is outputed in result document. Default prefix is "Author:".
 
 AnnotationSummaryCallbackE_AnnotationSummaryStringIDDate
 Annotations summary string ID: specify the prefix when date information is outputed in result document. Default prefix is "Date:".
 
 AnnotationSummaryCallbackE_AnnotationSummaryStringIDDocumentTitle
 Annotations summary string ID: specify the document title in result document. Default title is "Summary of comments:".
 
 AnnotationSummaryCallbackE_AnnotationSummaryStringIDNoAnnotations
 Annotations summary string ID: specify the string used as content in result document when a page does not have any annotation. Default content is "No Annotations.".
 
 AnnotationSummaryCallbackE_AnnotationSummaryStringIDNumber
 Annotations summary string ID: specify the prefix when number information is outputed in result document. Default prefix is "Number:".
 
 AnnotationSummaryCallbackE_AnnotationSummaryStringIDPage
 Annotations summary string ID: specify the prefix when page information is outputed in result document. Default prefix is "Page:".
 
 AnnotationSummaryCallbackE_AnnotationSummaryStringIDPageTitle
 Annotations summary string ID: specify the prefix when page title is outputed in result document. Default string is "Page:".
 
 AnnotationSummaryCallbackE_AnnotationSummaryStringIDSubject
 Annotations summary string ID: specify the prefix when subject information is outputed in result document. Default prefix is "Subject:".
 
 AnnotationSummaryCallbackE_AnnotationSummaryStringIDType
 Annotations summary string ID: specify the prefix when annotation type is outputed in result document. Default prefix is "Type:".
 
 AnnotationSummarySettingsE_FontSizeLarge
 If set, that means to use large font size in result document.
 
 AnnotationSummarySettingsE_FontSizeMedium
 If set, that means to use medium font size in result document.
 
 AnnotationSummarySettingsE_FontSizeSmall
 If set, that means to use small font size in result document.
 
 AnnotationSummarySettingsE_SummaryLayoutAnnotationOnly
 If set, that means to layout annotations only.
 
 AnnotationSummarySettingsE_SummaryLayoutSeparatePagesWithLine
 If set, that means to layout document and annotations with connector lines on separate pages.
 
 AnnotationSummarySettingsE_SummaryLayoutSeparatePagesWithSequenceNumber
 If set, that means to layout document and annotations with sequence numbers on separate pages.
 
 AnnotationSummarySettingsE_SummaryLayoutSinglePageWithLine
 If set, that means to layout document and annotations with connector lines on single pages.
 
 AnnotationSummarySettingsE_SummaryLayoutSinglePageWithSequenceNumber
 If set, that means to layout document and annotations with sequence numbers on separate pages.
 
 AnnotationSummarySettingsE_TypeSortByAnnotationType
 If set, that means to sort annotation by annotation type in result document.
 
 AnnotationSummarySettingsE_TypeSortByAuthor
 If set, that means to sort annotation by author in result document.
 
 AnnotationSummarySettingsE_TypeSortByDate
 If set, that means to sort annotation by date in result document.
 
 AnnotationSummarySettingsE_TypeSortByPage
 If set, that means to sort annotation by page in result document.
 
 AnnotE_3D
 Annotation type: 3D annotation. One of standard annotation in <PDF reference 1.7>.
 
 AnnotE_AppearanceTypeDown
 Annotation's down appearance.
 
 AnnotE_AppearanceTypeNormal
 Annotation's normal appearance.
 
 AnnotE_AppearanceTypeRollover
 Annotation's rollover appearance.
 
 AnnotE_Caret
 Annotation type: caret annotation. One of standard annotation in <PDF reference 1.7>.
 
 AnnotE_Circle
 Annotation type: circle annotation. One of standard annotation in <PDF reference 1.7>.
 
 AnnotE_FileAttachment
 Annotation type: file attachment annotation. One of standard annotation in <PDF reference 1.7>.
 
 AnnotE_FlagHidden
 Annotation flag: hidden. More...
 
 AnnotE_FlagInvisible
 Annotation flag: invisible. More...
 
 AnnotE_FlagLocked
 Annotation flag: locked. More...
 
 AnnotE_FlagLockedContents
 Annotation flag: locked contents. More...
 
 AnnotE_FlagNoRotate
 Annotation flag: no rotate. More...
 
 AnnotE_FlagNoView
 Annotation flag: no view. More...
 
 AnnotE_FlagNoZoom
 Annotation flag: no zoom. More...
 
 AnnotE_FlagPrint
 Annotation flag: print. More...
 
 AnnotE_FlagReadOnly
 Annotation flag: read only. More...
 
 AnnotE_FlagToggleNoView
 Annotation flag: toggle no view. More...
 
 AnnotE_FreeText
 Annotation type: free text annotation. One of standard annotation in <PDF reference 1.7>.
 
 AnnotE_Highlight
 Annotation type: highlight annotation. One of standard annotation in <PDF reference 1.7>.
 
 AnnotE_HighlightingInvert
 Highlighting mode: Invert, which is to invert the contents of the annotation rectangle.
 
 AnnotE_HighlightingNone
 Highlighting mode: No highlighting.
 
 AnnotE_HighlightingOutline
 Highlighting mode: Outline, which is to invert the annotation's border.
 
 AnnotE_HighlightingPush
 Highlighting mode: Push, which is to display the annotation's down appearance, if any.
 
 AnnotE_HighlightingToggle
 Highlighting mode: Toggle. This is only useful for widget annotation.
 
 AnnotE_Ink
 Annotation type: ink annotation. One of standard annotation in <PDF reference 1.7>.
 
 AnnotE_Line
 Annotation type: line annotation. One of standard annotation in <PDF reference 1.7>.
 
 AnnotE_Link
 Annotation type: link annotation. One of standard annotation in <PDF reference 1.7>.
 
 AnnotE_MKEntryBackgroundColor
 Background color entry. "BG" in MK dictionary.
 
 AnnotE_MKEntryBorderColor
 Border color entry. "BC" in MK dictionary.
 
 AnnotE_MKEntryDownCaption
 Down caption (or alternate caption) entry. "AC" in MK dictionary. More...
 
 AnnotE_MKEntryDownIcon
 Down icon (or alternate icon) entry. "IX" in MK dictionary. More...
 
 AnnotE_MKEntryIconCaptionRelation
 Icon and caption relation entry. "TP" in MK dictionary. More...
 
 AnnotE_MKEntryIconFit
 Icon fit information entry. "IF" in MK dictionary. More...
 
 AnnotE_MKEntryNormalCaption
 Normal caption entry. "CA" in MK dictionary. More...
 
 AnnotE_MKEntryNormalIcon
 Normal icon entry. "I" in MK dictionary. More...
 
 AnnotE_MKEntryRolloverCaption
 Rollover caption entry. "RC" in MK dictionary. More...
 
 AnnotE_MKEntryRolloverIcon
 Rollover icon entry. "RI" in MK dictionary. More...
 
 AnnotE_MKEntryRotation
 Rotation entry. "R" in MK dictionary.
 
 AnnotE_MKRelationCaptionAboveIcon
 Caption above the icon.
 
 AnnotE_MKRelationCaptionBelowIcon
 Caption below the icon.
 
 AnnotE_MKRelationCaptionLeft
 Caption to the left of the icon.
 
 AnnotE_MKRelationCaptionOvrlayOnIcon
 Caption overlaid directly on the icon.
 
 AnnotE_MKRelationCaptionRight
 Caption to the right of the icon.
 
 AnnotE_MKRelationNoCaption
 No caption; icon only.
 
 AnnotE_MKRelationNoIcon
 No icon; captin only.
 
 AnnotE_Movie
 Annotation type: movie annotation. One of standard annotation in <PDF reference 1.7>.
 
 AnnotE_Note
 Annotation type: note annotation, which is just "Text" annotation - one of standard annotation in <PDF reference 1.7>.
 
 AnnotE_PagingSeal
 Annotation type: paging seal annotation. A Foxit PDF SDK custom annotation type (not a standard annotation type).
 
 AnnotE_Polygon
 Annotation type: polygon annotation. One of standard annotation in <PDF reference 1.7>.
 
 AnnotE_PolyLine
 Annotation type: polyline annotation. One of standard annotation in <PDF reference 1.7>.
 
 AnnotE_Popup
 Annotation type: pop-up annotation. One of standard annotation in <PDF reference 1.7>.
 
 AnnotE_PrinterMark
 Annotation type: printer's mark annotation. One of standard annotation in <PDF reference 1.7>.
 
 AnnotE_PropertyBorderColor
 Annotation property: border color. More...
 
 AnnotE_PropertyCreationDate
 Annotation property: creation date. More...
 
 AnnotE_PropertyFillColor
 Annotation property: fill color. More...
 
 AnnotE_PropertyModifiedDate
 Annotation property: modified date.
 
 AnnotE_PSInk
 Annotation type: pressure sensitive ink annotation.
 
 AnnotE_Redact
 Annotation type: redact annotation.
 
 AnnotE_RichMedia
 Annotation type: rich media annotation.
 
 AnnotE_Screen
 Annotation type: screen annotation. One of standard annotation in <PDF reference 1.7>.
 
 AnnotE_Sound
 Annotation type: sound annotation. One of standard annotation in <PDF reference 1.7>.
 
 AnnotE_Square
 Annotation type: square annotation. One of standard annotation in <PDF reference 1.7>.
 
 AnnotE_Squiggly
 Annotation type: squiggly annotation. One of standard annotation in <PDF reference 1.7>.
 
 AnnotE_Stamp
 Annotation type: stamp annotation. One of standard annotation in <PDF reference 1.7>.
 
 AnnotE_StrikeOut
 Annotation type: strikeout annotation. One of standard annotation in <PDF reference 1.7>.
 
 AnnotE_TrapNet
 Annotation type: trap network annotation. One of standard annotation in <PDF reference 1.7>.
 
 AnnotE_Underline
 Annotation type: underline annotation. One of standard annotation in <PDF reference 1.7>.
 
 AnnotE_UnknownType
 Annotation type: unknown.
 
 AnnotE_Watermark
 Annotation type: watermark annotation. One of standard annotation in <PDF reference 1.7>.
 
 AnnotE_Widget
 Annotation type: widget annotation. One of standard annotation in <PDF reference 1.7>. More...
 
 AppProviderCallbackE_AppInfoLanguage
 Application information: language.
 
 AppProviderCallbackE_AppInfoName
 Application information: name.
 
 AppProviderCallbackE_AppInfoPlatform
 Application information: platform.
 
 AppProviderCallbackE_AppInfoType
 Application information: type.
 
 AppProviderCallbackE_AppInfoVariation
 Application information: variation.
 
 AppProviderCallbackE_AppInfoVersion
 Application information: version.
 
 AppProviderCallbackE_BeepTypeDefault
 Beep type: default.
 
 AppProviderCallbackE_BeepTypeError
 Beep type: error.
 
 AppProviderCallbackE_BeepTypeQuestion
 Beep type: question.
 
 AppProviderCallbackE_BeepTypeStatus
 Beep type: status.
 
 AppProviderCallbackE_BeepTypeWarning
 Beep type: warning.
 
 AppProviderCallbackE_MsgBoxIconError
 Message box icon: Error.
 
 AppProviderCallbackE_MsgBoxIconQuestion
 Message box icon: Question.
 
 AppProviderCallbackE_MsgBoxIconStatus
 Message box icon: Status.
 
 AppProviderCallbackE_MsgBoxIconWarning
 Message box icon: Warning.
 
 AppProviderCallbackE_MsgBtnIDCancel
 Message box button ID: Cancel.
 
 AppProviderCallbackE_MsgBtnIDNo
 Message box button ID: No.
 
 AppProviderCallbackE_MsgBtnIDOK
 Message box button ID: OK.
 
 AppProviderCallbackE_MsgBtnIDYes
 Message box button ID: Yes.
 
 AppProviderCallbackE_MsgBtnTypeOK
 Message box button: OK.
 
 AppProviderCallbackE_MsgBtnTypeOKCancel
 Message box button: OK and Cancel.
 
 AppProviderCallbackE_MsgBtnTypeYesNo
 Message box button: Yes and No.
 
 AppProviderCallbackE_MsgBtnTypeYesNoCancel
 Message box button: Yes, No and Cancel.
 
 AppProviderCallbackE_StringIDAccessProertyInNotObject
 Sample message: "An attempt was made to reference property '%s' of a non-object in SOM expression %s".
 
 AppProviderCallbackE_StringIDAppName
 String ID for case: Application's name. Sample message: "Foxit Phantom".
 
 AppProviderCallbackE_StringIDArgumentExpectContainer
 Sample message: "'%s' argument is expected to be a container".
 
 AppProviderCallbackE_StringIDArgumentMismatch
 Sample message: "Argument mismatch in property or function argument".
 
 AppProviderCallbackE_StringIDArgumentNotArray
 Sample message: "'%s' function's %d argument cannot be array".
 
 AppProviderCallbackE_StringIDBadSuffix
 Sample message: "Bad suffix on number".
 
 AppProviderCallbackE_StringIDCalcOverride
 Sample message: "Calculate Override".
 
 AppProviderCallbackE_StringIDCannotAssign
 Sample message: "Cannot assign to '%s'".
 
 AppProviderCallbackE_StringIDCannotCovertToObject
 Sample message: "%s.%s cannot covert to object".
 
 AppProviderCallbackE_StringIDCannotModifyValue
 Sample message: "Cannot modify the '%s' value".
 
 AppProviderCallbackE_StringIDCompilerError
 Sample message: "Compiler error".
 
 AppProviderCallbackE_StringIDConditionIsNull
 Sample message: "Condition is null".
 
 AppProviderCallbackE_StringIDDivideZero
 Sample message: "Divide by zero".
 
 AppProviderCallbackE_StringIDErrorMessage
 Sample message: "%s : %s".
 
 AppProviderCallbackE_StringIDExpectedEndIf
 Sample message: "Expected 'endif' instead of '%s'".
 
 AppProviderCallbackE_StringIDExpectedIdent
 Sample message: "Expected identifier instead of '%s'".
 
 AppProviderCallbackE_StringIDExpectedNumber
 Sample message: "Expected number instead of '%s'".
 
 AppProviderCallbackE_StringIDExpectedOperator
 Sample message: "Expected operator '%s' instead of '%s'".
 
 AppProviderCallbackE_StringIDExpectedString
 Sample message: "Expected '%s' instead of '%s'".
 
 AppProviderCallbackE_StringIDFunctionBuildIn
 Sample message: "Function 's' is built-in.
 
 AppProviderCallbackE_StringIDIllegalBreak
 Sample message: "Illegal break".
 
 AppProviderCallbackE_StringIDIllegalContinue
 Sample message: "Illegal continue".
 
 AppProviderCallbackE_StringIDImageFilter
 String ID for case: Filter for image files. Sample message: "Image Files(*.bmp;*.jpg;*.png;*.gif;*.tif)|*.bmp;*.jpg;*.png;*.gif;*.tif|All Files(*.*)|*.*||".
 
 AppProviderCallbackE_StringIDIncorrectNumberOfMethod
 Sample message: "Incorrect number of parameters are used when calling method '%s'".
 
 AppProviderCallbackE_StringIDIndexValueOutOfBounds
 Sample message: "Index value is out of bounds".
 
 AppProviderCallbackE_StringIDInvalidAppend
 Sample message: "Invalid append operation: %s cannot have a child element of %s".
 
 AppProviderCallbackE_StringIDInvalidateChar
 Sample message: "Invalidate character '%c'".
 
 AppProviderCallbackE_StringIDInvalidateInstruction
 Sample message: "Invalidate instruction".
 
 AppProviderCallbackE_StringIDInvalidateLeftValue
 Sample message: "Invalidate left-value '%s'".
 
 AppProviderCallbackE_StringIDInvalidBarcodeValue
 Sample message: "Invalid Barcode Value: %s is an invalid value for barcodes of type %s.".
 
 AppProviderCallbackE_StringIDInvalidEnumerate
 Sample message: "Invalid enumerated value: %s".
 
 AppProviderCallbackE_StringIDInvalidEnumValue
 String ID for case: Some enumerate value is invalid. Sample message: "Invalid enumerate value:".
 
 AppProviderCallbackE_StringIDInvalidExpression
 Sample message: "Invalidate expression '%s'".
 
 AppProviderCallbackE_StringIDInvalidNodeType
 Sample message: "Invalid node type: '%s'".
 
 AppProviderCallbackE_StringIDInvalidPropertySetOperation
 String ID for case: Some setting operation to property is invalid. Sample message: "Invalid property setting operation:".
 
 AppProviderCallbackE_StringIDInvalidToken
 Sample message: "Invalidate token '%s'".
 
 AppProviderCallbackE_StringIDIsNotArray
 Sample message: "'%s' is not an array".
 
 AppProviderCallbackE_StringIDModifyField
 String ID for case: If to modify field. Sample message: "Do you want to modify this field?".
 
 AppProviderCallbackE_StringIDMonthApril
 String ID for case: Use string in local language for "April".
 
 AppProviderCallbackE_StringIDMonthAug
 String ID for case: Use string in local language for "August".
 
 AppProviderCallbackE_StringIDMonthDec
 String ID for case: Use string in local language for "December".
 
 AppProviderCallbackE_StringIDMonthFeb
 String ID for case: Use string in local language for "February".
 
 AppProviderCallbackE_StringIDMonthJan
 String ID for case: Use string in local language for "January".
 
 AppProviderCallbackE_StringIDMonthJuly
 String ID for case: Use string in local language for "July".
 
 AppProviderCallbackE_StringIDMonthJune
 String ID for case: Use string in local language for "June".
 
 AppProviderCallbackE_StringIDMonthMarch
 String ID for case: Use string in local language for "March".
 
 AppProviderCallbackE_StringIDMonthMay
 String ID for case: Use string in local language for "May".
 
 AppProviderCallbackE_StringIDMonthNov
 String ID for case: Use string in local language for "November".
 
 AppProviderCallbackE_StringIDMonthOct
 String ID for case: Use string in local language for "October".
 
 AppProviderCallbackE_StringIDMonthSep
 String ID for case: Use string in local language for "September".
 
 AppProviderCallbackE_StringIDNotAssignObject
 Sample message: "Cannot directly assign the value to object".
 
 AppProviderCallbackE_StringIDNotDefaultValue
 Sample message: "Not have a default property".
 
 AppProviderCallbackE_StringIDNotFoundConst
 Sample message: "Cannot find const '%s'".
 
 AppProviderCallbackE_StringIDNotFoundContainer
 Sample message: "Cannot find container '%s'".
 
 AppProviderCallbackE_StringIDNotFoundFunction
 Sample message: "Cannot find function '%s'".
 
 AppProviderCallbackE_StringIDNotFoundMethod
 Sample message: "Cannot find method '%s'".
 
 AppProviderCallbackE_StringIDNotFoundProperty
 Sample message: "Cannot find property '%s'".
 
 AppProviderCallbackE_StringIDNotHaveProperty
 Sample message: "'%s' doesn't have property '%s'".
 
 AppProviderCallbackE_StringIDNotModifyField
 String ID for case: Not allow to modify field. Sample message: "You are not allowed to modify this field.".
 
 AppProviderCallbackE_StringIDNotSupportArrayCalculate
 Sample message: "'%s' operator cannot support array calculation".
 
 AppProviderCallbackE_StringIDNumberOfOccur
 Sample message: "The element [%s] has violated its allowable number of occurrences".
 
 AppProviderCallbackE_StringIDOutOfArrayRange
 Sample message: "Out of the range of '%s' array".
 
 AppProviderCallbackE_StringIDParametersError
 Sample message: "Function '%s' does not have %d parameters".
 
 AppProviderCallbackE_StringIDRedefinition
 Sample message: "'%s' redefinition".
 
 AppProviderCallbackE_StringIDScriptArgumentMismatch
 Sample message: "Error:Argument mismatch in property or function argument.".
 
 AppProviderCallbackE_StringIDScriptFailedError
 Sample message: "Script failed(language is %s;context is %s) script=%s".
 
 AppProviderCallbackE_StringIDScriptInvalidValue
 Sample message: "Error:Invalid enumerated value:%s".
 
 AppProviderCallbackE_StringIDServerDeny
 String ID for case: Server denies. Sample message: "Server does not permit".
 
 AppProviderCallbackE_StringIDSOMExpectedList
 Sample message: "SOM expression returned list when single result was expected".
 
 AppProviderCallbackE_StringIDSubmitValidateNullError
 Sample message: "At least one required field was empty. Please fill in the required fields(highlighted) before continuing.".
 
 AppProviderCallbackE_StringIDToday
 String ID for case: Use string in local language for "Today".
 
 AppProviderCallbackE_StringIDUnableSetClassName
 Sample message: "Unable to set the value for property 'className'".
 
 AppProviderCallbackE_StringIDUnableSetLanguage
 Sample message: "Unable to set the value for property 'language'".
 
 AppProviderCallbackE_StringIDUnableSetLengthValue
 Sample message: "Unable to set the value for property 'length'".
 
 AppProviderCallbackE_StringIDUnableSetNumPages
 Sample message: "Unable to set the value for property 'numPages'".
 
 AppProviderCallbackE_StringIDUnableSetPlatformValue
 Sample message: "Unable to set the value for property 'platform'".
 
 AppProviderCallbackE_StringIDUnableSetReady
 Sample message: "Unable to set the value for property 'ready'".
 
 AppProviderCallbackE_StringIDUnableSetValidationsEnabledValue
 Sample message: "Unable to set the value for property 'validationsEnabled'".
 
 AppProviderCallbackE_StringIDUnableSetValidationsValue
 Sample message: "Unable to set the value for property 'variation'".
 
 AppProviderCallbackE_StringIDUnableSetVersion
 Sample message: "Unable to set the value for property 'version'".
 
 AppProviderCallbackE_StringIDUnableToSet
 Sample message: "Unable to set".
 
 AppProviderCallbackE_StringIDUndefineIdentifier
 Sample message: "Undefined identifier '%s'".
 
 AppProviderCallbackE_StringIDUnexpectedExpression
 Sample message: "Unexpected expression '%s'".
 
 AppProviderCallbackE_StringIDUnknownCaught
 Sample message: "Unknown error is caught!".
 
 AppProviderCallbackE_StringIDUnsupportChar
 Sample message: "Unsupported character '%c'".
 
 AppProviderCallbackE_StringIDUnsupportMethod
 Sample message: "Unsupported method %s.".
 
 AppProviderCallbackE_StringIDUnsupportProperty
 Sample message: "Unsupported property %s.".
 
 AppProviderCallbackE_StringIDValidateError
 Sample message: "The value you entered for %s is invalid.".
 
 AppProviderCallbackE_StringIDValidateFailed
 Sample message: "Validate failed".
 
 AppProviderCallbackE_StringIDValidateLimit
 Sample message: "Message limit exceeded. Remaining %d validation errors not reported.".
 
 AppProviderCallbackE_StringIDValidateNullError
 Sample message: "%s cannot be left blank.".
 
 AppProviderCallbackE_StringIDValidateNullWarning
 Sample message: "%s cannot be left blank. To ignore validations for %s, click Ignore.".
 
 AppProviderCallbackE_StringIDValidateNumberError
 Sample message: "Illegal value:cannot assign '%s' to %s.".
 
 AppProviderCallbackE_StringIDValidateOutOfArray
 Sample message: "Validate access index '%s' out of array".
 
 AppProviderCallbackE_StringIDValidateWarning
 Sample message: "The value you entered for %s is invalid. To ignore validations for %s, click Ignore.".
 
 AppProviderCallbackE_StringIDValueExcalmatory
 Sample message: "Value!".
 
 AppProviderCallbackE_StringIDViolateBoundary
 Sample message: "The element [%s] has violated its allowable number of occurrences".
 
 AppProviderCallbackE_StringIDWeekDayFri
 String ID for case: Use string in local language for "Friday".
 
 AppProviderCallbackE_StringIDWeekDayMon
 String ID for case: Use string in local language for "Monday".
 
 AppProviderCallbackE_StringIDWeekDaySat
 String ID for case: Use string in local language for "Saturday".
 
 AppProviderCallbackE_StringIDWeekDaySun
 String ID for case: Use string in local language for "Sunday".
 
 AppProviderCallbackE_StringIDWeekDayThu
 String ID for case: Use string in local language for "Thursday".
 
 AppProviderCallbackE_StringIDWeekDayTue
 String ID for case: Use string in local language for "Tuesday".
 
 AppProviderCallbackE_StringIDWeekDayWed
 String ID for case: Use string in local language for "Wednesday".
 
 AssociatedFilesE_RelationshipAlternative
 The relationship is "Alternative" which means the file specification is an alternative representation of content, for example audio.
 
 AssociatedFilesE_RelationshipData
 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.
 
 AssociatedFilesE_RelationshipEncryptedPayload
 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.
 
 AssociatedFilesE_RelationshipFormData
 The relationship is "Form data" which means the file specification is the data associated with the "AcroForm" dictionary in the PDF file.
 
 AssociatedFilesE_RelationshipSchema
 The relationship is "Schema" which means the file specification is a schema definition for the associated object.
 
 AssociatedFilesE_RelationshipSource
 The relationship is "Source" which means the file specification is the original source material for the associated content.
 
 AssociatedFilesE_RelationshipSupplement
 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.
 
 AssociatedFilesE_RelationshipUnspecified
 The relationship is not known or cannot be described by other values.
 
 BarcodeE_FormatCode128
 Barcode format: Code128, including EAN128 code.
 
 BarcodeE_FormatCode39
 Barcode format: standard 39 code.
 
 BarcodeE_FormatEAN13
 Barcode format: EAN-13 code.
 
 BarcodeE_FormatEAN8
 Barcode format: EAN-8 code.
 
 BarcodeE_FormatITF
 Barcode format: ITF code.
 
 BarcodeE_FormatPDF417
 Barcode format: PDF-417 code.
 
 BarcodeE_FormatQRCode
 Barcode format: Quick Response Code.
 
 BarcodeE_FormatUPCA
 Barcode format: UPC-A code.
 
 BarcodeE_QRCorrectionLevelHigh
 The capability of recovery from 30% amounts of damage.
 
 BarcodeE_QRCorrectionLevelLow
 The capability of recovery from 7% amounts of damage.
 
 BarcodeE_QRCorrectionLevelMedium
 The capability of recovery from 15% amounts of damage.
 
 BarcodeE_QRCorrectionLevelQuater
 The capability of recovery from 25% amounts of damage.
 
 BitmapE_Bicubic
 If set, do bicubic interpolation for stretching or transforming.
 
 BitmapE_DIB1bpp
 DIB format: 1bpp format, two color RGB bitmap.It does not support format conversion between bitmaps.
 
 BitmapE_DIB8bpp
 DIB format: 8bpp format, 256 color RGB bitmap.
 
 BitmapE_DIB8bppGray
 DIB format: 8bpp format, 256 color GrayScale bitmap.
 
 BitmapE_DIB8bppMask
 DIB format: 8bpp alpha mask.
 
 BitmapE_DIBAbgr
 DIB format: 32bpp format, with bits order "Red, Green, Blue, Alpha". Red is in the lowest order.
 
 BitmapE_DIBArgb
 DIB format: 32bpp format, with bits order "Blue, Green, Red, Alpha". Blue is in the lowest order.
 
 BitmapE_DIBCmyk
 DIB format: 32bpp CMYK format, with bits order "Cyan, Magenta, Yellow, Black". Cyan is in the lowest order.
 
 BitmapE_DIBInvalid
 Invalid DIB format.
 
 BitmapE_DIBRgb
 DIB format: 24bpp format, with bits order "Blue, Green, Red". Blue is in the lowest order.
 
 BitmapE_DIBRgb32
 DIB format: 32bpp format, with bits order "Blue, Green, Red, not used". Blue is in the lowest order.
 
 BitmapE_DIBRgb565
 16bpp format, bits order: Red 5 bits, Green 6 bits, Blue 5 bits. Red is the lowest order.
 
 BitmapE_Downsample
 If set, do not do halftone for shrinking or rotating.
 
 BitmapE_Quadratic
 If set, do interpolation for stretching or transforming.
 
 BookmarkE_PosFirstChild
 A bookmark is the first child of another specified bookmark.
 
 BookmarkE_PosFirstSibling
 A bookmark is the first sibling of another specified bookmark.
 
 BookmarkE_PosLastChild
 A bookmark is the last child of another specified bookmark.
 
 BookmarkE_PosLastSibling
 A bookmark is the last sibling of another specified bookmark.
 
 BookmarkE_PosNextSibling
 A bookmark is the next sibling of another specified bookmark.
 
 BookmarkE_PosPrevSibling
 A bookmark is the previous sibling of another specified bookmark.
 
 BookmarkE_StyleBold
 Show bookmark title as bold text.
 
 BookmarkE_StyleItalic
 Show bookmark title as italic text.
 
 BookmarkE_StyleNormal
 Show bookmark title as normal text.
 
 BorderInfoE_Beveled
 Border style: Beveled. More...
 
 BorderInfoE_Cloudy
 Border style: Cloudy. More...
 
 BorderInfoE_Dashed
 Border style: Dashed. More...
 
 BorderInfoE_Inset
 Border style: Inset. More...
 
 BorderInfoE_Solid
 Border style: Solid.
 
 BorderInfoE_UnderLine
 Border style: Underline. More...
 
 CertVerifyResultE_CertStatusExpired
 This means certificate is expired.
 
 CertVerifyResultE_CertStatusRevoked
 This means certificate is revoked.
 
 CertVerifyResultE_CertStatusUnknown
 This means certificate status is unknown.
 
 CertVerifyResultE_CertStatusValid
 This means certificate is valid.
 
 CertVerifyResultE_LocationDSS
 Response information is found in DSS dictionary.
 
 CertVerifyResultE_LocationNotSet
 Location is not set.
 
 CertVerifyResultE_LocationOnline
 Response information is got by online request.
 
 CertVerifyResultE_LocationSignature
 Response information is found in signature content.
 
 CertVerifyResultE_ReasonAACompromise
 Revocatoin reason: AA compromise.
 
 CertVerifyResultE_ReasonAffiliationChanged
 Revocatoin reason: affiliation changed.
 
 CertVerifyResultE_ReasonCACompromise
 Revocatoin reason: CA compromise.
 
 CertVerifyResultE_ReasonCertificateHold
 Revocatoin reason: certificate hold.
 
 CertVerifyResultE_ReasonCessationOfOperation
 Revocatoin reason: cessation of operation.
 
 CertVerifyResultE_ReasonKeyCompromise
 Revocatoin reason: key compromise.
 
 CertVerifyResultE_ReasonNoStatus
 Revocatoin reason: ceritifcate has no status.
 
 CertVerifyResultE_ReasonPrivilegeWithDrawn
 Revocatoin reason: privilege with drawn.
 
 CertVerifyResultE_ReasonRemoveFromCRL
 Revocatoin reason: remove from CRL.
 
 CertVerifyResultE_ReasonSuperseded
 Revocatoin reason: superseded.
 
 CertVerifyResultE_ReasonUnspecified
 Revocatoin reason: unspecified reason.
 
 ColorSpaceE_RenderIntentAbsColorimetric
 Rendering intent: Absolute Colorimetric.
 
 ColorSpaceE_RenderIntentPerceptual
 Rendering intent: Perceptual.
 
 ColorSpaceE_RenderIntentRelColorimetric
 Rendering intent: Relative Colorimetric.
 
 ColorSpaceE_RenderIntentSaturation
 Rendering intent: Saturation.
 
 CombinationE_CombineDocsOptionAcroformRename
 If set, that means fields with same name will be renamed in combined result PDF file.
 
 CombinationE_CombineDocsOptionBookmark
 If set, that means bookmarks of source PDF files will be outputted to combined result PDF file.
 
 CombinationE_CombineDocsOptionDuplicateStream
 If set, that means duplicate stream objects from source PDF files will be outputted to combined result PDF file.
 
 CombinationE_CombineDocsOptionMarkInfos
 If set, that means "MarkInfo" of source PDF files will be outputted to combined result PDF file.
 
 CombinationE_CombineDocsOptionNames
 If set, that means "Dests" name trees and "EmbeddedFiles" name trees of source PDF files will be outputted to combined result PDF file.
 
 CombinationE_CombineDocsOptionObjectStream
 If set, that means object streams will be used to generate combined result PDF file in order to reduce result file size.
 
 CombinationE_CombineDocsOptionOCProperties
 If set, that means "OCProperties" of source PDF files will be outputted to combined result PDF file.
 
 CombinationE_CombineDocsOptionOutputIntents
 If set, that means output intents of source PDF files will be outputted to combined result PDF file.
 
 CombinationE_CombineDocsOptionPageLabels
 If set, that means page labels of source PDF files will be outputted to combined result PDF file.
 
 CombinationE_CombineDocsOptionStructrueTree
 If set, that means structure trees of source PDF files will be outputted to combined result PDF file.
 
 CompareResultInfoE_CompareResultTypeDeleteAnnot
 Result type: delete annotation.
 
 CompareResultInfoE_CompareResultTypeDeleteImage
 Result type: delete image.
 
 CompareResultInfoE_CompareResultTypeDeletePath
 Result type: delete path.
 
 CompareResultInfoE_CompareResultTypeDeleteShading
 Result type: delete shading.
 
 CompareResultInfoE_CompareResultTypeDeleteText
 Result type: delete text.
 
 CompareResultInfoE_CompareResultTypeInsertAnnot
 Result type: insert annotation.
 
 CompareResultInfoE_CompareResultTypeInsertImage
 Result type: insert image.
 
 CompareResultInfoE_CompareResultTypeInsertPath
 Result type: insert path.
 
 CompareResultInfoE_CompareResultTypeInsertShading
 Result type: insert shading.
 
 CompareResultInfoE_CompareResultTypeInsertText
 Result type: insert text.
 
 CompareResultInfoE_CompareResultTypeNone
 Result type: unsupported or invalid.
 
 CompareResultInfoE_CompareResultTypeReplaceAnnot
 Result type: replace annotation.
 
 CompareResultInfoE_CompareResultTypeReplaceImage
 Result type: replace image.
 
 CompareResultInfoE_CompareResultTypeReplacePath
 Result type: replace path.
 
 CompareResultInfoE_CompareResultTypeReplaceShading
 Result type: replace shading.
 
 CompareResultInfoE_CompareResultTypeReplaceText
 Result type: replace text.
 
 CompareResultInfoE_CompareResultTypeTextAttriChange
 (Reserved, not supported yet) Result type: text attribute change.
 
 ComparisonE_CompareTypeAll
 Compare all content. This value should be used alone.
 
 ComparisonE_CompareTypeAnnotation
 Compare annotation only.
 
 ComparisonE_CompareTypeText
 Compare text only.
 
 DefaultAppearanceE_FlagFont
 Indicates property font of fsdk.DefaultAppearance is meaningful.
 
 DefaultAppearanceE_FlagFontSize
 Indicates property text size of fsdk.DefaultAppearance is meaningful.
 
 DefaultAppearanceE_FlagTextColor
 Indicates property text color of fsdk.DefaultAppearance is meaningful.
 
 DestinationE_ZoomFitBBox
 Fit the bounding box of page entirely within the display area when display the page. More...
 
 DestinationE_ZoomFitBHorz
 Fit the entire width of the page's bounding box within the display area when display the page. More...
 
 DestinationE_ZoomFitBVert
 Fit the entire height of the page's bounding box within the display area when display the page. More...
 
 DestinationE_ZoomFitHorz
 Fit the entire width of the page within the display area when display the page. More...
 
 DestinationE_ZoomFitPage
 Fit the entire page within the display area when display the page. More...
 
 DestinationE_ZoomFitRect
 Fit the page content in a specified rectangle entirely within the display area when display the page. More...
 
 DestinationE_ZoomFitVert
 Fit the entire height of the page within the display area when display the page. More...
 
 DestinationE_ZoomXYZ
 Display page with a specified position and a specified zoom factor. More...
 
 DocProviderCallbackE_InvalidateFlagAllPages
 Invalidate all pages.
 
 DocProviderCallbackE_InvalidateFlagCurrentPage
 Invalidate current page.
 
 DocProviderCallbackE_PageViewEventTypeAdded
 Event type: after a page view is added.
 
 DocProviderCallbackE_PageViewEventTypeAllRemoved
 Event type: all page views are removed.
 
 DocProviderCallbackE_PageViewEventTypeRemoved
 Event type: after a page view is removed.
 
 DocProviderCallbackE_PrintOptionAsImage
 If set, print page as image; otherwise, as text.
 
 DocProviderCallbackE_PrintOptionCanCancel
 If set, that means printing process can be canceled.
 
 DocProviderCallbackE_PrintOptionPrintAnnot
 If set, print annotations.
 
 DocProviderCallbackE_PrintOptionReverseOrder
 If set, print page in reverse order; otherwise, in normal order.
 
 DocProviderCallbackE_PrintOptionShowDialog
 If set, show printing dialog box.
 
 DocProviderCallbackE_PrintOptionShrinkPage
 If set, shrink page to fit within content area.
 
 DocProviderCallbackE_SubmitInPDF
 The submit data is packaged in PDF format as described in the PDF Reference.
 
 DocProviderCallbackE_SubmitInUrlEncoded
 The submit data is packaged in URL-encoded format as described in Uniform Resource Locator(URL).
 
 DocProviderCallbackE_SubmitInXDP
 The submit data is packaged in XDP format, as described in XDP Specification.
 
 DocProviderCallbackE_SubmitInXFD
 The submit data is packaged in XFD format, as described in XFDF.
 
 DocProviderCallbackE_SubmitInXML
 The submit data is translated and packaged into an URL-Encoded format.
 
 DocProviderCallbackE_TextEncodingBig5
 Text encoding: Big5.
 
 DocProviderCallbackE_TextEncodingFontSpecific
 Text encoding: font specific.
 
 DocProviderCallbackE_TextEncodingGB18030
 Text encoding: GB18030.
 
 DocProviderCallbackE_TextEncodingGB2312
 Text encoding: GB2312.
 
 DocProviderCallbackE_TextEncodingGBK
 Text encoding: GBK.
 
 DocProviderCallbackE_TextEncodingISO8859NN
 Text encoding: ISO8859NN.
 
 DocProviderCallbackE_TextEncodingKSC5601
 Text encoding: KSC5601.
 
 DocProviderCallbackE_TextEncodingNone
 No text encoding.
 
 DocProviderCallbackE_TextEncodingShiftJIS
 Text encoding: ShiftJIS.
 
 DocProviderCallbackE_TextEncodingUCS2
 Text encoding: UCS-2.
 
 DocProviderCallbackE_TextEncodingUTF16
 Text encoding: UTF-16.
 
 DocProviderCallbackE_TextEncodingUTF8
 Text encoding: UTF-8.
 
 DocProviderCallbackE_WidgetEventTypeAdded
 Event type: after an XFA widget is added.
 
 DocProviderCallbackE_WidgetEventTypeBeforeRemoved
 Event type: before an XFA widget is removed.
 
 DocViewerPrefsE_CenterWindow
 A flag specifying whether to position the document's window in the center of the screen.
 
 DocViewerPrefsE_DisplayDocTitle
 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 false, the title bar should instead display the name of the PDF file containing the document.
 
 DocViewerPrefsE_FitWindow
 A flag specifying whether to resize the document's window to fit the size of the first displayed page.
 
 DocViewerPrefsE_HideMenubar
 A flag specifying whether to hide the viewer application's menu bar when the document is active.
 
 DocViewerPrefsE_HideToolbar
 A flag specifying whether to hide the viewer application's tool bars when the document is active.
 
 DocViewerPrefsE_HideWindowUI
 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.
 
 DocViewerPrefsE_PrintScaleAppDefault
 This means applications should use the current print scaling.
 
 DocViewerPrefsE_PrintScaleNone
 This means the print dialog should reflect no page scaling.
 
 DWG2PDFSettingDataE_DWG2PDFColorPolicyGrayscale
 Color policy: Drawing is exported to a grayscale PDF file. Native colors are converted into grayscale.
 
 DWG2PDFSettingDataE_DWG2PDFColorPolicyMono
 Color policy: Drawing is exported to a monochrome PDF file.
 
 DWG2PDFSettingDataE_DWG2PDFColorPolicyNoPolicy
 Color policy: No color policy. A drawing is exported with its native color palette (as is).
 
 DWG2PDFSettingDataE_DWG2PDFExportHatchesTypeBitmap
 Hatches export type: Exports hatch as a bitmap.
 
 DWG2PDFSettingDataE_DWG2PDFExportHatchesTypeDrawing
 Hatches export type: Exports hatch as a set of triangles (vectorizer).
 
 DWG2PDFSettingDataE_DWG2PDFExportHatchesTypePdfPaths
 Hatches export type: Exports hatch as a PDF path (solid hatches only).
 
 DWG2PDFSettingDataE_DWG2PDFExportHatchesTypePolygons
 Hatches export type: Exports hatch as a polygon (solid hatches only).
 
 DWG2PDFSettingDataE_DWG2PDFSearchableTextTypeNoSearch
 Searchable text type: No searchable text.
 
 DWG2PDFSettingDataE_DWG2PDFSearchableTextTypeSHX
 Searchable text type: Only text displayed with SHX font is searchable.
 
 DWG2PDFSettingDataE_DWG2PDFSearchableTextTypeTTF
 Searchable text type: Only text displayed with TTF font is searchable.
 
 DWG2PDFSettingDataE_FlagASCIIHexEncoding
 Bit 10. Enable ASCIIHex encoding of internal PDF streams.
 
 DWG2PDFSettingDataE_FlagEmbededOptimizedTTF
 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).
 
 DWG2PDFSettingDataE_FlagEmbededTTF
 Bit 1. Enable embedding of TTF(True Type Font) program to PDF file. The whole TTF font file will be embedded (huge PDF size).
 
 DWG2PDFSettingDataE_FlagEnableLayers
 Bit 5. If enabled, layer support will be added to PDF file (1.5 version required).
 
 DWG2PDFSettingDataE_FlagExportHyperlinks
 Bit 11. Enable hyperlinks export.
 
 DWG2PDFSettingDataE_FlagFlateCompression
 Bit 9. Enable compression of internal PDF streams.
 
 DWG2PDFSettingDataE_FlagIncludeOffLayers
 Bit 6. If enabled, invisible layers will be added to PDF file (1.5 version required).
 
 DWG2PDFSettingDataE_FlagLinearized
 Bit 13. Create linearized PDF file.
 
 DWG2PDFSettingDataE_FlagMeasuring
 Bit 15. Enable measuring scale in pdf.
 
 DWG2PDFSettingDataE_FlagSHXTextAsGeometry
 Bit 3. Enable SHX font text to geometry conversion.
 
 DWG2PDFSettingDataE_FlagSimpleGeomOptimization
 Bit 4. Enable simple geometry optimization (separated segments to one polyline, Bezier curve control points).
 
 DWG2PDFSettingDataE_FlagTTFTextAsGeometry
 Bit 2. Enable TTF font text to geometry conversion.
 
 DWG2PDFSettingDataE_FlagUseHLR
 Bit 8. Determines whether software uses vector hidden-line removal for corresponding viewports.
 
 DWG2PDFSettingDataE_FlagZoomToExtentsMode
 Bit 12. If enabled, layout geometry will be zoomed to paper size, else layout settings will be applied. More...
 
 E_AlignmentCenter
 Center alignment.
 
 E_AlignmentLeft
 Left alignment.
 
 E_AlignmentRight
 Right alignment.
 
 E_ColorSpaceCalGray
 Color space: CalGray. (1 component, A)
 
 E_ColorSpaceCalRGB
 Color space: CalRGB. (3 components, A, B, C)
 
 E_ColorSpaceDeviceCMYK
 Color space: DeviceCMYK. (4 components, C, M, Y, K)
 
 E_ColorSpaceDeviceGray
 Color space: DeviceGray. (1 component, gray)
 
 E_ColorSpaceDeviceN
 Color space: DeviceN.
 
 E_ColorSpaceDeviceRGB
 Color space: DeviceRGB. (3 components, R, G, B)
 
 E_ColorSpaceICCBased
 Color space: ICCBased.
 
 E_ColorSpaceICCBasedDeviceCMYK
 Color space: ICCBased DeviceCMYK. (4 components, C, M, Y, K)
 
 E_ColorSpaceICCBasedDeviceGray
 Color space: ICCBased DeviceGray. (1 component, gray)
 
 E_ColorSpaceICCBasedDeviceRGB
 Color space: ICCBased DeviceRGB. (3 components, R, G, B)
 
 E_ColorSpaceIndexed
 Color space: Indexed.
 
 E_ColorSpaceInvalid
 Color space: Invalid.
 
 E_ColorSpaceLab
 Color space: Lab. (3 components, A, B, C)
 
 E_ColorSpacePattern
 Color space: Pattern.
 
 E_ColorSpaceSeparation
 Color space: Separation.
 
 E_ErrCanNotConnectToServer
 (For ConnectedPDF only) Cannot connect to ConnectedPDF server.
 
 E_ErrCanNotGetACL
 (For ConnectedPDF only) Cannot get the ACL from ConnectedPDF server.
 
 E_ErrCanNotGetClientID
 (For ConnectedPDF only) Cannot get client ID from ConnectedPDF server.
 
 E_ErrCanNotGetUserToken
 (For ConnectedPDF only) Cannot get user token from ConnectedPDF server.
 
 E_ErrCanNotRemoveSecurityFromServer
 (For ConnectedPDF only) Cannot remove the security from ConnectedPDF server.
 
 E_ErrCanNotSetACL
 (For ConnectedPDF only) Cannot set the ACL to ConnectedPDF server.
 
 E_ErrCanNotUploadCDRMInfo
 (For ConnectedPDF only) Cannot upload ConnectedPDF DRM document info to ConnectedPDF server.
 
 E_ErrCanNotUploadDocInfo
 (For ConnectedPDF only) Cannot upload ConnectedPDF document info to ConnectedPDF server.
 
 E_ErrCertificate
 Certificate error: PDF document is encrypted by digital certificate but current user does not have the correct certificate.
 
 E_ErrComplianceEngineInitFailed
 (For compliance only) Fail to initialize compliance engine.
 
 E_ErrComplianceEngineInvalidUnlockCode
 (For compliance only) Invalid unlock code is used to initialize compliance engine.
 
 E_ErrComplianceEngineNotInit
 (For compliance only) Compliance engine has not been initialized successfully.
 
 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.
 
 E_ErrConflict
 New data conflicts with existed data.
 
 E_ErrDataNotReady
 Data is not ready. Usually this is used as an exception error code when loading document in asynchronous way.
 
 E_ErrDefaultTimeStampServer
 Cannot use current default time stamp server. Please check if default time stamp server can be used.
 
 E_ErrDeviceLimitation
 (For ConnectedPDF only) Current device is limited to open the ConnectedPDF DRM document.
 
 E_ErrDiskFull
 (For OCR only) Not enough disk space.
 
 E_ErrExcelHasNoContent
 (For Excel-to-PDF conversion only) Excel document does not have any content so it cannot be converted to PDF file.
 
 E_ErrFile
 File cannot be found or could not be opened.
 
 E_ErrFilePathNotExist
 File or folder path does not exist.
 
 E_ErrFormat
 Format is invalid. For files, this may also mean that file is corrupted.
 
 E_ErrHandle
 Error handle.
 
 E_ErrInvalidACL
 (For ConnectedPDF only) Input ACL is invalid.
 
 E_ErrInvalidClientID
 (For ConnectedPDF only) Input client ID is invalid.
 
 E_ErrInvalidData
 Data of current object is invalid.
 
 E_ErrInvalidLicense
 Invalid license is used to initialize Foxit PDF SDK library.
 
 E_ErrInvalidRegex
 Invalid regular expression.
 
 E_ErrInvalidState
 Invalid or incorrect state.
 
 E_ErrInvalidType
 The type of input object or current object is invalid.
 
 E_ErrInvalidUserToken
 (For ConnectedPDF only) Input user token is invalid.
 
 E_ErrInvalidWrapper
 (For ConnectedPDF only) The input ConnectedPDF DRM wrapper document is invalid.
 
 E_ErrIsAlreadyCDRM
 (For ConnectedPDF only) Loaded document is already a ConnectedPDF DRM document.
 
 E_ErrIsAlreadyCPDF
 (For ConnectedPDF only) Loaded document is already a ConnectedPDF document.
 
 E_ErrLibreofficeEngineNotFound
 (For Office-to-PDF conversion only) Libre office engine is not found.
 
 E_ErrLTVCannotCheckDTS
 (For LTV only) Fail to check DTS.
 
 E_ErrLTVCannotLoadDSS
 (For LTV only) Fail to load DSS.
 
 E_ErrLTVCannotLoadDTS
 (For LTV only) Fail to load DTS.
 
 E_ErrLTVCannotSwitchVersion
 (For LTV only) Fail to switch PDF verion.
 
 E_ErrLTVRevocationCallbackNotSet
 (For LTV only) Revocation callback for LTV has not been set.
 
 E_ErrLTVVerifyModeNotSet
 (For LTV only) LTV verify mode has not been set.
 
 E_ErrMIPCreateProtectionHandlerFailed
 MIP engine: create protection handler failed.
 
 E_ErrMIPGetExtendedLabelInfoByIdFailed
 MIP engine: get extended label information by id failed.
 
 E_ErrMIPProtectionEngineInitFailed
 MIP engine: add upe engine failed.
 
 E_ErrMIPUPEEngineInitFailed
 MIP engine: add upe engine failed.
 
 E_ErrNeedSigned
 (For signature only) The signature being operated needs to be signed.
 
 E_ErrNo3DModuleRight
 No "3D" module right.
 
 E_ErrNoAccessibilityModuleRight
 No "Accessibility" module right.
 
 E_ErrNoAdvEditModuleRight
 No "AdvEdit" module right.
 
 E_ErrNoComparisonModuleRight
 No "Comparison" module right.
 
 E_ErrNoComplianceModuleRight
 No "Compliance" module right.
 
 E_ErrNoConnectedPDFModuleRight
 No "ConnectedPDF" module right.
 
 E_ErrNoConversionModuleRight
 No "Conversion" module right.
 
 E_ErrNoDocumentPermission
 No document permission to operate.
 
 E_ErrNoDWG2PDFModuleRight
 No "DWG2PDF" module right.
 
 E_ErrNoImageObject
 (For PDF Optimizer PDF) There are some objects not image type.
 
 E_ErrNoLayoutRecognitionModuleRight
 No "LayoutRecognition" module right.
 
 E_ErrNoMicroOfficeInstalled
 (For Office-to-PDF conversion only) No Microsoft Office is installed in current system.
 
 E_ErrNoOCRModuleRight
 No "OCR" module right.
 
 E_ErrNoOFDModuleRight
 No "OFD" module right.
 
 E_ErrNoOffice2PDFModuleRight
 No "Office2PDF" module right.
 
 E_ErrNoOptimizerModuleRight
 No "Optimizer" module right.
 
 E_ErrNoPDF2OfficeModuleRight
 No "PDF2Office" module right.
 
 E_ErrNoPrint2PDFModuleRight
 No "Print2PDF" module right.
 
 E_ErrNoRedactionModuleRight
 No "Redaction" module right.
 
 E_ErrNoRights
 (For ConnectedPDF only) Current user has no right to open the ConnectedPDF DRM document.
 
 E_ErrNoRMSModuleRight
 No "RMS" module right.
 
 E_ErrNoTableMakerModuleRight
 No "TableMaker" module right.
 
 E_ErrNotCDRM
 (For ConnectedPDF only) The loaded document is not a ConnectedPDF DRM document.
 
 E_ErrNotFound
 Expected data or object is not found.
 
 E_ErrNotLoaded
 Current object has not been loaded yet.
 
 E_ErrNotParsed
 Content has not been parsed yet. Usually, this represents PDF page has not been parsed yet.
 
 E_ErrNoXFAModuleRight
 No "XFA" module right.
 
 E_ErrOCREngineNotInit
 (For OCR only) OCR engine has not been initialized successfully.
 
 E_ErrOCRTrialIsEnd
 (For OCR only) The trial for OCR module is end.
 
 E_ErrODAEngineNotFound
 (For DWG-to-PDF conversion only) ODA engine is not found.
 
 E_ErrOFDEngineNotInit
 (For OFD only) OFD engine has not been initialized successfully.
 
 E_ErrOfficeComNotInit
 (For Office-to-PDF conversion only) Office COM has not been initialized successfully.
 
 E_ErrOutOfMemory
 Out-of-memory error occurs.
 
 E_ErrParam
 Parameter error: value of any input parameter for a function is invalid.
 
 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.
 
 E_ErrResponseDataError
 (For ConnectedPDF only) There is some error in response data.
 
 E_ErrRightsExpired
 (For ConnectedPDF only) The rights of Current user has expired.
 
 E_ErrSecurityHandler
 PDF document is encrypted by some unsupported security handler.
 
 E_ErrSuccess
 Success, and no error occurs.
 
 E_ErrTimeout
 (For HTML2PDF only)Occuring timeout during loading web page.
 
 E_ErrTimeStampServerMgrNoDefaltServer
 No default server has been set to time stamp server manager yet.
 
 E_ErrTimeStampServerMgrNotInit
 Time stamp server manager has not been initialized successfully.
 
 E_ErrUnknown
 Any unknown error occurs.
 
 E_ErrUnknownState
 Any unknown state occurs.
 
 E_ErrUnsupported
 Some types are not supported.
 
 E_ErrURLInBlackList
 (For converting html to pdf only) The converted URL is on blacklist.
 
 E_ErrWPSEngineNotFound
 (For Office-to-PDF conversion only) WPS office engine is not found.
 
 E_ErrXFALoadError
 XFA loading error.
 
 E_FileFormatTypeFDF
 File format type: FDF.
 
 E_FileFormatTypeHTML
 File format type: HTML.
 
 E_FileFormatTypePDF
 File format type: PDF.
 
 E_FileFormatTypeTXT
 File format type: TXT.
 
 E_FileFormatTypeXDP
 File format type: XDP.
 
 E_FileFormatTypeXFD
 File format type: XFD.
 
 E_FileFormatTypeXFDF
 File format type: XFDF.
 
 E_FileFormatTypeXML
 File format type: XML.
 
 E_FillModeAlternate
 Alternate fill mode, in which the system fills this area between odd-numbered and even-numbered polygon sides on each scan line.
 
 E_FillModeNone
 Fill mode: none.
 
 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.
 
 E_LocaleIDFrance
 Locale ID for country: France.
 
 E_LocaleIDGermany
 Locale ID for country: Germany.
 
 E_LocaleIDHongKong
 Locale ID for region: HongKong.
 
 E_LocaleIDItaly
 Locale ID for country: Italy.
 
 E_LocaleIDJapan
 Locale ID for country: Japan.
 
 E_LocaleIDKorea
 Locale ID for country: Korea.
 
 E_LocaleIDNetherlands
 Locale ID for country: Netherlands.
 
 E_LocaleIDTaiwan
 Locale ID for region: Taiwan.
 
 E_LocaleIDUnspecified
 Locale ID: Unspecified, used when locale is not specified.
 
 E_ModuleName3D
 Name for module "3D".
 
 E_ModuleNameAccessibility
 Name for module "Accessibility".
 
 E_ModuleNameAdvEdit
 Name for module "AdvEdit".
 
 E_ModuleNameComparison
 Name for module "Comparison".
 
 E_ModuleNameCompliance
 Name for module "Compliance".
 
 E_ModuleNameConnectedPDF
 (Reserved, currently, this module is not provided) Name for module "ConnectedPDF".
 
 E_ModuleNameConversion
 Name for module "Conversion".
 
 E_ModuleNameDWG2PDF
 Name for module "DWG2PDF".
 
 E_ModuleNameLayoutRecognition
 (Reserved, currently, this module is not provided) Name for module "LayoutRecognition".
 
 E_ModuleNameOCR
 Name for module "OCR".
 
 E_ModuleNameOFD
 Name for module "OFD".
 
 E_ModuleNameOffice2PDF
 Name for module "Office2PDF".
 
 E_ModuleNameOptimizer
 Name for module "Optimizer".
 
 E_ModuleNamePDF2Office
 Name for module "PDF2Office".
 
 E_ModuleNamePrint2PDF
 Name for module "Print2PDF".
 
 E_ModuleNameRedaction
 Name for module "Redaction".
 
 E_ModuleNameRMS
 Name for module "RMS".
 
 E_ModuleNameTableMaker
 Name for module "TableMaker".
 
 E_ModuleNameXFA
 Name for module "XFA".
 
 E_PosBottomCenter
 Position: bottom center.
 
 E_PosBottomLeft
 Position: bottom left.
 
 E_PosBottomRight
 Position: bottom right.
 
 E_PosCenter
 Position: center.
 
 E_PosCenterLeft
 Position center left.
 
 E_PosCenterRight
 Position: center right.
 
 E_PosTopCenter
 Position: top center.
 
 E_PosTopLeft
 Position: top left.
 
 E_PosTopRight
 Position: top right.
 
 E_Rotation0
 No rotation.
 
 E_Rotation180
 Rotate 180 degrees in clockwise direction.
 
 E_Rotation270
 Rotate 270 degrees in clockwise direction.
 
 E_Rotation90
 Rotate 90 degrees in clockwise direction.
 
 E_RotationPointCenter
 Rotate the text block based on the center point.
 
 E_RotationPointLeftBottom
 Rotate the text block based on the left-bottom point of the rectangle.
 
 E_RotationPointLeftTop
 Rotate the text block based on the left-top point of the rectangle.
 
 E_RotationPointRightBottom
 Rotate the text block based on the right-bottom point of the rectangle.
 
 E_RotationPointRightTop
 Rotate the text block based on the right-top point of the rectangle.
 
 E_RotationUnknown
 Unknown rotation.
 
 Excel2PDFSettingDataE_ConvertQualityMinimum
 Minimum quality.
 
 Excel2PDFSettingDataE_ConvertQualityStandard
 Standard quality.
 
 Excel2PDFSettingDataE_ScaleTypeFitAllColumns
 Fit all columns of one sheet on one page.
 
 Excel2PDFSettingDataE_ScaleTypeFitAllRows
 Fit all rows of one sheet on one page.
 
 Excel2PDFSettingDataE_ScaleTypeFitSheet
 Fit a sheet on one page.
 
 Excel2PDFSettingDataE_ScaleTypeNone
 No scaling.
 
 FDFDocE_FDF
 FDF document type: FDF.
 
 FDFDocE_XFDF
 FDF document type: XFDF.
 
 FieldE_FlagButtonNoToggleToOff
 (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.
 
 FieldE_FlagButtonRadiosInUnison
 (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.
 
 FieldE_FlagChoiceCommitOnSelChange
 (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.
 
 FieldE_FlagChoiceMultiSelect
 (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.
 
 FieldE_FlagChoiceSort
 (Only useful for choice field) If set, the field's option items should be sorted alphabetically.
 
 FieldE_FlagComboEdit
 (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.
 
 FieldE_FlagNoExport
 if set, the field must not be exported by a submit-form action.
 
 FieldE_FlagReadOnly
 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.
 
 FieldE_FlagRequired
 If set, the field must have a value at the time it is exported by a submit-form action.
 
 FieldE_FlagTextComb
 (Only useful for text field) If set, use combs. More...
 
 FieldE_FlagTextDoNotScroll
 (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.
 
 FieldE_FlagTextFileSelect
 (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.
 
 FieldE_FlagTextMultiline
 (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.
 
 FieldE_FlagTextNoSpellCheck
 (Only useful for text field) If set, text entered in the field is not spell-checked.
 
 FieldE_FlagTextPassword
 (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. More...
 
 FieldE_FlagTextRichText
 (Only useful for text field) If set, the value of this field should be represented as a rich text string.
 
 FieldE_TypeCheckBox
 Form field type: check box.
 
 FieldE_TypeComboBox
 Form field type: combo box.
 
 FieldE_TypeListBox
 Form field type: list box.
 
 FieldE_TypePushButton
 Form field type: push button.
 
 FieldE_TypeRadioButton
 Form field type: radio button.
 
 FieldE_TypeSignature
 Form field type: signature field.
 
 FieldE_TypeTextField
 Form field type: text field.
 
 FieldE_TypeUnknown
 Form field type: unknown.
 
 FillerAssistCallbackE_PopupMenuItemCopy
 Popup menu item: "Copy".
 
 FillerAssistCallbackE_PopupMenuItemCut
 Popup menu item: "Cut".
 
 FillerAssistCallbackE_PopupMenuItemDelete
 Popup menu item: "Delete".
 
 FillerAssistCallbackE_PopupMenuItemNone
 No popup menu item.
 
 FillerAssistCallbackE_PopupMenuItemPaste
 Popup menu item: "Paste".
 
 FillerAssistCallbackE_PopupMenuItemSelectAll
 Popup menu item: "Select All".
 
 FillerE_EventFlagAltKey
 Event flag: "Alt" key.
 
 FillerE_EventFlagAutoRepeat
 Event flag: auto repeat.
 
 FillerE_EventFlagCommand
 Event flag: the command key.
 
 FillerE_EventFlagControlKey
 Event flag: "Ctrl" key.
 
 FillerE_EventFlagKeyPad
 Event flag: key pad.
 
 FillerE_EventFlagLeftButtonDown
 Event flag: the left button of the mouse is down.
 
 FillerE_EventFlagMetaKey
 Event flag: meta key.
 
 FillerE_EventFlagMiddleButtonDown
 Event flag: the middle button of the mouse is down.
 
 FillerE_EventFlagRightButtonDown
 Event flag: the right button of the mouse is down.
 
 FillerE_EventFlagShiftKey
 Event flag: "Shift" key.
 
 FillerE_Vkey0
 0 key.
 
 FillerE_Vkey1
 1 key.
 
 FillerE_Vkey2
 2 key.
 
 FillerE_Vkey3
 3 key.
 
 FillerE_Vkey4
 4 key.
 
 FillerE_Vkey5
 5 key.
 
 FillerE_Vkey6
 6 key.
 
 FillerE_Vkey7
 7 key.
 
 FillerE_Vkey8
 8 key.
 
 FillerE_Vkey9
 9 key.
 
 FillerE_VkeyA
 A key.
 
 FillerE_VkeyAdd
 Plus key in the numeric keypad.
 
 FillerE_VkeyB
 B key.
 
 FillerE_VkeyBack
 Backspace key.
 
 FillerE_VkeyC
 C key.
 
 FillerE_VkeyControl
 Ctrl key.
 
 FillerE_VkeyD
 D key.
 
 FillerE_VkeyDecimal
 Dot key in the numeric keypad.
 
 FillerE_VkeyDelete
 Delete key.
 
 FillerE_VkeyDivide
 Slash key in the numeric keypad.
 
 FillerE_VkeyDown
 Down arrow key.
 
 FillerE_VkeyE
 E key.
 
 FillerE_VkeyEnd
 End key.
 
 FillerE_VkeyEscape
 ESC key.
 
 FillerE_VkeyF
 F key.
 
 FillerE_VkeyF1
 F1 key.
 
 FillerE_VkeyF10
 F10 key.
 
 FillerE_VkeyF11
 F11 key.
 
 FillerE_VkeyF12
 F12 key.
 
 FillerE_VkeyF2
 F2 key.
 
 FillerE_VkeyF3
 F3 key.
 
 FillerE_VkeyF4
 F4 key.
 
 FillerE_VkeyF5
 F5 key.
 
 FillerE_VkeyF6
 F6 key.
 
 FillerE_VkeyF7
 F7 key.
 
 FillerE_VkeyF8
 F8 key.
 
 FillerE_VkeyF9
 F9 key.
 
 FillerE_VkeyG
 G key.
 
 FillerE_VkeyH
 H key.
 
 FillerE_VkeyHelp
 Help key.
 
 FillerE_VkeyHome
 Home key.
 
 FillerE_VkeyI
 I key.
 
 FillerE_VkeyInsert
 Insert key.
 
 FillerE_VkeyJ
 J key.
 
 FillerE_VkeyK
 K key.
 
 FillerE_VkeyL
 L key.
 
 FillerE_VkeyLeft
 Left arrow key.
 
 FillerE_VkeyM
 M key.
 
 FillerE_VkeyMenu
 Menu key.
 
 FillerE_VkeyMultiply
 Multiply key in the numeric keypad.
 
 FillerE_VkeyN
 N key.
 
 FillerE_VkeyNext
 Page Down key.
 
 FillerE_VkeyNumpad0
 0 key in the numeric keypad.
 
 FillerE_VkeyNumpad1
 1 key in the numeric keypad.
 
 FillerE_VkeyNumpad2
 2 key in the numeric keypad.
 
 FillerE_VkeyNumpad3
 3 key in the numeric keypad.
 
 FillerE_VkeyNumpad4
 4 key in the numeric keypad.
 
 FillerE_VkeyNumpad5
 5 key in the numeric keypad.
 
 FillerE_VkeyNumpad6
 6 key in the numeric keypad.
 
 FillerE_VkeyNumpad7
 7 key in the numeric keypad.
 
 FillerE_VkeyNumpad8
 8 key in the numeric keypad.
 
 FillerE_VkeyNumpad9
 9 key in the numeric keypad.
 
 FillerE_VkeyO
 O key.
 
 FillerE_VkeyP
 P key.
 
 FillerE_VkeyPause
 Pause Break key.
 
 FillerE_VkeyPrint
 Print key.
 
 FillerE_VkeyPrior
 Page Up key.
 
 FillerE_VkeyQ
 Q key.
 
 FillerE_VkeyR
 R key.
 
 FillerE_VkeyReturn
 Enter key.
 
 FillerE_VkeyRight
 Right arrow key.
 
 FillerE_VkeyS
 S key.
 
 FillerE_VkeySeparator
 Enter key in the numeric keypad.
 
 FillerE_VkeyShift
 Shift key.
 
 FillerE_VkeySnapshot
 Print Screen key.
 
 FillerE_VkeySpace
 Space key.
 
 FillerE_VkeySubtract
 Minus key in the numeric keypad.
 
 FillerE_VkeyT
 T key.
 
 FillerE_VkeyTab
 Tab key.
 
 FillerE_VkeyU
 U key.
 
 FillerE_VkeyUnknown
 An unknown key.
 
 FillerE_VkeyUp
 Up arrow key.
 
 FillerE_VkeyV
 V key.
 
 FillerE_VkeyW
 W key.
 
 FillerE_VkeyX
 X key.
 
 FillerE_VkeyY
 Y key.
 
 FillerE_VkeyZ
 Z key.
 
 FillSignE_FillSignObjectTypeCheckMark
 Check mark fill-sign object.
 
 FillSignE_FillSignObjectTypeCrossMark
 Cross mark fill-sign object.
 
 FillSignE_FillSignObjectTypeDot
 Dot fill-sign object.
 
 FillSignE_FillSignObjectTypeInitialsSignature
 Initials signature fill-sign object.
 
 FillSignE_FillSignObjectTypeLine
 Line fill-sign object.
 
 FillSignE_FillSignObjectTypeRoundRectangle
 Round rectangle fill-sign object.
 
 FillSignE_FillSignObjectTypeSignature
 Signature fill-sign object.
 
 FillSignE_FillSignObjectTypeText
 Text fill-sign object.
 
 FloatingInfoE_OffScreenAllow
 Off screen action: take no action.
 
 FloatingInfoE_OffScreenCancel
 Off screen action: cancel playing the media clip.
 
 FloatingInfoE_OffScreenForceOnScreen
 Off screen action: move or resize the window so that it is on-screen.
 
 FloatingInfoE_RelativeTargetAppWindow
 Relative type: align the floating window relative to the application window.
 
 FloatingInfoE_RelativeTargetDesktop
 Relative type: align the floating window relative to the full virtual desktop.
 
 FloatingInfoE_RelativeTargetMonitor
 Relative type: align the floating window relative to the (selected) monitor display screen.
 
 FloatingInfoE_RelativeTargetPageWindow
 Relative type: align the floating window relative to the document (page) window.
 
 FloatingInfoE_ResizeTypeKeepRatio
 Resize type: may be resized only if the aspect ratio is preserved.
 
 FloatingInfoE_ResizeTypeNo
 Resize type: may not be resized.
 
 FloatingInfoE_ResizeTypeYes
 Resize type: may be resized without preserving the aspect ratio.
 
 FloatingInfoE_WindowPositionBottomCenter
 Window position: at the bottom center.
 
 FloatingInfoE_WindowPositionBottomLeft
 Window position: at the bottom left corner.
 
 FloatingInfoE_WindowPositionBottomRight
 Window position: at the bottom right corner.
 
 FloatingInfoE_WindowPositionCenter
 Window position: at the center.
 
 FloatingInfoE_WindowPositionCenterLeft
 Window position: at the center left.
 
 FloatingInfoE_WindowPositionCenterRight
 Window position: at the center right.
 
 FloatingInfoE_WindowPositionTopCenter
 Window position: at the top center.
 
 FloatingInfoE_WindowPositionTopLeft
 Window position: at the top left corner.
 
 FloatingInfoE_WindowPositionTopRight
 Window position: at the top right corner.
 
 FontE_CharsetANSI
 Font charset: ANSI (United States, Western Europe).
 
 FontE_CharsetArabic
 Font charset: Arabic.
 
 FontE_CharsetBaltic
 Font charset: Baltic.
 
 FontE_CharsetChineseBig5
 Font charset: Traditional Chinese.
 
 FontE_CharsetDefault
 Font charset: System default, for unknown or mapping purpose.
 
 FontE_CharsetEastEurope
 Font charset: Eastern European.
 
 FontE_CharsetGB2312
 Font charset: Simplified Chinese.
 
 FontE_CharsetGreek
 Font charset: Greek.
 
 FontE_CharsetHangeul
 Font charset: Korean (Wansung).
 
 FontE_CharsetHebrew
 Font charset: Hebrew.
 
 FontE_CharsetRussian
 Font charset: Russian.
 
 FontE_CharsetShift_JIS
 Font charset: Japanese (Shift-JIS).
 
 FontE_CharsetSymbol
 Font charset: Standard symbols.
 
 FontE_CharsetThai
 Font charset: Thai.
 
 FontE_CharsetTurkish
 Font charset: Turkish.
 
 FontE_CIDCharsetCNS1
 CID Font charset: Adobe-CNS1.
 
 FontE_CIDCharsetGB1
 CID Font charset: Adobe-GB1.
 
 FontE_CIDCharsetJAPAN1
 CID Font charset: Adobe-Japan1.
 
 FontE_CIDCharsetKOREA1
 CID Font charset: Adobe-Korea1.
 
 FontE_CIDCharsetUNICODE
 CID Font charset: Unicode.
 
 FontE_CIDCharsetUnknown
 CID Font charset: Unknown.
 
 FontE_FontTypeCIDFont
 Font type: CID font.
 
 FontE_FontTypeTrueType
 Font type: TrueType.
 
 FontE_FontTypeType1
 Font type: Type1.
 
 FontE_FontTypeType3
 Font type: Type3.
 
 FontE_StdIDCourier
 Standard font: Courier.
 
 FontE_StdIDCourierB
 Standard font: Courier-Bold.
 
 FontE_StdIDCourierBI
 Standard font: Courier-BoldOblique, Bold italic.
 
 FontE_StdIDCourierI
 Standard font: Courier-Oblique, Italic.
 
 FontE_StdIDHelvetica
 Standard font: Helvetica.
 
 FontE_StdIDHelveticaB
 Standard font: Helvetica-Bold.
 
 FontE_StdIDHelveticaBI
 Standard font: Helvetica-BoldOblique, Bold italic.
 
 FontE_StdIDHelveticaI
 Standard font: Helvetica-Oblique, Italic.
 
 FontE_StdIDSymbol
 Standard font: Symbol.
 
 FontE_StdIDTimes
 Standard font: Times-Roman.
 
 FontE_StdIDTimesB
 Standard font: Times-Bold.
 
 FontE_StdIDTimesBI
 Standard font: Times-BoldItalic.
 
 FontE_StdIDTimesI
 Standard font: Times-Italic.
 
 FontE_StdIDZapfDingbats
 Standard font: ZapfDingbats.
 
 FontE_StyleAllCap
 Font style: all cap.
 
 FontE_StyleFixedPitch
 Font style: fixed pitch.
 
 FontE_StyleItalic
 Font style: italic.
 
 FontE_StyleNonSymbolic
 Font style: non-symbolic.
 
 FontE_StylesBold
 Font style: force bold.
 
 FontE_StyleScript
 Font style: script.
 
 FontE_StyleSerif
 Font style: serif.
 
 FontE_StylesSmallCap
 Font style: small cap.
 
 FontE_StyleSymbolic
 Font style: symbolic.
 
 FullTextSearchE_RankHitCountASC
 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).
 
 FullTextSearchE_RankHitCountDESC
 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).
 
 FullTextSearchE_RankNone
 No ranking mode is used for searching results.
 
 GraphicsObjectE_BlendColor
 Creates a color with the hue and saturation of the source color, and the luminosity of the backdrop color. More...
 
 GraphicsObjectE_BlendColorBurn
 Darkens backdrop color to reflect the source color. More...
 
 GraphicsObjectE_BlendColorDodge
 Brightens backdrop color to reflect source colors. More...
 
 GraphicsObjectE_BlendDarken
 Select darker one of backdrop and source colors. More...
 
 GraphicsObjectE_BlendDifference
 Subtracts the darker of the two constituent colors from lighter colors. More...
 
 GraphicsObjectE_BlendExclusion
 Creates a color with the hue of the source color, and the saturation and luminosity of the backdrop color. More...
 
 GraphicsObjectE_BlendHardlight
 Multiply or screens colors, depending on source color value. More...
 
 GraphicsObjectE_BlendHue
 Creates a color with the hue of the source color, and the saturation and luminosity of the backdrop color. More...
 
 GraphicsObjectE_BlendLighten
 Select lighter one of backdrop and source colors. More...
 
 GraphicsObjectE_BlendLuminosity
 Creates a color with the luminosity of the source color, and the hue and saturation of the backdrop color. More...
 
 GraphicsObjectE_BlendMultiply
 Multiply backdrop by source color values. More...
 
 GraphicsObjectE_BlendNormal
 Selecting source color and ignoring backdrop color. More...
 
 GraphicsObjectE_BlendOverlay
 Multiply or screens colors, depending on backdrop color value. More...
 
 GraphicsObjectE_BlendSaturation
 Creates a color with the saturation of the source color, and the hue and luminosity of the backdrop color. More...
 
 GraphicsObjectE_BlendScreen
 Multiply complements of backdrop by source color values, and then complement the result. More...
 
 GraphicsObjectE_BlendSoftlight
 Darkens or lightens colors, depending on source color value. More...
 
 GraphicsObjectE_TypeAll
 Represents all graphics object types, only used as filter.
 
 GraphicsObjectE_TypeEmptyMarkedContent
 Empty marked-content object.
 
 GraphicsObjectE_TypeFormXObject
 Form XObject graphics object.
 
 GraphicsObjectE_TypeImage
 Image graphics object.
 
 GraphicsObjectE_TypeInlines
 Inline graphics object.
 
 GraphicsObjectE_TypePath
 Path graphics object.
 
 GraphicsObjectE_TypeShading
 Shading graphics object.
 
 GraphicsObjectE_TypeText
 Text graphics object.
 
 GraphicsObjectsE_TextMergeBTET
 Merge consecutive BTETs as a new one. More...
 
 GraphicsObjectsE_TextMergeNone
 No text merge.
 
 GraphicsObjectsE_TextMergeTJY
 Merge consecutive text-showing operators with equal y coordinates.
 
 GraphStateE_LineCapButt
 Butt cap. The stroke is squared off at the endpoint of a path. There is no projection beyond the end of a path.
 
 GraphStateE_LineCapRound
 Round cap. A semicircular arc with a diameter equal to the line width is drawn around the endpoint and filled in.
 
 GraphStateE_LineCapSquare
 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.
 
 GraphStateE_LineJoinBevel
 Bevel line join type. More...
 
 GraphStateE_LineJoinMiter
 Miter line join type. More...
 
 GraphStateE_LineJoinRound
 Round line join type. More...
 
 HeaderFooterContentGeneratorE_DateFormatDDDotMMDotYY
 If this is used, "dd.mm.yy" would be used as the date format string.
 
 HeaderFooterContentGeneratorE_DateFormatDDDotMMDotYYYY
 If this is used, "dd.mm.yyyy" would be used as the date format string.
 
 HeaderFooterContentGeneratorE_DateFormatDDotMDotYYYY
 If this is used, "d.m.yyyy" would be used as the date format string.
 
 HeaderFooterContentGeneratorE_DateFormatDDSlashMMSlashYY
 If this is used, "dd/mm/yy" would be used as the date format string.
 
 HeaderFooterContentGeneratorE_DateFormatDDSlashMMSlashYYYY
 If this is used, "dd/mm/yyyy" would be used as the date format string.
 
 HeaderFooterContentGeneratorE_DateFormatDSlashMSlashYY
 If this is used, "d/m/yy" would be used as the date format string.
 
 HeaderFooterContentGeneratorE_DateFormatDSlashMSlashYYYY
 If this is used, "d/m/yyyy" would be used as the date format string.
 
 HeaderFooterContentGeneratorE_DateFormatMDotDDotYY
 If this is used, "m.d.yy" would be used as the date format string.
 
 HeaderFooterContentGeneratorE_DateFormatMDotDDotYYYY
 If this is used, "m.d.yyyy" would be used as the date format string.
 
 HeaderFooterContentGeneratorE_DateFormatMMDotDDDotYY
 If this is used, "mm.dd.yy" would be used as the date format string.
 
 HeaderFooterContentGeneratorE_DateFormatMMDotDDDotYYYY
 If this is used, "mm.dd.yyyy" would be used as the date format string.
 
 HeaderFooterContentGeneratorE_DateFormatMMDotYY
 If this is used, "mm.yy" would be used as the date format string.
 
 HeaderFooterContentGeneratorE_DateFormatMMSlashDDSlashYY
 If this is used, "mm/dd/yy" would be used as the date format string.
 
 HeaderFooterContentGeneratorE_DateFormatMMSlashDDSlashYYYY
 If this is used, "mm/dd/yyyy" would be used as the date format string.
 
 HeaderFooterContentGeneratorE_DateFormatMMSlashYY
 If this is used, "mm/yy" would be used as the date format string.
 
 HeaderFooterContentGeneratorE_DateFormatMMSlashYYYY
 If this is used, "mm/yyyy" would be used as the date format string.
 
 HeaderFooterContentGeneratorE_DateFormatMSlashD
 If this is used, "m/d" would be used as the date format string.
 
 HeaderFooterContentGeneratorE_DateFormatMSlashDSlashYY
 If this is used, "m/d/yy" would be used as the date format string.
 
 HeaderFooterContentGeneratorE_DateFormatMSlashDSlashYYYY
 If this is used, "m/d/yyyy" would be used as the date format string.
 
 HeaderFooterContentGeneratorE_DateFormatYYHyphenMMHyphenDD
 If this is used, "yy-mm-dd" would be used as the date format string.
 
 HeaderFooterContentGeneratorE_DateFormatYYYYHyphenMMHyphenDD
 If this is used, "yyyy-mm-dd" would be used as the date format string.
 
 HeaderFooterContentGeneratorE_PageNumberFormatDefault
 If this is used, "1" would be used as the page number format string.
 
 HeaderFooterContentGeneratorE_PageNumberFormatNumberOfCount
 If this is used, "1 of n" would be used as the page number format string.
 
 HeaderFooterContentGeneratorE_PageNumberFormatNumberSlashCount
 If this is used, "1/n" would be used as the page number format string.
 
 HeaderFooterContentGeneratorE_PageNumberFormatPageNumber
 If this is used, "Page 1" would be used as the page number format string.
 
 HeaderFooterContentGeneratorE_PageNumberFormatPageNumberOfCount
 If this is used, "Page 1 of n" would be used as the page number format string.
 
 HTML2PDFSettingDataE_EncodingFormatArabic
 Encoding foramt: "Arabic".
 
 HTML2PDFSettingDataE_EncodingFormatASCII
 Encoding foramt: "ASCII".
 
 HTML2PDFSettingDataE_EncodingFormatASCII_7_bit
 Encoding foramt: "ASCII-7-bit".
 
 HTML2PDFSettingDataE_EncodingFormatBHASKAR
 Encoding foramt: "BHASKAR".
 
 HTML2PDFSettingDataE_EncodingFormatBIG5
 Encoding foramt: "BIG5".
 
 HTML2PDFSettingDataE_EncodingFormatBIG5_CP950
 Encoding foramt: "BIG5-CP950".
 
 HTML2PDFSettingDataE_EncodingFormatBIG5_HKSCS
 Encoding foramt: "BIG5_HKSCS".
 
 HTML2PDFSettingDataE_EncodingFormatCNS
 Encoding foramt: "CNS".
 
 HTML2PDFSettingDataE_EncodingFormatCP1250
 Encoding foramt: "CP1250".
 
 HTML2PDFSettingDataE_EncodingFormatCP1251
 Encoding foramt: "CP1251".
 
 HTML2PDFSettingDataE_EncodingFormatCP1252
 Encoding foramt: "CP1252".
 
 HTML2PDFSettingDataE_EncodingFormatCP1253
 Encoding foramt: "CP1253".
 
 HTML2PDFSettingDataE_EncodingFormatCP1254
 Encoding foramt: "CP1254".
 
 HTML2PDFSettingDataE_EncodingFormatCP1255
 Encoding foramt: "CP1255".
 
 HTML2PDFSettingDataE_EncodingFormatCP1256
 Encoding foramt: "CP1256".
 
 HTML2PDFSettingDataE_EncodingFormatCP1257
 Encoding foramt: "CP1257".
 
 HTML2PDFSettingDataE_EncodingFormatCP852
 Encoding foramt: "CP852".
 
 HTML2PDFSettingDataE_EncodingFormatCP866
 Encoding foramt: "CP866".
 
 HTML2PDFSettingDataE_EncodingFormatCP874
 Encoding foramt: "CP874".
 
 HTML2PDFSettingDataE_EncodingFormatCP932
 Encoding foramt: "CP932".
 
 HTML2PDFSettingDataE_EncodingFormatCSN_369103
 Encoding foramt: "CSN_369103".
 
 HTML2PDFSettingDataE_EncodingFormatDefault
 Encoding foramt: Default.The encoding format will be automatically detected in chromium.
 
 HTML2PDFSettingDataE_EncodingFormatEUC
 Encoding foramt: "EUC".
 
 HTML2PDFSettingDataE_EncodingFormatEUC_CN
 Encoding foramt: "EUC-CN".
 
 HTML2PDFSettingDataE_EncodingFormatEUC_JP
 Encoding foramt: "EUC-JP".
 
 HTML2PDFSettingDataE_EncodingFormatGB
 Encoding foramt: "GB".
 
 HTML2PDFSettingDataE_EncodingFormatGB18030
 Encoding foramt: "GB18030".
 
 HTML2PDFSettingDataE_EncodingFormatGBK
 Encoding foramt: "GBK".
 
 HTML2PDFSettingDataE_EncodingFormatGreek
 Encoding foramt: "Greek".
 
 HTML2PDFSettingDataE_EncodingFormatHebrew
 Encoding foramt: "Hebrew".
 
 HTML2PDFSettingDataE_EncodingFormatHTCHANAKYA
 Encoding foramt: "HTCHANAKYA".
 
 HTML2PDFSettingDataE_EncodingFormatHZ_GB_2312
 Encoding foramt: "HZ-GB-2312".
 
 HTML2PDFSettingDataE_EncodingFormatISO_2022_CN
 Encoding foramt: "ISO_2022_CN".
 
 HTML2PDFSettingDataE_EncodingFormatISO_2022_KR
 Encoding foramt: "ISO-2022-KR".
 
 HTML2PDFSettingDataE_EncodingFormatISO_8859_11
 Encoding foramt: "ISO-8859-11".
 
 HTML2PDFSettingDataE_EncodingFormatISO_8859_13
 Encoding foramt: "ISO-8859-13".
 
 HTML2PDFSettingDataE_EncodingFormatISO_8859_15
 Encoding foramt: "ISO-8859-15".
 
 HTML2PDFSettingDataE_EncodingFormatISO_8859_5
 Encoding foramt: "ISO-8859-5".
 
 HTML2PDFSettingDataE_EncodingFormatISO_8859_8_I
 Encoding foramt: "ISO-8859-8-I".
 
 HTML2PDFSettingDataE_EncodingFormatJAGRAN
 Encoding foramt: "JAGRAN".
 
 HTML2PDFSettingDataE_EncodingFormatJIS
 Encoding foramt: "JIS".
 
 HTML2PDFSettingDataE_EncodingFormatKOI8R
 Encoding foramt: "KOI8R".
 
 HTML2PDFSettingDataE_EncodingFormatKOI8U
 Encoding foramt: "KOI8U".
 
 HTML2PDFSettingDataE_EncodingFormatKSC
 Encoding foramt: "KSC".
 
 HTML2PDFSettingDataE_EncodingFormatLatin2
 Encoding foramt: "Latin2".
 
 HTML2PDFSettingDataE_EncodingFormatLatin3
 Encoding foramt: "Latin3".
 
 HTML2PDFSettingDataE_EncodingFormatLatin4
 Encoding foramt: "Latin4".
 
 HTML2PDFSettingDataE_EncodingFormatLatin5
 Encoding foramt: "Latin5".
 
 HTML2PDFSettingDataE_EncodingFormatLatin6
 Encoding foramt: "Latin6".
 
 HTML2PDFSettingDataE_EncodingFormatMACINTOSH
 Encoding foramt: "MACINTOSH".
 
 HTML2PDFSettingDataE_EncodingFormatSJS
 Encoding foramt: "SJS".
 
 HTML2PDFSettingDataE_EncodingFormatTAB
 Encoding foramt: "TAB".
 
 HTML2PDFSettingDataE_EncodingFormatTAM
 Encoding foramt: "TAM".
 
 HTML2PDFSettingDataE_EncodingFormatTSCII
 Encoding foramt: "TSCII".
 
 HTML2PDFSettingDataE_EncodingFormatUnicode
 Encoding foramt: "Unicode".
 
 HTML2PDFSettingDataE_EncodingFormatUTF7
 Encoding foramt: "UTF7".
 
 HTML2PDFSettingDataE_EncodingFormatUTF_16BE
 Encoding foramt: "UTF-16BE".
 
 HTML2PDFSettingDataE_EncodingFormatUTF_16LE
 Encoding foramt: "UTF-16LE".
 
 HTML2PDFSettingDataE_EncodingFormatUTF_32BE
 Encoding foramt: "UTF-32BE".
 
 HTML2PDFSettingDataE_EncodingFormatUTF_32LE
 Encoding foramt: "UTF-32LE".
 
 HTML2PDFSettingDataE_EncodingFormatVISUAL
 Encoding foramt: "VISUAL".
 
 HTML2PDFSettingDataE_EncodingFormatX_BINARYENC
 Encoding foramt: "X-BINARYENC".
 
 HTML2PDFSettingDataE_EncodingFormatX_DoCoMo_Shift_JIS
 Encoding foramt: "X-DoCoMo-Shift_JIS".
 
 HTML2PDFSettingDataE_EncodingFormatX_KDDI_ISO_2022_JP
 Encoding foramt: "X-KDDI-ISO-2022-JP".
 
 HTML2PDFSettingDataE_EncodingFormatX_KDDI_Shift_JIS
 Encoding foramt: "X-KDDI-Shift_JIS".
 
 HTML2PDFSettingDataE_EncodingFormatX_SoftBank_ISO_2022_JP
 Encoding foramt: "X-SoftBank-ISO-2022-JP".
 
 HTML2PDFSettingDataE_EncodingFormatX_SoftBank_Shift_JIS
 Encoding foramt: "X-SoftBank-Shift_JIS".
 
 HTML2PDFSettingDataE_EncodingFormatX_TAM_ELANGO
 Encoding foramt: "X-TAM-ELANGO".
 
 HTML2PDFSettingDataE_EncodingFormatX_TAM_LTTMBARANI
 Encoding foramt: "X-TAM-LTTMBARANI".
 
 HTML2PDFSettingDataE_EncodingFormatX_TAM_SHREE
 Encoding foramt: "X-TAM-SHREE".
 
 HTML2PDFSettingDataE_EncodingFormatX_TAM_TBOOMIS
 Encoding foramt: "X-TAM-TBOOMIS".
 
 HTML2PDFSettingDataE_EncodingFormatX_TAM_TMNEWS
 Encoding foramt: "X-TAM-TMNEWS".
 
 HTML2PDFSettingDataE_EncodingFormatX_TAM_WEBTAMIL
 Encoding foramt: "X-TAM-WEBTAMIL".
 
 HTML2PDFSettingDataE_EncodingFormatX_UTF8UTF8
 Encoding foramt: "X-UTF8UTF8".
 
 HTML2PDFSettingDataE_MediaStylePrint
 Media style: print. It means PDF page will be displayed in print media style.
 
 HTML2PDFSettingDataE_MediaStyleScreen
 Media style: screen. It means PDF page will be displayed in screen media style.
 
 HTML2PDFSettingDataE_PageModeMultiplePage
 Multiple page mode.
 
 HTML2PDFSettingDataE_PageModeSinglePage
 Single page mode.
 
 HTML2PDFSettingDataE_ScalingModeEnlarge
 Page scaling: Enlarge. It means PDF page will be enlarged to HTML content size. In this mode, the text size of HTML content will not be changed.
 
 HTML2PDFSettingDataE_ScalingModeNone
 Scaling mode: Fixed page with no scale. In this mode, the text size of HTML content will not be changed.
 
 HTML2PDFSettingDataE_ScalingModeScale
 Page scaling: Scale. It means HTML content will be scaled to fit PDF page size. In this mode, the text size may be changed.
 
 IconFitE_ScaleWayAlways
 Always scale.
 
 IconFitE_ScaleWayBigger
 Scale only when icon is bigger than annotation rectangle.
 
 IconFitE_ScaleWayNever
 Never scale.
 
 IconFitE_ScaleWayNone
 No scaling way is specified.
 
 IconFitE_ScaleWaySmaller
 Scale only when icon is smaller than annotation rectangle.
 
 ImageE_BMP
 Image type is BMP.
 
 ImageE_GIF
 Image type is GIF.
 
 ImageE_JBIG2
 Image type is JBIG2. More...
 
 ImageE_JPG
 Image type is JPG or JPEG.
 
 ImageE_JPX
 Image type is JPX or JPEG-2000.
 
 ImageE_None
 Not have image type yet. More...
 
 ImageE_OrientationFlipH
 Flip Horizontal.
 
 ImageE_OrientationFlipV
 Flip Vertical.
 
 ImageE_OrientationNone
 No orientation.
 
 ImageE_OrientationNormal
 Normal orientation.
 
 ImageE_OrientationRotate180
 Rotate 180 degrees in clockwise direction.
 
 ImageE_OrientationRotate270
 Rotate 90 degrees in counter-clockwise direction.
 
 ImageE_OrientationRotate270FlipH
 First rotate 90 in counter-clockwise direction and then flip horizontal.
 
 ImageE_OrientationRotate90
 Rotate 90 degrees in clockwise direction.
 
 ImageE_OrientationRotate90FlipH
 First rotate 90 in clockwise direction and then flip horizontal.
 
 ImageE_PNG
 Image type is PNG.
 
 ImageE_TIF
 Image type is TIF or TIFF.
 
 ImageE_Unknown
 Unknown image type.
 
 ImageE_WEBP
 Image type is webp. More...
 
 ImageSettingsE_ImageCompressHigh
 Compression mode: high.
 
 ImageSettingsE_ImageCompressjpeg
 Compression mode: jpeg.
 
 ImageSettingsE_ImageCompressjpeg2000
 Compression mode: jpeg2000.
 
 ImageSettingsE_ImageCompressQualityHigh
 Compression quality: High.
 
 ImageSettingsE_ImageCompressQualityLossless
 Compression quality: Lossless, only for jpeg2000 compress mode.
 
 ImageSettingsE_ImageCompressQualityLow
 Compression quality: Low.
 
 ImageSettingsE_ImageCompressQualityMaximum
 Compression quality: Maximum.
 
 ImageSettingsE_ImageCompressQualityMedium
 Compression quality: Medium.
 
 ImageSettingsE_ImageCompressQualityMinimum
 Compression quality: Minimum.
 
 ImageSettingsE_ImageCompressRetain
 Compression mode: retain, which means no compression.
 
 ImageSettingsE_ImageCompressZip
 Compression mode: zip.
 
 ImageSettingsE_StretchBicubic
 When this is set, that means to do bicubic interpolation for zooming.
 
 ImageSettingsE_StretchDefault
 When this is set, that means to do default stretching.
 
 ImageSettingsE_StretchDownsample
 When this is set, that means not to do halftone for shrinking or rotating.
 
 ImageSettingsE_StretchInterpol
 When this is set, that means to do interpolation for zooming.
 
 ImageSettingsE_StretchNoSmooth
 When this is set, that means not to do any interpolation for stretching.
 
 ImageSettingsE_StretchOff
 When this is set, that means to do without stretching.
 
 JoinSplitE_JoinSplitOperationTypeClose
 Join spilt operation type: Close.
 
 JoinSplitE_JoinSplitOperationTypeJoin
 Join spilt operation type: Join.
 
 JoinSplitE_JoinSplitOperationTypeLink
 Join spilt operation type: Link.
 
 JoinSplitE_JoinSplitOperationTypeSelectNone
 Join spilt operation type: SelectNone.
 
 JoinSplitE_JoinSplitOperationTypeSpilt
 Join spilt operation type: Spilt.
 
 JoinSplitE_JoinSplitOperationTypeUnlink
 Join spilt operation type: Unlink.
 
 LayerContextE_UsageDesign
 Use for representing a document designer's structural organization of artwork.
 
 LayerContextE_UsageExport
 Use for exporting.
 
 LayerContextE_UsagePrint
 Use for printing.
 
 LayerContextE_UsageView
 Use for a viewer.
 
 LayerContextE_UsageZoom
 Use for zooming.
 
 LayerTreeE_StateOFF
 The state is OFF.
 
 LayerTreeE_StateON
 The state is ON.
 
 LayerTreeE_StateUnchanged
 The state is unchanged.
 
 LayerTreeE_StateUndefined
 The state is undefined.
 
 LRElementE_ElementTypeAnnot
 Structure element type: Annot, which means "Annotation" and represents an association between a portion of the ILSE's content and a corresponding PDF annotation.
 
 LRElementE_ElementTypeAnnotContent
 Structure element type: AnnotContent, which means annotation content element.
 
 LRElementE_ElementTypeAnnotObject
 Structure element type: AnnotObject, which means annotation object element.
 
 LRElementE_ElementTypeArt
 Structure element type: Art, which means "Article" and represents a relatively self-contained body of text constituting a single narrative or exposition.
 
 LRElementE_ElementTypeArtifact
 Structure element type: Artifact, which includes other Pagination, Layout, Page and Background artifacts.
 
 LRElementE_ElementTypeAside
 Structure element type: Aside (PDF 2.0), which represents content that is distinct from other content within its parent structure element.
 
 LRElementE_ElementTypeBibEntry
 Structure element type: BibEntry, which means "Bibliography entry" and represents a reference identifying the external source of some cited content.
 
 LRElementE_ElementTypeBlockQuote
 Structure element type: BlockQuote, which means "Block quotation" and represents a portion of text consisting of one or more paragraphs attributed to someone other than the author of the surrounding text.
 
 LRElementE_ElementTypeCaption
 Structure element type: Caption, which represents a brief portion of text describing a table or figure.
 
 LRElementE_ElementTypeCode
 Structure element type: Code, which represents a fragment of computer program text.
 
 LRElementE_ElementTypeComplexContent
 Structure element type: ComplexContent, which means complex content element.
 
 LRElementE_ElementTypeContainerObject
 Structure element type: ContainerObject, which means container object element.
 
 LRElementE_ElementTypeDiv
 Structure element type: Div, which means "Division" and represents a generic block-level element or group of elements.
 
 LRElementE_ElementTypeDocument
 Structure element type: Document, which represents a complete document.
 
 LRElementE_ElementTypeDocumentFragment
 Structure element type: DocumentFragment (PDF 2.0), which represents a part of an original complete document.
 
 LRElementE_ElementTypeEm
 Structure element type: Em (PDF 2.0), which means "Emphasis" and represents content for the purpose of emphasis.
 
 LRElementE_ElementTypeFENote
 Structure element type: FENote (PDF 2.0), which is used to markup footnotes and endnotes.
 
 LRElementE_ElementTypeFigure
 Structure element type: Figure, which represents an item of graphical content.
 
 LRElementE_ElementTypeForm
 Structure element type: Form, which represents a widget annotation representing an interactive form field.
 
 LRElementE_ElementTypeFormObject
 Structure element type: FormObject, which means form XObject graphics object element.
 
 LRElementE_ElementTypeFormula
 Structure element type: Formula, which represents a mathematical formula.
 
 LRElementE_ElementTypeHeading
 Structure element type: H, which means "Heading" and represents a label for a subdivision of a document's content. It should be the first child of the division that it heads.
 
 LRElementE_ElementTypeHeading1
 Structure element type: H1, which represents heading with level 1.
 
 LRElementE_ElementTypeHeading2
 Structure element type: H2, which represents heading with level 2.
 
 LRElementE_ElementTypeHeading3
 Structure element type: H3, which represents heading with level 3.
 
 LRElementE_ElementTypeHeading4
 Structure element type: H4, which represents heading with level 4.
 
 LRElementE_ElementTypeHeading5
 Structure element type: H5, which represents heading with level 5.
 
 LRElementE_ElementTypeHeading6
 Structure element type: H6, which represents heading with level 6.
 
 LRElementE_ElementTypeHeadingN
 Structure element type: Hn (PDF 2.0), which represents heading with level 7 or more.
 
 LRElementE_ElementTypeImageContent
 Structure element type: ImageContent, which means image content element.
 
 LRElementE_ElementTypeImageObject
 Structure element type: ImageObject, which means image graphics object element.
 
 LRElementE_ElementTypeIndex
 Structure element type: Index, which represents a sequence of entries containing identifying text accompanied by reference elements that point out occurrences of the specified text in the main body of a document.
 
 LRElementE_ElementTypeLink
 Structure element type: Link, which represents an association between a portion of the ILSE's content and a corresponding link annotation or annotations.
 
 LRElementE_ElementTypeList
 Structure element type: L, which means "List" and represents a sequence of items of like meaning and importance.
 
 LRElementE_ElementTypeListBody
 Structure element type: LBody, which means "List body" and reprsents the descriptive content of a list item.
 
 LRElementE_ElementTypeListItem
 Structure element type: LI, which means "List item" and represents an individual member of a list.
 
 LRElementE_ElementTypeListLabel
 Structure element type: Lbl, which means "Label" and represents a name or number that distinguishes a given item from others in the same list or other group of like items.
 
 LRElementE_ElementTypeNonStruct
 Structure element type: NonStruct, which means "Nonstructural element" and represents a grouping element having no inherent structural significance; it serves solely for grouping purposes.
 
 LRElementE_ElementTypeNote
 Structure element type: Note, which represents an item of explanatory text, such as a footnote or an endnote, that is referred to from within the body of the document.
 
 LRElementE_ElementTypePageObject
 Structure element type: PageObject, which means page object element.
 
 LRElementE_ElementTypeParagraph
 Structure element type: P, which means "Paragraph" and represents a low-level division of text.
 
 LRElementE_ElementTypePart
 Structure element type: Part, which represents a large-scale division of a document.
 
 LRElementE_ElementTypePathContent
 Structure element type: PathContent, which means path content element.
 
 LRElementE_ElementTypePathObject
 Structure element type: PathObject, which means path graphics object element.
 
 LRElementE_ElementTypePrivate
 Structure element type: Private, which means "Private element" and represents a grouping element containing private content belonging to the application producing it.
 
 LRElementE_ElementTypeQuote
 Structure element type: Quote, which means "Quotation" and represents an inline portion of text attributed to someone other than the author of the surrounding text.
 
 LRElementE_ElementTypeReference
 Structure element type: Reference, which represents a citation to content elsewhere in the document.
 
 LRElementE_ElementTypeRuby
 Structure element type: Ruby, which represents the wrapper around the entire ruby assembly.
 
 LRElementE_ElementTypeRubyAnnot
 Structure element type: RT, which means "Ruby annotation text" and represents the smaller-size text that is placed adjacent to the ruby base text.
 
 LRElementE_ElementTypeRubyBase
 Structure element type: RB, which means "Ruby base text" and represents the full-size text to which the ruby annotation is applied.
 
 LRElementE_ElementTypeRubyPunc
 Structure element type: RP, which means "Ruby punctuation" and represents punctuation surrounding the ruby annotation text.
 
 LRElementE_ElementTypeSect
 Structure element type: Sect, which means "Section" and represents a container for grouping related content elements.
 
 LRElementE_ElementTypeShadingContent
 Structure element type: ShadingContent, which means shading content element.
 
 LRElementE_ElementTypeShadingObject
 Structure element type: ShadingObject, which means shading graphics object element.
 
 LRElementE_ElementTypeSpan
 Structure element type: Span, which represents a generic inline portion of text having no particular inherent characteristics.
 
 LRElementE_ElementTypeStrong
 Structure element type: Strong (PDF 2.0), which represents content for the purpose of strong importance, seriousness or urgency for its contents.
 
 LRElementE_ElementTypeSub
 Structure element type: Sub (PDF 2.0), which means "Sub-division of a block level element" and represents content typically perceived as a sub-division inside a block level structure element.
 
 LRElementE_ElementTypeTable
 Structure element type: Table, which represents a two-dimensional layout of rectangular data cells, possibly having a complex substructure.
 
 LRElementE_ElementTypeTableBodyGroup
 Structure element type: TBody, which means "Table body row group" and represents a group of rows that constitute the main body portion of a table.
 
 LRElementE_ElementTypeTableDataCell
 Structure element type: TD, which means "Table data cell" and represents a table cell containing data that is part of the table's content.
 
 LRElementE_ElementTypeTableFootGroup
 Structure element type: TFoot, which means "Table footer row group" and represents a group of rows that constitute the footer of a table.
 
 LRElementE_ElementTypeTableHeaderCell
 Structure element type: TH, which means "Table header cell" and represents a table cell containing header text describing one or more rows or columns of the table.
 
 LRElementE_ElementTypeTableHeaderGroup
 Structure element type: THead, which means "Table header row group" and represents a group of rows that constitute the header of a table.
 
 LRElementE_ElementTypeTableRow
 Structure element type: TR, which means "Table row" and represents a row of headings or data in a table.
 
 LRElementE_ElementTypeTextContent
 Structure element type: TextContent, which means text content element.
 
 LRElementE_ElementTypeTextObject
 Structure element type: TextObject, which means text graphics object element.
 
 LRElementE_ElementTypeTitle
 Structure element type: Title (PDF 2.0), which represents content that is usually referred to as the title of a document or high-level devision of content.
 
 LRElementE_ElementTypeTOC
 Structure element type: TOC, which means "Table of contents" and represents a list made up of table of contents item entries and/or other nested table of contents entries.
 
 LRElementE_ElementTypeTOCI
 Structure element type: TOCI, which means "Table of contents item" and represents an individual member of a table of contents.
 
 LRElementE_ElementTypeWarichu
 Structure element type: Warichu, which represents the wrapper around the entire warichu assembly.
 
 LRElementE_ElementTypeWarichuPunc
 Structure element type: WP, which means "Warichu punctuation" and represents the punctuation that surrounds the WT text.
 
 LRElementE_ElementTypeWarichuText
 Structure element type: WT, which means "Warichu text" and represents the smaller-size text of a warichu comment that is formatted into two lines and placed between surrounding WP elements.
 
 LRStructureElementE_AttributeTypeABox
 (Reserved) Attribute type: ABox. More...
 
 LRStructureElementE_AttributeTypeAttached
 Attribute type: Attached, which specifies the edges of the page, if any, to which the artifact is logically attached. More...
 
 LRStructureElementE_AttributeTypeBackgroundColor
 Attribute type: BackgroundColor, which represents the color to be used to fill the background of a table cell or any element's content rectangle. More...
 
 LRStructureElementE_AttributeTypeBaselineShift
 Attribute type: BaselineShift, which means the distance by which the element's baseline is shifted relative to that of its parent element. More...
 
 LRStructureElementE_AttributeTypeBBox
 Attribute type: BBox, which represents the element's bounding box (the rectangle that completely encloses its visible content). More...
 
 LRStructureElementE_AttributeTypeBlockAlign
 Attribute type: BlockAlign, which represents the alignment, in the block-progression direction, of content within the table cell. More...
 
 LRStructureElementE_AttributeTypeBorderColor
 Attribute type: BorderColor, which represents the color of the border drawn on the edges of a table cell or any element's content rectangle. More...
 
 LRStructureElementE_AttributeTypeBorderStyle
 Attribute type: BorderStyle, which represents the style of an element's border. More...
 
 LRStructureElementE_AttributeTypeBorderThickness
 Attribute type: BorderThickness, which represents the thickness of the border drawn on the edges of a table cell or any element's content rectangle. More...
 
 LRStructureElementE_AttributeTypeColor
 Attribute type: Color, which represents the color to be used for drawing text and the default value for the color of table borders and text decorations. More...
 
 LRStructureElementE_AttributeTypeColSpan
 Attribute type only for Table: ColSpan, which represents the number of columns in the enclosing table that are spanned by the cell. More...
 
 LRStructureElementE_AttributeTypeColumnCount
 Attribute type: ColumnCount, which represents the number of columns in the content of the grouping element. More...
 
 LRStructureElementE_AttributeTypeColumnGap
 Attribute type: ColumnGap, which represents the desired space between adjacent columns, measured in the inline- progression direction. More...
 
 LRStructureElementE_AttributeTypeColumnWidths
 Attribute type: ColumnWidths, which represents the desired width of the columns, measured in the inline-progression direction. More...
 
 LRStructureElementE_AttributeTypeDestination
 Attribute type: Destination (PDF 2.0), which provides a means to access content. More...
 
 LRStructureElementE_AttributeTypeDirection
 (Reserved) Attribute type: Direction. More...
 
 LRStructureElementE_AttributeTypeEndIndent
 Attribute type: EndIndent, which represents the distance from the end edge of the BLSE to that of the reference area. More...
 
 LRStructureElementE_AttributeTypeFieldChecked
 Attribute type only for PrintField: checked, which represents the state of a radio button or check box field. More...
 
 LRStructureElementE_AttributeTypeFieldDesc
 Attribute type only for PrintField: Desc, which represents the alternate name of the field, similar to the value supplied in the TU entry of the field dictionary for interactive fields. More...
 
 LRStructureElementE_AttributeTypeFieldRole
 Attribute type only for PrintField: Role, which represents the type of form field represented by this graphic. More...
 
 LRStructureElementE_AttributeTypeGlyphOrientationVertical
 Attribute type: GlyphOrientationVertical, which specifies the orientation of glyphs when the inline-progression direction is top to bottom or bottom to top. More...
 
 LRStructureElementE_AttributeTypeHeight
 Attribute type: Height, which represents the height of the element's content rectangle. More...
 
 LRStructureElementE_AttributeTypeInlineAlign
 Attribute type: InlineAlign, which represents the alignment, in the inline-progression direction, of content within the table cell. More...
 
 LRStructureElementE_AttributeTypeInvalid
 Attribute type: invalid.
 
 LRStructureElementE_AttributeTypeLineHeight
 Attribute type: LineHeight, which means the element's preferred height, in the block-progression direction. More...
 
 LRStructureElementE_AttributeTypeListNumbering
 Attribute type only for List: ListNumbering, which represents the numbering system to be used to generate the content of the Lbl (Label) elements in an autonumbered list, or the symbol used to identify each item in an unnumbered list. More...
 
 LRStructureElementE_AttributeTypePadding
 Attribute type: Padding, which specifies an offset to account for the separation between the element's content rectangle and the surrounding border. More...
 
 LRStructureElementE_AttributeTypePlacement
 Attribute type: Placement, which means the positioning of the element with respect to the enclosing reference area and other content. More...
 
 LRStructureElementE_AttributeTypeRole
 Attribute type: role, which means strings of structure element meaning and standard type it maps to. More...
 
 LRStructureElementE_AttributeTypeRotation
 Attribute type: Rotation. More...
 
 LRStructureElementE_AttributeTypeRowSpan
 Attribute type only for Table: RowSpan, which represents the number of rows in the enclosing table that are spanned by the cell. More...
 
 LRStructureElementE_AttributeTypeRubyAlign
 Attribute type: RubyAlign, which represents the justification of the lines within a ruby assembly. More...
 
 LRStructureElementE_AttributeTypeRubyPosition
 Attribute type: RubyPosition, which represents the placement of the RT structure element relative to the RB element in a ruby assembly. More...
 
 LRStructureElementE_AttributeTypeShort
 Attribute type: Short (PDF 2.0), which contains a short form of the content of a TH structure element's content. More...
 
 LRStructureElementE_AttributeTypeSpaceAfter
 Attribute type: SpaceAfter, which represents the amount of extra space following the after edge of the BLSE. More...
 
 LRStructureElementE_AttributeTypeSpaceBefore
 Attribute type: SpaceBefore, which represents the amount of extra space preceding the before edge of the BLSE. More...
 
 LRStructureElementE_AttributeTypeStartIndent
 Attribute type: StartIndent, which represents the distance from the start edge of the reference area to that of the BLSE. More...
 
 LRStructureElementE_AttributeTypeSubType
 Attribute type: Subtype, which means the subtype of annotation or artifact. More...
 
 LRStructureElementE_AttributeTypeTableHeaders
 (Currently, unsupported) Attribute type only for Table: Headers, which represents an array of element identifiers. More...
 
 LRStructureElementE_AttributeTypeTableHeaderScope
 Attribute type only for Table: Scope, which indicates whether the header cell applies to the rest of the cells in the row that contains it, the column that contains it, or both the row and the column that contain it. More...
 
 LRStructureElementE_AttributeTypeTableSummary
 Attribute type only for Table: Summary, which represents a summary of the table's purpose and structure, for use in non- visual rendering such as speech or braille. More...
 
 LRStructureElementE_AttributeTypeTBorderStyle
 Attribute type: TBorderStyle, which represents the style of the border drawn on each edge of a table cell. More...
 
 LRStructureElementE_AttributeTypeTextAlign
 Attribute type: TextAlign, which represents the alignment of text and other content within lines of the BLSE. More...
 
 LRStructureElementE_AttributeTypeTextDecorationColor
 Attribute type: TextDecorationColor, which represents the color to be used for drawing text decorations. More...
 
 LRStructureElementE_AttributeTypeTextDecorationThickness
 Attribute type: TextDecorationThickness, which represents the thickness of each line drawn as part of the text decoration. More...
 
 LRStructureElementE_AttributeTypeTextDecorationType
 Attribute type: TextDecorationType, which represents the text decoration, if any, to be applied to the element's text. More...
 
 LRStructureElementE_AttributeTypeTextIndent
 Attribute type: TextIndent, which represents the additional distance from the start edge of the BLSE, as specified by fsdk.LRStructureElementE_AttributeTypeStartIndent , to that of the first line of text. More...
 
 LRStructureElementE_AttributeTypeTPadding
 Attribute type: TPadding, which specifies an offset to account for the separation between the table cell's content rectangle and the surrounding border. More...
 
 LRStructureElementE_AttributeTypeVersion
 (Reserved) Attribute type: Version, which represents schema version of layout recognition engine. More...
 
 LRStructureElementE_AttributeTypeWidth
 Attribute type: Width, which represents the width of the element's content rectangle. More...
 
 LRStructureElementE_AttributeTypeWritingMode
 Attribute type: WritingMode, which means the directions of layout progression for packing of ILSEs (inline progression) and stacking of BLSEs (block progression). More...
 
 LRStructureElementE_AttributeValueEnumAfter
 Enum value: After, which means the alignment for attribute BlockAlign or the placement for attribute RubyPosition. More...
 
 LRStructureElementE_AttributeValueEnumAuto
 Enum value: Auto. More...
 
 LRStructureElementE_AttributeValueEnumBackground
 Enum value: Background, which means background artifacts. Background artifacts typically serve as a background for content shown either on top of or placed adjacent to that background. More...
 
 LRStructureElementE_AttributeValueEnumBates
 Enum value: Bates (PDF2.0).
 
 LRStructureElementE_AttributeValueEnumBefore
 Enum value: Before, which means the placement for attributes Placement/RubyPosition or alignment for attribute BlockAlign. More...
 
 LRStructureElementE_AttributeValueEnumBlock
 Enum value: Block, which means to be stacked in the block-progression direction within an enclosing reference area or parent BLSE. More...
 
 LRStructureElementE_AttributeValueEnumBoth
 Enum value: Row, which means both row and column of a table. More...
 
 LRStructureElementE_AttributeValueEnumBottom
 Enum value: Bottom, which means bottom edge of the page. More...
 
 LRStructureElementE_AttributeValueEnumCB
 Enum value: cb, which means check box. More...
 
 LRStructureElementE_AttributeValueEnumCenter
 Enum value: Center, which means the alignment for attributes TextAlign/InlineAlign/RubyAlign. More...
 
 LRStructureElementE_AttributeValueEnumCircle
 Enum value: Circle, which means open circular bullet. More...
 
 LRStructureElementE_AttributeValueEnumColumn
 Enum value: Row, which means column of a table. More...
 
 LRStructureElementE_AttributeValueEnumDashed
 Enum value: Dashed, which means the border is a series of short line segments. More...
 
 LRStructureElementE_AttributeValueEnumDecimal
 Enum value: Decimal, which means decimal arabic numerals (1-9, 10-99, ...). More...
 
 LRStructureElementE_AttributeValueEnumDisc
 Enum value: Disc, which means solid circular bullet. More...
 
 LRStructureElementE_AttributeValueEnumDistribute
 Enum value: Distribute, which means the content is to be expanded to fill the available width in the inline-progression direction. More...
 
 LRStructureElementE_AttributeValueEnumDotted
 Enum value: Dotten, which means the border is a series of dots. More...
 
 LRStructureElementE_AttributeValueEnumDouble
 Enum value: Double, which means the border is two solid lines. More...
 
 LRStructureElementE_AttributeValueEnumEnd
 Enum value: End, which means the place for attribute Placement, or the alignment for attributes TextAlign/InlineAlign/RubyAlign. More...
 
 LRStructureElementE_AttributeValueEnumFloat
 Enum value: float.
 
 LRStructureElementE_AttributeValueEnumFooter
 Enum value: Footer.
 
 LRStructureElementE_AttributeValueEnumGroove
 Enum value: Groove, which means the border looks as though it were carved into the canvas. More...
 
 LRStructureElementE_AttributeValueEnumHeader
 Enum value: Header.
 
 LRStructureElementE_AttributeValueEnumHidden
 Enum value: Hidden, which is same as None except in terms of border conflict resolution for table elements. More...
 
 LRStructureElementE_AttributeValueEnumInline
 Enum value: Inline, which means the placement for attributes Placement/RubyPosition. More...
 
 LRStructureElementE_AttributeValueEnumInset
 Enum value: Inset, which means the border makes the entire box look as though it were embedded in the canvas. More...
 
 LRStructureElementE_AttributeValueEnumInvalid
 Invalid enum value.
 
 LRStructureElementE_AttributeValueEnumJustify
 Enum value: Justify, which means the alignment for attributes TextAlign/BlockAlign/RubyAlign. More...
 
 LRStructureElementE_AttributeValueEnumLayout
 Enum value: Layout, which means layout artifacts. Purely cosmetic typographical or design elements such as footnote rules or background screens. More...
 
 LRStructureElementE_AttributeValueEnumLeft
 Enum value: Left, which means left edge of the page. More...
 
 LRStructureElementE_AttributeValueEnumLineThrough
 Enum value: LineThrough, which means a line through the middle of the text. More...
 
 LRStructureElementE_AttributeValueEnumLowerAlpha
 Enum value: LowerAlpha, which means lowercase letters (a, b, c, ...). More...
 
 LRStructureElementE_AttributeValueEnumLowerRoman
 Enum value: LowerRoman, which means lowercase roman numerals (i, ii, iii, iv, ...). More...
 
 LRStructureElementE_AttributeValueEnumLrTb
 Enum value: LtTb, which means inline progression from left to right; block progression from top to bottom. More...
 
 LRStructureElementE_AttributeValueEnumMiddle
 Enum value: Middle, which means children are centered within the table cell. More...
 
 LRStructureElementE_AttributeValueEnumNeutral
 Enum value: neutral, which means the state is neutral. More...
 
 LRStructureElementE_AttributeValueEnumNone
 Enum value: None, which means no such attribute. More...
 
 LRStructureElementE_AttributeValueEnumOff
 Enum value: off, which means the state is off. More...
 
 LRStructureElementE_AttributeValueEnumOn
 Enum value: on, which means the state is on. More...
 
 LRStructureElementE_AttributeValueEnumOrdered
 Enum value: Ordered (PDF 2.0), which means ordered lists with unspecified numbering. More...
 
 LRStructureElementE_AttributeValueEnumOther
 Enum value: Other (PDF 2.0). More...
 
 LRStructureElementE_AttributeValueEnumOutset
 Enum value: Outset, which means the border makes the entire box look as though it were coming out of the canvas (the opposite of Inset). More...
 
 LRStructureElementE_AttributeValueEnumOverline
 Enum value: Overline, which means a line above the text. More...
 
 LRStructureElementE_AttributeValueEnumPage
 Enum value: Page, which means page artifacts. Production aids extraneous to the document itself, such as cut marks and color bars. More...
 
 LRStructureElementE_AttributeValueEnumPageNum
 Enum value: PageNum (PDF2.0).
 
 LRStructureElementE_AttributeValueEnumPagination
 Enum value: Pagination, which means pagination artifacts. Ancillary page features such as running heads and folios (page numbers). More...
 
 LRStructureElementE_AttributeValueEnumPB
 Enum value: pb, which means push button. More...
 
 LRStructureElementE_AttributeValueEnumRB
 Enum value: rb, which means radio button. More...
 
 LRStructureElementE_AttributeValueEnumRidge
 Enum value: Ridge, which means the border looks as though it were coming out of the canvas (the opposite of Groove). More...
 
 LRStructureElementE_AttributeValueEnumRight
 Enum value: Right, which means right edge of the page. More...
 
 LRStructureElementE_AttributeValueEnumRlTb
 Enum value: RlTb, which means inline progression from right to left; block progression from top to bottom. More...
 
 LRStructureElementE_AttributeValueEnumRow
 Enum value: Row, which means row of a table. More...
 
 LRStructureElementE_AttributeValueEnumSolid
 Enum value: Solid, which means the border is a single line segment. More...
 
 LRStructureElementE_AttributeValueEnumSquare
 Enum value: Square, which means solid square bullet. More...
 
 LRStructureElementE_AttributeValueEnumStart
 Enum value: Start, which means the place for attribute Placement, or the alignment for attributes TextAlign/InlineAlign/RubyAlign. More...
 
 LRStructureElementE_AttributeValueEnumTbLr
 Enum value: TbLr (PDF 2.0), which means inline progression from top to bottom; block progression from left to right. More...
 
 LRStructureElementE_AttributeValueEnumTbRl
 Enum value: TbRl, which means inline progression from top to bottom; block progression from right to left. More...
 
 LRStructureElementE_AttributeValueEnumTop
 Enum value: Top, which means top edge of the page. More...
 
 LRStructureElementE_AttributeValueEnumTV
 Enum value: tv, which means text-value field. More...
 
 LRStructureElementE_AttributeValueEnumUnderline
 Enum value: Underline, which means a line below the text. More...
 
 LRStructureElementE_AttributeValueEnumUnordered
 Enum value: Unordered (PDF 2.0), which means unordered list with unspecified bullets. More...
 
 LRStructureElementE_AttributeValueEnumUpperAlpha
 Enum value: UpperAlpha, which means uppercase letters (A, B, C, ...). More...
 
 LRStructureElementE_AttributeValueEnumUpperRoman
 Enum value: UpperRoman, which means uppercase roman numerals (I, II, III, IV, ...). More...
 
 LRStructureElementE_AttributeValueEnumWarichu
 Enum value: Warichu, which means the RT and associated RP elements are to be formatted as a warichu, following the RB element. More...
 
 LRStructureElementE_AttributeValueEnumWatermark
 Enum value: Watermark.
 
 LRStructureElementE_AttributeValueTypeARGB
 Value type: ARGB color type, 32 bits, ((b) | ((g) << 8) | ((r) << 16)) | ((a) << 24).
 
 LRStructureElementE_AttributeValueTypeARGBArray
 Value type: an array of ARGB values.
 
 LRStructureElementE_AttributeValueTypeElement
 Value type: element.
 
 LRStructureElementE_AttributeValueTypeElementArray
 Value type: an array of elements.
 
 LRStructureElementE_AttributeValueTypeEmpty
 Empty value type.
 
 LRStructureElementE_AttributeValueTypeEnum
 Value type: enum.
 
 LRStructureElementE_AttributeValueTypeEnumArray
 Value type: an array of enum values.
 
 LRStructureElementE_AttributeValueTypeFloat
 Value type: float.
 
 LRStructureElementE_AttributeValueTypeFloatArray
 Value type: an array of float values.
 
 LRStructureElementE_AttributeValueTypeInt32
 Value type: 32-bit signed integer.
 
 LRStructureElementE_AttributeValueTypeInt32Array
 Value type: an array of integer values.
 
 LRStructureElementE_AttributeValueTypeWStr
 Value type: wide string.
 
 LRStructureElementE_AttributeValueTypeWStrArray
 Value type: an array of wide strings.
 
 LTVVerifierE_CurrentTime
 Use current time.
 
 LTVVerifierE_SignatureCreationTime
 Use signature creation time.
 
 LTVVerifierE_SignatureTSTTime
 Use the time of signature time stamp token.
 
 LTVVerifierE_VerifyModeAcrobat
 Use Acrobat validation process.
 
 LTVVerifierE_VRICreationTime
 Use the creation time of VRI dictionary of a signature. More...
 
 MarkupE_EndingStyleButt
 A short line at the endpoint perpendicular to the line itself.
 
 MarkupE_EndingStyleCircle
 A circle filled with the annotation's interior color if any.
 
 MarkupE_EndingStyleClosedArrow
 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.
 
 MarkupE_EndingStyleDiamond
 A diamond shape filled with the annotation's interior color if any.
 
 MarkupE_EndingStyleNone
 No special line ending.
 
 MarkupE_EndingStyleOpenArrow
 Two short lines meeting in an acute angle to form an open arrowhead.
 
 MarkupE_EndingStyleRClosedArrow
 A triangular closed arrowhead in the reverse direction from ClosedArrow.
 
 MarkupE_EndingStyleROpenArrow
 Two short lines in the reverse direction from OpenArrow.
 
 MarkupE_EndingStyleSlash
 A short line at the endpoint approximately 30 degrees clockwise from perpendicular to the line itself.
 
 MarkupE_EndingStyleSquare
 A square filled with the annotation's interior color if any.
 
 MarkupE_MeasureTypeA
 Measurement of area.
 
 MarkupE_MeasureTypeD
 Measurement of distance in any direction.
 
 MarkupE_MeasureTypeS
 Measurement of the slope of a line.
 
 MarkupE_MeasureTypeT
 Measurement of angles.
 
 MarkupE_MeasureTypeX
 Measurement of change along the x axis.
 
 MarkupE_MeasureTypeY
 Measurement of change along the y axis.
 
 MarkupE_StateAccepted
 (Used with state model fsdk.MarkupE_StateModelReview ) The user agrees with the change.
 
 MarkupE_StateCancelled
 (Used with state model fsdk.MarkupE_StateModelReview ) The change has been cancelled.
 
 MarkupE_StateCompleted
 (Used with state model fsdk.MarkupE_StateModelReview ) The change has been completed.
 
 MarkupE_StateDeferred
 (Used with state model fsdk.MarkupE_StateModelReview ) The change has been deferred.
 
 MarkupE_StateFuture
 (Used with state model fsdk.MarkupE_StateModelReview ) The change will be working in the future.
 
 MarkupE_StateMarked
 (Used with state model fsdk.MarkupE_StateModelMarked ) The annotation has been marked by the user.
 
 MarkupE_StateModelMarked
 Markup annotation state model: marked.
 
 MarkupE_StateModelReview
 Markup annotation state model: review.
 
 MarkupE_StateNone
 (Used with state model fsdk.MarkupE_StateModelReview ) The user has indicated nothing about the change.
 
 MarkupE_StateRejected
 (Used with state model fsdk.MarkupE_StateModelReview ) The user disagrees with the change.
 
 MarkupE_StateUnmarked
 (Used with state model fsdk.MarkupE_StateModelMarked ) The annotation has not been marked by the user.
 
 MediaPlayerCallbackE_JSMediaPlayerStateClose
 media player state: Close.
 
 MediaPlayerCallbackE_JSMediaPlayerStateOpen
 media player state: Open.
 
 MediaPlayerCallbackE_JSMediaPlayerStatePlaying
 media player state: Playing.
 
 MediaPlayerCallbackE_JSMediaPlayerStateStop
 media player state: Stop.
 
 MediaPlayerCallbackE_JSMediaPlayerStateSuspend
 media player state: Suspend.
 
 MediaSettingsE_PlayerWindowTypeDockedPage
 Window type: a docked page window.
 
 MediaSettingsE_PlayerWindowTypeFloating
 Window type: a floating window.
 
 MediaSettingsE_PlayerWindowTypeFullScreen
 Window type: a full-screen window that obscures all other windows.
 
 MonoImageSettingsE_ImageCompressCCITT3
 Compression mode: CCITT Group 3.
 
 MonoImageSettingsE_ImageCompressCCITT4
 Compression mode: CCITT Group 4.
 
 MonoImageSettingsE_ImageCompressHigh
 Compression mode: high.
 
 MonoImageSettingsE_ImageCompressjbig2
 Compression mode: jbig2.
 
 MonoImageSettingsE_ImageCompressQualityHigh
 Compression quality: High, only for e_ImageCompressHigh compress mode.
 
 MonoImageSettingsE_ImageCompressQualityLossless
 Compression quality: Lossless.
 
 MonoImageSettingsE_ImageCompressQualityLossy
 Compression quality: Lossy.
 
 MonoImageSettingsE_ImageCompressQualityLow
 Compression quality: Low, only for e_ImageCompressHigh compress mode.
 
 MonoImageSettingsE_ImageCompressQualityMaximum
 Compression quality: Maximum, only for e_ImageCompressHigh compress mode.
 
 MonoImageSettingsE_ImageCompressQualityMedium
 Compression quality: Medium, only for e_ImageCompressHigh compress mode.
 
 MonoImageSettingsE_ImageCompressQualityMinimum
 Compression quality: Minimum, only for e_ImageCompressHigh compress mode.
 
 MonoImageSettingsE_ImageCompressRetain
 Compression mode: retain, which means no compression.
 
 MonoImageSettingsE_ImageCompressRunLength
 Compression mode: run-length.
 
 MonoImageSettingsE_ImageCompressZip
 Compression mode: zip.
 
 MonoImageSettingsE_StretchBicubic
 When this is set, that means to do bicubic interpolation for zooming.
 
 MonoImageSettingsE_StretchDefault
 When this is set, that means to do default stretching.
 
 MonoImageSettingsE_StretchDownsample
 When this is set, that means not to do halftone for shrinking or rotating.
 
 MonoImageSettingsE_StretchInterpol
 When this is set, that means to do interpolation for zooming.
 
 MonoImageSettingsE_StretchNoSmooth
 When this is set, that means not to do any interpolation for stretching.
 
 MonoImageSettingsE_StretchOff
 When this is set, that means to do without stretching.
 
 OFDRendererE_ColorModeMapping
 Map a color value to the color range defined by a background color and a foreground color.
 
 OFDRendererE_ColorModeMappingGray
 Map gray/white/black color value to background/foreground; for other colors, no change.
 
 OFDRendererE_ColorModeNormal
 Normal color mode.
 
 OFDRendererE_ContentFlagAllContent
 If set, all content will be rendered. This value should be used alone.
 
 OFDRendererE_ContentFlagAnnot
 If set, annotations will be rendered.(Excluding highlight annotation and stamp)
 
 OFDRendererE_ContentFlagHighLightAnnots
 If set, highlight annotations will be rendered.
 
 OFDRendererE_ContentFlagPage
 If set, page content will be rendered.
 
 OFDRendererE_ContentFlagStampAnnots
 If set, stamp annotations will be rendered.
 
 OptimizerSettingsE_CleanUpDiscardUnreferencedNamedDes
 Discard unreferenced named destination.
 
 OptimizerSettingsE_CleanUpOptPageContent
 Cleanup page content Change 0A,0D in the content stream to Spaces.
 
 OptimizerSettingsE_CleanUpRemoveInvalidBookmarks
 Remove invalid bookmarks.
 
 OptimizerSettingsE_CleanUpRemoveInvalidLinks
 Remove invalid links.
 
 OptimizerSettingsE_CleanUpUseFlateForNonEncodedStream
 Use Flate to encode streams that are not encoded.
 
 OptimizerSettingsE_CleanUpUseFlateInsteadOfLZW
 In streams that use LZW encoding, use Flate instead.
 
 OptimizerSettingsE_DiscardObjectsAlternateImages
 Discard all alternate images. More...
 
 OptimizerSettingsE_DiscardObjectsBookmarks
 Discard bookmarks.
 
 OptimizerSettingsE_DiscardObjectsDetectAndMergeImageFragment
 Detect and merge image fragments.
 
 OptimizerSettingsE_DiscardObjectsDocumentTags
 Discard document tags.
 
 OptimizerSettingsE_DiscardObjectsEmbeddedPageThumbnails
 Discard embedded page thumbnails.
 
 OptimizerSettingsE_DiscardObjectsEmbeddedPrintSettings
 Discard embedded print settings.
 
 OptimizerSettingsE_DiscardObjectsEmbeddedSearchIndex
 Discard embedded search index.
 
 OptimizerSettingsE_DiscardObjectsFlattenFormFields
 Flatten form fields.
 
 OptimizerSettingsE_DiscardObjectsFormActions
 Discard all form submission, import and reset actions.
 
 OptimizerSettingsE_DiscardObjectsJavaScriptActions
 Discard all JavaScript actions. More...
 
 OptimizerSettingsE_DiscardObjectsSmoothlinestocurves
 smooth lines to curves
 
 OptimizerSettingsE_DiscardUserAllData
 discard tag user data
 
 OptimizerSettingsE_DiscardUserDataAllAnnotsFormsAndMultimedia
 Discard all annotations, forms and multimedia.
 
 OptimizerSettingsE_DiscardUserDataDocumentInfoAndMetaData
 Discard document information and metadata.
 
 OptimizerSettingsE_DiscardUserDataExternalCrossReferences
 Discard external cross references.
 
 OptimizerSettingsE_DiscardUserDataFileAttchments
 Discard file attachments.
 
 OptimizerSettingsE_DiscardUserDataLayer
 Discard hidden layer content and flatten visible layers.
 
 OptimizerSettingsE_DiscardUserDataPrivateDataOfOtherApp
 Discard private data of other applications.
 
 OptimizerSettingsE_OptimizerCleanUp
 Optimize PDF document by cleaning up.
 
 OptimizerSettingsE_OptimizerCompressImages
 Optimize PDF document by compressing images.
 
 OptimizerSettingsE_OptimizerDiscardObjects
 Optimize PDF document by discarding objects.
 
 OptimizerSettingsE_OptimizerDiscardUserData
 Optimize PDF document by discarding user data.
 
 OptimizerSettingsE_OptimizerUnembeddedFonts
 Optimize PDF document by unembedding some embedded fonts.
 
 OptimizeScannedPDFSettingsE_ScannedImageCompressHigh
 Compression mode: high.
 
 OptimizeScannedPDFSettingsE_ScannedImageCompressjpeg
 Compression mode: jpeg.
 
 OptimizeScannedPDFSettingsE_ScannedImageCompressjpeg2000LossLess
 Compression mode: jpeg2000 lossless.
 
 OptimizeScannedPDFSettingsE_ScannedImageCompressjpeg2000Lossy
 Compression mode: jpeg2000 lossy.
 
 OptimizeScannedPDFSettingsE_ScannedMonoImageCompressCCITT4
 Compression mode: CCITT Group 4.
 
 OptimizeScannedPDFSettingsE_ScannedMonoImageCompressHigh
 Compression mode: high.
 
 OptimizeScannedPDFSettingsE_ScannedMonoImageCompressjbig2LossLess
 Compression mode: jbig2 lossless.
 
 OptimizeScannedPDFSettingsE_ScannedMonoImageCompressjbig2Lossy
 Compression mode: jbig2 lossy.
 
 OutputPreviewE_ColorantTypeProcess
 Colorant type: process.
 
 OutputPreviewE_ColorantTypeSpot
 Colorant type: spot.
 
 OutputPreviewE_ShowAll
 If set, show all.
 
 OutputPreviewE_ShowCalGray
 If set, only show with CalGray.
 
 OutputPreviewE_ShowCalibrated
 If set, only show with Calibrated.
 
 OutputPreviewE_ShowCMYK
 If set, only show with CMYK.
 
 OutputPreviewE_ShowDevice
 If set, only show with Device.
 
 OutputPreviewE_ShowDeviceCMYK
 If set, only show with DeviceCMYK.
 
 OutputPreviewE_ShowDeviceCMYKAndSpot
 If set, only show with DeviceCMYK and spot.
 
 OutputPreviewE_ShowDeviceGray
 If set, only show with DeviceGray.
 
 OutputPreviewE_ShowDeviceN
 If set, only show with DeviceN.
 
 OutputPreviewE_ShowDeviceRGB
 If set, only show with DeviceRGB.
 
 OutputPreviewE_ShowGray
 If set, only show with Gray.
 
 OutputPreviewE_ShowICCBasedCMYK
 If set, only show with ICCBased CMYK.
 
 OutputPreviewE_ShowICCBasedRGB
 If set, only show with ICCBased RGB.
 
 OutputPreviewE_ShowImages
 If set, only show images.
 
 OutputPreviewE_ShowLab
 If set, only show with Lab.
 
 OutputPreviewE_ShowLineArt
 If set, only show line art.
 
 OutputPreviewE_ShowNotDeviceCMYK
 If set, only show without DeviceCMYK.
 
 OutputPreviewE_ShowNotDeviceCMYKOrSpot
 If set, only show with DeviceCMYK or spot.
 
 OutputPreviewE_ShowRegistrationColor
 If set, only show registration color.
 
 OutputPreviewE_ShowRGB
 If set, only show with RGB.
 
 OutputPreviewE_ShowSmoothShades
 If set, only show smooth shades.
 
 OutputPreviewE_ShowSolidColor
 If set, only show solid color.
 
 OutputPreviewE_ShowSpotColor
 If set, only show with spot color.
 
 OutputPreviewE_ShowText
 If set, only show text.
 
 PageLabelsE_DecimalNums
 Page label style: decimal Arabic numerals.
 
 PageLabelsE_LowerLetters
 Page label style: lowercase letters. More...
 
 PageLabelsE_LowerRomanNums
 Page label style: lowercase roman numerals.
 
 PageLabelsE_None
 Page label style: no numbering style. More...
 
 PageLabelsE_UpperLetters
 Page label style: uppercase letters. More...
 
 PageLabelsE_UpperRomanNums
 Page label style: uppercase roman numerals.
 
 PagingSealConfigE_PagingSealPositionBottom
 Bottom Paging Seal.
 
 PagingSealConfigE_PagingSealPositionLeft
 Left Paging Seal.
 
 PagingSealConfigE_PagingSealPositionRight
 Right Paging Seal.
 
 PagingSealConfigE_PagingSealPositionTop
 Top Paging Seal.
 
 PagingSealConfigE_PagingSealStyleMultipleSignatures
 Add multiple signatures. Use the Signature to display the appearance of paging seal signature, and these signatures share the same signature data.
 
 PagingSealConfigE_PagingSealStyleOneSignature
 Only add one signature. This signature is used for signature and verification and will be hidden in the PDF document. Use the fsdk.PagingSeal annotation to display the appearance of paging seal signature.
 
 PagingSealSignatureE_PagingSealAPStateInvalid
 Verification state of a signature is invalid.
 
 PagingSealSignatureE_PagingSealAPStateSigned
 Signed signature.
 
 PagingSealSignatureE_PagingSealAPStateUnknown
 Unknown signature.
 
 PagingSealSignatureE_PagingSealAPStateUnsigned
 Unsigned signature.
 
 PagingSealSignatureE_PagingSealAPStateValid
 Verification state of a signature is valid.
 
 ParagraphEditingE_BulletTypeBlackDiamondMinusWhite
 Bullet type: black diamond minus white.
 
 ParagraphEditingE_BulletTypeCheck
 Bullet type: check.
 
 ParagraphEditingE_BulletTypeDiagonalUpRightArrow
 Bullet type: diagonal up right arrow.
 
 ParagraphEditingE_BulletTypeInverseTangentCircle
 Bullet type: inverse tangent circle.
 
 ParagraphEditingE_BulletTypeNone
 Bullet type: none.
 
 ParagraphEditingE_BulletTypeRightArrow
 Bullet type: right arrow (upper white and lower black).
 
 ParagraphEditingE_BulletTypeSolidCircle
 Bullet type: solid circle.
 
 ParagraphEditingE_BulletTypeSolidDiamond
 Bullet type: solid diamond.
 
 ParagraphEditingE_BulletTypeSolidRectangle
 Bullet type: solid rectangle.
 
 ParagraphEditingE_NumberingTypeDecimalDot
 Numbering type: 1. 2. 3.
 
 ParagraphEditingE_NumberingTypeDecimalRParen
 Numbering type: 1) 2) 3)
 
 ParagraphEditingE_NumberingTypeLowerLatinDot
 Numbering type: a. b. c.
 
 ParagraphEditingE_NumberingTypeLowerLatinRParen
 Numbering type: a) b) c)
 
 ParagraphEditingE_NumberingTypeNone
 Numbering type: none.
 
 ParagraphEditingE_NumberingTypeUpperLatinDot
 Numbering type: A. B. C.
 
 PathE_TypeBezierTo
 Indicates that this point is a control point or ending point for a Bezier spline.
 
 PathE_TypeBezierToCloseFigure
 Indicates that this point is the ending point for a Bezier spline, and this point will also be connected to the nearest fsdk.PathE_TypeMoveTo point before this point, in order to close current figure.
 
 PathE_TypeLineTo
 Indicates that a line is drawn from the previous point to this point.
 
 PathE_TypeLineToCloseFigure
 Indicates that a line is drawn from the previous point to this point, and this point will also be connected to the nearest fsdk.PathE_TypeMoveTo point before this point, in order to close current figure.
 
 PathE_TypeMoveTo
 Indicates that the point is the first point of a figure.
 
 PDF2ExcelSettingDataE_WorkbookSettingsDocument
 Create single worksheet for the document.
 
 PDF2ExcelSettingDataE_WorkbookSettingsEachPage
 Create worksheet for each page.
 
 PDF2ExcelSettingDataE_WorkbookSettingsEachTable
 Create worksheet for each table.
 
 PDFDocE_Annots
 If set, annotations (except link annotations) are to imported from or exported to FDF/XFDF document.
 
 PDFDocE_DisplayFullScreen
 When document is opened, full-screen mode, with no menu bar, window controls, or any other windows are visible.
 
 PDFDocE_DisplayUseAttachment
 When document is opened, attachment panels are visible.
 
 PDFDocE_DisplayUseNone
 When document is opened, neither document outlines nor thumbnail images are visible.
 
 PDFDocE_DisplayUseOC
 When document is opened, optional content group panels are visible.
 
 PDFDocE_DisplayUseOutlines
 When document is opened, document outlines (bookmarks) are visible.
 
 PDFDocE_DisplayUseThumbs
 When document is opened, thumbnail images are visible.
 
 PDFDocE_EncryptCDRM
 (Reserved, currently, this value is not used.) Encryption type: Foxit connected PDF DRM encryption.
 
 PDFDocE_EncryptCertificate
 Encryption type: digital certificate encryption.
 
 PDFDocE_EncryptCustom
 Encryption type: customized encryption.
 
 PDFDocE_EncryptFoxitDRM
 Encryption type: Foxit DRM encryption.
 
 PDFDocE_EncryptNone
 No encryption pattern.
 
 PDFDocE_EncryptPassword
 Encryption type: password, which is the standard encryption.
 
 PDFDocE_EncryptRMS
 Encryption type: Microsoft RMS encryption.
 
 PDFDocE_EncryptUnknown
 Unknown encryption type.
 
 PDFDocE_ExtractPagesOptionAnnotation
 If set, that means annotations related to extracted pages will be extracted as well.
 
 PDFDocE_ExtractPagesOptionAttachFiles
 If set, that means attachment files will be extracted as well.
 
 PDFDocE_ExtractPagesOptionBookmark
 If set, that means bookmark will be extracted as well.
 
 PDFDocE_ExtractPagesOptionJavascript
 If set, that means Javascript will be extracted as well.
 
 PDFDocE_ExtractPagesOptionObjectStream
 If set, that means to use fsdk.PDFDocE_SaveFlagXRefStream saving flag for the result file in order to reduce the size of result file.
 
 PDFDocE_ExtractPagesOptionOCProperties
 If set, that means OCProperties will be extracted as well.
 
 PDFDocE_ExtractPagesOptionSignature
 If set, that means signature will be extracted as well. It must be combined with .
 
 PDFDocE_ExtractPagesOptionStructureTree
 If set, that means structure tree will be extracted as well.
 
 PDFDocE_Forms
 If set, form fields are to imported from or exported to FDF/XFDF document.
 
 PDFDocE_ImportFlagNormal
 Import pages normally.
 
 PDFDocE_ImportFlagShareStream
 Import pages without cloning stream objects into memory. More...
 
 PDFDocE_ImportFlagWithLayers
 Import pages with layers.
 
 PDFDocE_InsertDocOptionAttachments
 If set, that means attachments will be inserted to target document as well.
 
 PDFDocE_InsertDocOptionBookmark
 If set, that means bookmark will be inserted to target document as well.
 
 PDFDocE_Links
 (Reserved, not supported yet) If set, only link annotations are to imported from or exported to XFDF document.
 
 PDFDocE_PermAnnotForm
 Operate text annotations and fill in interactive form fields. (Bit 6 in permission value) More...
 
 PDFDocE_PermAssemble
 Assemble PDF document. (Bit 11 in permission value) More...
 
 PDFDocE_PermExtract
 Extract PDF contents. (Bit 5 in permission value) More...
 
 PDFDocE_PermExtractAccess
 Disabilities support. (Bit 10 in permission value) More...
 
 PDFDocE_PermFillForm
 Fill PDF form. (Bit 9 in permission value) More...
 
 PDFDocE_PermModify
 Modify PDF contents. (Bit 4 in permission value) More...
 
 PDFDocE_PermPrint
 Print PDF document with normal mode. (Bit 3 in permission value) More...
 
 PDFDocE_PermPrintHigh
 Print PDF document with higher qualities. (Bit 12 in permission value) More...
 
 PDFDocE_PwdInvalid
 The password is invalid.
 
 PDFDocE_PwdNoPassword
 No password is used in PDF document.
 
 PDFDocE_PwdOwner
 An owner password is used in PDF document.
 
 PDFDocE_PwdUser
 A user password is used in PDF document.
 
 PDFDocE_SaveFlagIncremental
 Save document incrementally. More...
 
 PDFDocE_SaveFlagLinearized
 Save document as a linearized file. More...
 
 PDFDocE_SaveFlagNoOriginal
 Save document without original data or unchanged objects. More...
 
 PDFDocE_SaveFlagNormal
 Save document normally, without using any special flag. More...
 
 PDFDocE_SaveFlagNoUpdatingMetadataDateTime
 Save document without updating metadata "ModDate" and "CreationDate". More...
 
 PDFDocE_SaveFlagRemoveRedundantObjects
 Save document with removing redundant PDF objects. More...
 
 PDFDocE_SaveFlagXRefStream
 Save document by using XRef stream. More...
 
 PDFDocE_WrapperFoxit
 Foxit wrapper document.
 
 PDFDocE_WrapperNone
 Normal document.
 
 PDFDocE_WrapperPDFV2
 PDF 2.0 wrapper document.
 
 PDFNameTreeE_Dests
 "Dests" name tree.
 
 PDFNameTreeE_EmbeddedFiles
 "EmbeddedFiles" name tree.
 
 PDFNameTreeE_JavaScript
 "JavaScript" name tree.
 
 PDFNameTreeE_Pages
 "Pages" name tree.
 
 PDFNameTreeE_Templates
 "Templates" name tree.
 
 PDFNumberTreeE_PageLabels
 "PageLabels" number tree.
 
 PDFObjectE_Array
 PDF array object.
 
 PDFObjectE_Boolean
 PDF boolean object.
 
 PDFObjectE_Dictionary
 PDF dictionary object.
 
 PDFObjectE_InvalidType
 Invalid PDF object type.
 
 PDFObjectE_Name
 PDF name object.
 
 PDFObjectE_Null
 PDF null object.
 
 PDFObjectE_Number
 PDF number object.
 
 PDFObjectE_Reference
 PDF reference object.
 
 PDFObjectE_Stream
 PDF stream object.
 
 PDFObjectE_String
 PDF string object.
 
 PDFPageE_ArtBox
 Art Box for page boundary. More...
 
 PDFPageE_BleedBox
 Bleed Box for page boundary. More...
 
 PDFPageE_CalcContentsBox
 Calculate margin according to bounding box of all contents.
 
 PDFPageE_CalcDetection
 Calculate margin by detecting paths or images.
 
 PDFPageE_CropBox
 Crop Box for page boundary. More...
 
 PDFPageE_FlattenAll
 Flatten all contents of a PDF page.
 
 PDFPageE_FlattenNoAnnot
 Flatten a PDF page without annotations.
 
 PDFPageE_FlattenNoFormControl
 Flatten a PDF page without form controls.
 
 PDFPageE_MediaBox
 Media Box for page boundary. More...
 
 PDFPageE_ParsePageNormal
 Parsing flag for normal mode, which means to parse all the contents in a PDF page.
 
 PDFPageE_ParsePageTextOnly
 Parsing flag for text-only mode.
 
 PDFPageE_SizeA2
 Page size: A2.
 
 PDFPageE_SizeA3
 Page size: A3.
 
 PDFPageE_SizeA4
 Page size: A4.
 
 PDFPageE_SizeA5
 Page size: A5.
 
 PDFPageE_SizeA6
 Page size: A6.
 
 PDFPageE_SizeB2
 Page size: B2.
 
 PDFPageE_SizeB3
 Page size: B3.
 
 PDFPageE_SizeB4
 Page size: B4.
 
 PDFPageE_SizeB5
 Page size: B5.
 
 PDFPageE_SizeB6
 Page size: B6.
 
 PDFPageE_SizeLegal
 Page size: legal.
 
 PDFPageE_SizeLetter
 Page size: letter.
 
 PDFPageE_TrimBox
 Trim Box for page boundary. More...
 
 PDFStreamE_ASCII85Decode
 Filter type: ASCII85Decode, which means to decode data encoded in an ASCII base-85 representation, reproducing the original binary data.
 
 PDFStreamE_ASCIIHexDecode
 Filter type: ASCIIHexDecode, which means to decode data encoded in an ASCII hexadecimal representation, reproducing the original binary data.
 
 PDFStreamE_CCITTFaxDecode
 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).
 
 PDFStreamE_Crypt
 Filter type: Crypt, which means to decrypt data encrypted by a security handler, reproducing the original data as it was before encryption.
 
 PDFStreamE_DCTDecode
 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.
 
 PDFStreamE_FlateDecode
 Filter type: FlateDecode, which means to decompress data encoded using the zlib/deflate compression method, reproducing the original text or binary data.
 
 PDFStreamE_JBIG2Decode
 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).
 
 PDFStreamE_JPXDecode
 Filter type: JPXDecode, which means to decompress data encoded using the wavelet-based JPEG2000 standard, reproducing the original image data.
 
 PDFStreamE_LZWDecode
 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.
 
 PDFStreamE_NoneDecode
 No need to decode the stream data.
 
 PDFStreamE_RunLengthDecode
 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).
 
 PDFStreamE_Unknown
 Unknown filter type.
 
 PortfolioE_InitialViewDetailMode
 Initial view mode: details mode, with all information (specified by schema fields) presented in a multicolumn format. More...
 
 PortfolioE_InitialViewHidden
 Initial view mode: hidden mode.
 
 PortfolioE_InitialViewTileMode
 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). More...
 
 PortfolioE_InitialViewUnknownMode
 Unknown initial view mode.
 
 PortfolioNodeE_TypeFile
 Portfolio node type: file.
 
 PortfolioNodeE_TypeFolder
 Portfolio node type: folder.
 
 PortfolioNodeE_TypeUnknown
 Unknown portfolio node type.
 
 PowerPoint2PDFSettingDataE_ConvertIntentPrint
 Intent: converted result file will be used for printing.
 
 PowerPoint2PDFSettingDataE_ConvertIntentScreen
 Intent: converted result file will be used for showing on screen.
 
 PowerPoint2PDFSettingDataE_HandoutOrderHorizontalFirst
 When converting PowerPoint in handouts type, convert handouts with consecutive slides displayed horizontally first (in horizontal rows).
 
 PowerPoint2PDFSettingDataE_HandoutOrderVerticalFirst
 When converting PowerPoint in handouts type, convert handouts with consecutive slides displayed vertically first (in vertical columns).
 
 PowerPoint2PDFSettingDataE_OutputFourSlideHandouts
 Output type: handouts with four slide per handout page.
 
 PowerPoint2PDFSettingDataE_OutputNineSlideHandouts
 Output type: handouts with nine slide per handout page.
 
 PowerPoint2PDFSettingDataE_OutputNotesPages
 Output type: notes pages.
 
 PowerPoint2PDFSettingDataE_OutputOneSlideHandouts
 Output type: handouts with one slide per handout page.
 
 PowerPoint2PDFSettingDataE_OutputOutline
 Output type: outline view.
 
 PowerPoint2PDFSettingDataE_OutputSixSlideHandouts
 Output type: handouts with six slide per handout page.
 
 PowerPoint2PDFSettingDataE_OutputSlides
 Output type: slides.
 
 PowerPoint2PDFSettingDataE_OutputThreeSlideHandouts
 Output type: handouts with three slide per handout page.
 
 PowerPoint2PDFSettingDataE_OutputTwoSlideHandouts
 Output type: handouts with two slide per handout page.
 
 PrintDeviceSettingDataE_Landscape
 Landscape orientation for printing.
 
 PrintDeviceSettingDataE_Portrait
 Portrait orientation for printing.
 
 PrintParamsE_BookletBindingLeft
 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.
 
 PrintParamsE_BookletBindingLeftTall
 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.
 
 PrintParamsE_BookletBindingRight
 Booklet Binding: Left-side binding for Western-style left-to-right reading direction. The paper is folded on the short side.
 
 PrintParamsE_BookletBindingRightTall
 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.
 
 PrintParamsE_BookletDuplexModeBackSideOnly
 Booklet Duplex Mode: only prints all pages that appear on the back side of the paper.
 
 PrintParamsE_BookletDuplexModeBothSides
 Booklet Duplex Mode: automatically prints both sides of the paper.
 
 PrintParamsE_BookletDuplexModeFrontSideOnly
 Booklet Duplex Mode: only prints all pages that appear on the front side of the paper.
 
 PrintParamsE_DuplexTypeDuplexFlipLongEdge
 Duplex type: prints on both sides of the paper; the paper flips along the long edge.
 
 PrintParamsE_DuplexTypeDuplexFlipShortEdge
 Duplex type: prints on both sides of the paper; the paper flips along the short edge.
 
 PrintParamsE_DuplexTypeSimplex
 Duplex type: prints on one side of the paper.
 
 PrintParamsE_PageOrderHorizontal
 Page Order type: pages are placed from left to right, from top to bottom.
 
 PrintParamsE_PageOrderHorizontalReversed
 Page Order type: pages are placed from right to left, from top to bottom.
 
 PrintParamsE_PageOrderVertical
 Page Order type: pages are placed from top to bottom, from left to right.
 
 PrintParamsE_PrintContentDocAndAnnots
 Print Content: print the document contents and comments.
 
 PrintParamsE_PrintContentDocument
 Print Content: print the document contents, not comments.
 
 PrintParamsE_PrintContentFormFieldsOnly
 Print Content: print the contents of form fields only. Useful for printing onto pre-preprinted forms.
 
 PrintParamsE_PrintHandlingBooklet
 Print Handling: Prints multiple pages on the same sheet of paper in the order required to read correctly when folded.
 
 PrintParamsE_PrintHandlingFitPaper
 Print Handling: Pages are enlarged or shrunk to fit the printe's paper.
 
 PrintParamsE_PrintHandlingMultiplePages
 Print Handling: Pages are rescaled to print multiple pages on each printer page.
 
 PrintParamsE_PrintHandlingNone
 Print Handling: No page scaling is applied.
 
 PrintParamsE_PrintHandlingReducePaper
 Print Handling: Small pages are printed small, and large pages are shrunk to fit on the printer's paper.
 
 PrintParamsE_PrintHandlingTileLargePages
 Print Handling: Small or normal pages are printed in the original size and large pages are printed on multiple sheets of paper.
 
 ProgressiveE_Error
 Progress state: any error occurs.
 
 ProgressiveE_Finished
 Progress state: progress is finished.
 
 ProgressiveE_ToBeContinued
 Progress state: progress needs to be continued.
 
 RangeE_All
 All the indexes within a range will be used.
 
 RangeE_Even
 Only even numbers in a range will be used (discards odd numbers).
 
 RangeE_Odd
 Only odd numbers in a range will be used (discards even numbers).
 
 ReflowPageE_Normal
 Parsing flag for normal mode, without image.
 
 ReflowPageE_NoTruncate
 Parsing flag to decide whether to allow to truncate the first/last image or line of text within the specified screen size or not. More...
 
 ReflowPageE_WithImage
 Parsing flag for image mode.
 
 RendererE_ColorModeAlpha
 Output alpha only, ignore color.
 
 RendererE_ColorModeForeground
 Custom color mode. map colors to foreground.
 
 RendererE_ColorModeForegroundBlackPath
 If set, only the black color of path need to be replaced.
 
 RendererE_ColorModeForegroundBlackText
 If set, only the black color of text need to be replaced.
 
 RendererE_ColorModeForegroundPath
 If set, the color of path need to be replaced.
 
 RendererE_ColorModeForegroundText
 If set, the color of text need to be replaced.
 
 RendererE_ColorModeMapping
 Map a color value to the color range defined by a background color and a foreground color.
 
 RendererE_ColorModeMappingGray
 Map gray/white/black color value to background/foreground; for other colors, no change.
 
 RendererE_ColorModeNormal
 Normal color mode.
 
 RendererE_RenderAnnot
 If set, annotations will be rendered.
 
 RendererE_RenderExceptHighlight
 If set, all annotations expect highlight will be rendered.
 
 RendererE_RenderHighlight
 If set, only highlight annotations will be rendered.
 
 RendererE_RenderPage
 If set, page content will be rendered.
 
 RendererE_RenderScreen
 If set, only screen annotations will be rendered.
 
 RenditionActionE_OpTypeAssociate
 Associate rendition to related screen annotation. More...
 
 RenditionActionE_OpTypeNone
 No operation is specified.
 
 RenditionActionE_OpTypePause
 Pause any rendition being played in association with related screen annotation. If no rendition is being played, there is no effect.
 
 RenditionActionE_OpTypePlay
 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.
 
 RenditionActionE_OpTypeResume
 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.
 
 RenditionActionE_OpTypeStop
 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.
 
 RenditionE_FloatingWindowOffscreenEventMoveResize
 Move or resize.
 
 RenditionE_FloatingWindowOffscreenEventNone
 Nothing.
 
 RenditionE_FloatingWindowOffscreenEventNonViable
 Consider the object non-viable.
 
 RenditionE_FloatingWindowRelatedWindowApplication
 The application window.
 
 RenditionE_FloatingWindowRelatedWindowDocument
 The document window.
 
 RenditionE_FloatingWindowRelatedWindowFullDesktop
 The full virtual desktop.
 
 RenditionE_FloatingWindowRelatedWindowMonitor
 Depends on monitor specifier.
 
 RenditionE_FloatingWindowResizeTypeAnyway
 May be resized without preserving aspect ratio.
 
 RenditionE_FloatingWindowResizeTypeAspectRatio
 May be resized only if aspect ratio is preserved.
 
 RenditionE_FloatingWindowResizeTypeNo
 May not be resized.
 
 RenditionE_MediaOptionBestEffort
 Options defined in this type need only be honored in a "best effort" sense.
 
 RenditionE_MediaOptionMustBeHonored
 Options defined in this type must be honored for rendition object to be considered viable.
 
 RenditionE_MediaPermTempAccess
 Allowed only if the document permissions allow content extraction, including for accessibility purposes.
 
 RenditionE_MediaPermTempAlways
 Always allowed.
 
 RenditionE_MediaPermTempExtract
 Allowed only if the document permissions allow content extraction.
 
 RenditionE_MediaPermTempNever
 Never allowed.
 
 RenditionE_MediaPlayerAvailable
 Any of players in this type may be used in playing the associated media clip.
 
 RenditionE_MediaPlayerFitStyleDefault
 Use the player's default setting (author has no preference).
 
 RenditionE_MediaPlayerFitStyleFill
 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.
 
 RenditionE_MediaPlayerFitStyleHidden
 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.
 
 RenditionE_MediaPlayerFitStyleMeet
 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.
 
 RenditionE_MediaPlayerFitStyleScroll
 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.
 
 RenditionE_MediaPlayerFitStyleSlice
 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.
 
 RenditionE_MediaPlayerMustUsed
 One of players in this type must be used in playing the associated media clip.
 
 RenditionE_MediaPlayerNotUsed
 Players in this type must not be used in playing the associated media clip.
 
 RenditionE_MonitorSpecifierGreatestArea
 Monitor with the greatest area (in pixels squared)
 
 RenditionE_MonitorSpecifierGreatestColorDepth
 Monitor with the greatest color depth.
 
 RenditionE_MonitorSpecifierGreatestHeight
 Monitor with the greatest height (in pixels)
 
 RenditionE_MonitorSpecifierGreatestWidth
 Monitor with the greatest width (in pixels)
 
 RenditionE_MonitorSpecifierLargest
 The monitor that contains the largest section of the document window.
 
 RenditionE_MonitorSpecifierPrimary
 Primary monitor. If no monitor is considered primary, use case 0.
 
 RenditionE_MonitorSpecifierSmallest
 The monitor that contains the smallest section of the document window.
 
 RenditionE_WindowTypeAnnotRect
 Window type: the rectangle occupied by the screen annotation which is associated with the rendition object.
 
 RenditionE_WindowTypeFloating
 Window type: a floating window.
 
 RenditionE_WindowTypeFullScreen
 Window type: a full-screen window that obscures all other windows.
 
 RenditionE_WindowTypeHidden
 Window type: a hidden window.
 
 ResponseE_TypeCRL
 CRL response.
 
 ResponseE_TypeNone
 No response.
 
 ResponseE_TypeOCSP
 OCSP response.
 
 RichTextStyleE_CornerMarkNone
 Corner mark style: none.
 
 RichTextStyleE_CornerMarkSubscript
 Corner mark style: subscript.
 
 RichTextStyleE_CornerMarkSuperscript
 Corner mark style: superscript.
 
 SearchOptionE_WordMatchingMatchAllWords
 Word matching: match all words.
 
 SearchOptionE_WordMatchingMatchAnyWord
 Word matching: match any word.
 
 SearchOptionE_WordMatchingMatchPhrase
 Word matching: match phrase.
 
 SecurityHandlerE_CipherAES
 Use AES encryption algorithm, with the key length be 16 bytes (as AES-128) or 32 bytes (as AES-256, only supported in PDF 2.0).
 
 SecurityHandlerE_CipherNone
 Not use encryption algorithm.
 
 SecurityHandlerE_CipherRC4
 Use RC4 encryption algorithm, with the key length between 5 bytes and 16 bytes.
 
 SetOCGStateActionE_OCGStateOff
 Sets the state of subsequent groups to OFF.
 
 SetOCGStateActionE_OCGStateOn
 Sets the state of subsequent groups to ON.
 
 SetOCGStateActionE_OCGStateToggle
 Reverses the state of subsequent groups.
 
 SignatureCallbackE_CertCannotGetPrivateKey
 Certificate's private key cannot be gotten.
 
 SignatureCallbackE_CertDataError
 Certificate's data is error.
 
 SignatureCallbackE_CertExpired
 Certificate is expired.
 
 SignatureCallbackE_CertInvalidPassword
 Certificate's password is wrong.
 
 SignatureCallbackE_CertInvalidPath
 Certificate's path is wrong.
 
 SignatureCallbackE_CertNotSet
 Certificate is not set to sign a signature.
 
 SignatureCallbackE_CertUnsupportType
 Certificate is unsupport type.
 
 SignatureCallbackE_CertValid
 Certificate is valid.
 
 SignatureE_APFlagBitmap
 If set, show bitmap on signature appearance.
 
 SignatureE_APFlagDN
 If set, show distinguish name on signature appearance.
 
 SignatureE_APFlagFoxitEditorFlag
 If set, show Foxit Editor content on signature appearance.
 
 SignatureE_APFlagFoxitFlag
 If set, show Foxit flag on signature appearance.
 
 SignatureE_APFlagLabel
 If set, show label on signature appearance.
 
 SignatureE_APFlagLocation
 If set, show location on signature appearance.
 
 SignatureE_APFlagProducer
 If set, show producer content on signature appearance.
 
 SignatureE_APFlagReason
 If set, show reason on signature appearance.
 
 SignatureE_APFlagSigner
 If set, show signer on signature appearance.
 
 SignatureE_APFlagSigningTime
 If set, show signing time on signature appearance.
 
 SignatureE_APFlagText
 If set, show text content on signature appearance.
 
 SignatureE_DigestSHA1
 Signature digest algorithm: sha1 algorithm.
 
 SignatureE_DigestSHA256
 Signature digest algorithm: sha256 algorithm.
 
 SignatureE_DigestSHA384
 Signature digest algorithm: sha384 algorithm.
 
 SignatureE_DigestSHA512
 Signature digest algorithm: sha512 algorithm.
 
 SignatureE_DocPermFillingFormAndSigning
 Permitted changes are filling in forms, instantiating page templates, and signing. Other changes will invalidate the signature.
 
 SignatureE_DocPermFillingFormSigningAndAnnotating
 Permitted changes are the same as for 2, as well as annotation creation, deletion, and modification. Other changes will invalidate the signature.
 
 SignatureE_DocPermNoChangesAllowed
 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.
 
 SignatureE_DocPermUnrestricted
 No restriction.
 
 SignatureE_FieldMDPActionAll
 All form fields' flags will be set read-only.
 
 SignatureE_FieldMDPActionExclude
 Flags of form fields (except specified form fields) will be set read-only. More...
 
 SignatureE_FieldMDPActionInclude
 Specified form fields' flags will be set read-only. More...
 
 SignatureE_FieldMDPActionNone
 No Field MDP action.
 
 SignatureE_KeyNameContactInfo
 Signature key name: contact information.
 
 SignatureE_KeyNameDN
 Signature key name: distinguish name.
 
 SignatureE_KeyNameLocation
 Signature key name: location.
 
 SignatureE_KeyNameProducer
 Signature key name: producer content.
 
 SignatureE_KeyNameReason
 Signature key name: reason.
 
 SignatureE_KeyNameSigner
 Signature key name: signer.
 
 SignatureE_KeyNameText
 Signature key name: text content.
 
 SignatureE_LabelNameDN
 Signature key name for distinguish name. More...
 
 SignatureE_LabelNameLocation
 Signature label name for location. More...
 
 SignatureE_LabelNameProducer
 Signature key name for producer name. More...
 
 SignatureE_LabelNameReason
 Signature label name for reason. More...
 
 SignatureE_LabelNameSigner
 Signature label name for signer. More...
 
 SignatureE_LabelNameSignTime
 Signature label name for sign time. More...
 
 SignatureE_PAdESLevelBB
 PAdES level: B-B.
 
 SignatureE_PAdESLevelBLT
 PAdES level: B-LT.
 
 SignatureE_PAdESLevelBLTA
 PAdES level: B-LTA.
 
 SignatureE_PAdESLevelBT
 PAdES level: B-T.
 
 SignatureE_PAdESLevelNone
 PAdES level: none.
 
 SignatureE_PAdESLevelNotPAdES
 Not a PAdES signature.
 
 SignatureE_SignatureTypeOrdinary
 Signature type: ordinary.
 
 SignatureE_SignatureTypePagingSeal
 Signature type: paging seal.
 
 SignatureE_SignatureTypeTimeStamp
 Signature type: time stamp.
 
 SignatureE_StateCertCannotGetVRI
 Cannot get verify relevant information.
 
 SignatureE_StateNoSignData
 Signature does not have any data for signing.It means that there is not "V" entry in the signature dictionary.
 
 SignatureE_StateSigned
 Signed signature.
 
 SignatureE_StateUnknown
 Unknown signature.
 
 SignatureE_StateUnsigned
 Unsigned signature.
 
 SignatureE_StateVerifyChange
 The document has been changed within the scope of the signature. (This indicates that signature is invalid.)
 
 SignatureE_StateVerifyChangeIllegal
 The document has been changed outside of signature scope, and the changed invalidate the signature.
 
 SignatureE_StateVerifyChangeLegal
 The document has been changed outside of signature scope, but the changed is permitted.
 
 SignatureE_StateVerifyErrorByteRange
 Non expected byte range.
 
 SignatureE_StateVerifyErrorData
 Signature data is destroyed (that means the signature data cannot be parsed properly).
 
 SignatureE_StateVerifyIncredible
 Signature cannot be trusted (containing aggression).
 
 SignatureE_StateVerifyInvalid
 Verification state of a signature is invalid.
 
 SignatureE_StateVerifyIssueCurrent
 The verified issue is current issuer.
 
 SignatureE_StateVerifyIssueExpire
 Certificate for verifying issuer is expired.
 
 SignatureE_StateVerifyIssueRevoke
 Certificate for verifying issuer is revoked.
 
 SignatureE_StateVerifyIssueUncheck
 Not check the issuer.
 
 SignatureE_StateVerifyIssueUnknown
 Verification state of the issuer is unknown.
 
 SignatureE_StateVerifyIssueValid
 Verification state of the issuer is valid.
 
 SignatureE_StateVerifyNoChange
 The document has not been changed within the scope of the signature.
 
 SignatureE_StateVerifyNoSupportWay
 Unsupported signature.
 
 SignatureE_StateVerifyTimestampDoc
 The signature is a time stamp signature.
 
 SignatureE_StateVerifyTimestampExpire
 Verification state of the time stamp is expired.
 
 SignatureE_StateVerifyTimestampInvalid
 Verification state of the time stamp is invalid.
 
 SignatureE_StateVerifyTimestampIssueUnknown
 Verification state of the time stamp issuer is unknown.
 
 SignatureE_StateVerifyTimestampIssueValid
 Verification state of the time stamp issuer is valid.
 
 SignatureE_StateVerifyTimestampNone
 No time stamp or not check time stamp.
 
 SignatureE_StateVerifyTimestampTimeBefore
 Verification state of the time stamp time is valid, since the times is before the expiration date.
 
 SignatureE_StateVerifyTimestampValid
 Verification state of the time stamp is valid.
 
 SignatureE_StateVerifyValid
 Verification state of a signature is valid.
 
 SignatureVerifyResultE_LTVStateEnable
 This means LTV is enabled.
 
 SignatureVerifyResultE_LTVStateInactive
 This means LTV is inactive.
 
 SignatureVerifyResultE_LTVStateNotEnable
 This means LTV is not enabled.
 
 SnappedPointE_TypeEndpoint
 Snapped point type: endpoint, which means the snapped point is an endpoint of a path.
 
 SnappedPointE_TypeIntersectionPoint
 Snapped point type: intersection point, which means the snapped point is the intersection of two intersecting paths.
 
 SnappedPointE_TypeMidpoint
 Snapped point type: midpoint, which means the snapped point is the midpoint for two endpoints of a path.
 
 SnappedPointE_TypeNearestPoint
 Snapped point type: nearest point, which means the snapped point is the nearest point (which is in a path) to the specified point.
 
 SnappedPointE_TypeNone
 This means the snapped point is invalid.
 
 SnapPointMgrE_FlagEndpoint
 If set, that means to get the endpoint of a path.
 
 SnapPointMgrE_FlagIntersectionPoint
 If set, that means to get the intersection of two intersecting paths.
 
 SnapPointMgrE_FlagMidpoint
 If set, that means to get the midpoint for two endpoints of a path.
 
 SnapPointMgrE_FlagNearestPoint
 If set, that means to get the nearest point (which is in a path) to the specified point.
 
 SoundE_SampleEncodingFormatALaw
 A-law-encoded samples.
 
 SoundE_SampleEncodingFormatMuLaw
 μ-law-encoded samples
 
 SoundE_SampleEncodingFormatRaw
 Unspecified or unsigned values in the range 0 to (2^B - 1).
 
 SoundE_SampleEncodingFormatSigned
 Twos-complement values.
 
 SplitFileResultE_SplitFileErrAccessDeny
 The state is failed due to file access being denied. More...
 
 SplitFileResultE_SplitFileErrFileExist
 The state is failed due to file exist. More...
 
 SplitFileResultE_SplitFileErrSizeTooSmall
 The state is failed due to file size being too small. More...
 
 SplitFileResultE_SplitFileSuccess
 The state is split successfully.
 
 StdSecurityHandlerE_ModifyOwnerPassword
 If set, only owner password will be modified during encryption process.
 
 StdSecurityHandlerE_ModifyPermission
 If set, user permissions and "is encrypt metadata" values (which are defined in StdEncryptData ) will be modified during encryption process.
 
 StdSecurityHandlerE_ModifyUserPassword
 If set, user password and owner password will be modified during encryption process.
 
 StructElementE_ElementInfoTypeActualText
 Structure element info type: Actual Text, which means the actual text of structure element.
 
 StructElementE_ElementInfoTypeAltDescription
 Structure element info type: Alternative Description, which means the alternative description of structure element.
 
 StructElementE_ElementInfoTypeExpandedForm
 Structure element info type: Expanded Form, which means the expanded form of structure element.
 
 StructElementE_ElementInfoTypeLanguage
 Structure element info type: Language, which means the natural language for all text in the structure element except where overridden by language specifications for nested structure elements or marked content.
 
 StructElementE_ElementInfoTypeTitle
 Structure element info type: Title, which means the title of the structure element. A text string representing it in human-readable form.
 
 StructObjectContentE_StructObjectTypeAnnot
 Annot object.
 
 StructObjectContentE_StructObjectTypeForm
 Form object.
 
 StructObjectContentE_StructObjectTypeImage
 Image object.
 
 StructObjectContentE_StructObjectTypeInvalid
 Invaild object.
 
 StructObjectContentE_UnknownType
 Unknown Type.
 
 StructTreeEntityE_StructTreeEntityTypeElement
 Structure tree entity type: Element, which represents a structure element.
 
 StructTreeEntityE_StructTreeEntityTypeMarkedContent
 Structure tree entity type: MarkedContent, which represents a marked-content item.
 
 StructTreeEntityE_StructTreeEntityTypeObjectContent
 Structure tree entity type: ObjectContent, which represents a PDF object content item, such as annotation and XObject.
 
 StructTreeEntityE_UnknownType
 Structure tree entity type: unknown.
 
 SubmitFormActionE_FlagAsXFDF
 Bit 6. Field names and values are submitted as XFDF.
 
 SubmitFormActionE_FlagCanonicalFormat
 Bit 10. Any submitted field values representing dates are converted to the standard format.
 
 SubmitFormActionE_FlagEmbedForm
 Bit 14. "F" entry of submitted FDF is an embedded file stream.
 
 SubmitFormActionE_FlagExclFKey
 Bit 12. Submitted FDF excludes "F" entry.
 
 SubmitFormActionE_FlagExclNonUserAnnots
 Bit 11. Only those markup annotations whose "T" entry matches the name of the current user are being submitted.
 
 SubmitFormActionE_FlagExclude
 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.
 
 SubmitFormActionE_FlagExportFormat
 Bit 3. Field names and values are submitted in HTML Form format. More...
 
 SubmitFormActionE_FlagGetMethod
 Bit 4. Field names and values are submitted using an HTTP GET request. More...
 
 SubmitFormActionE_FlagIncludeAnnotations
 Bit 8. Submitted FDF file includes all markup annotations in underlying PDF document. More...
 
 SubmitFormActionE_FlagIncludeAppendSaves
 Bit 7. Submitted FDF file includes contents as contained in differences entry in the FDF dictionary. More...
 
 SubmitFormActionE_FlagIncludeNoValueFields
 Bit 2. Submit fields regardless of whether they have a value. More...
 
 SubmitFormActionE_FlagSubmitAsPDF
 Bit 9. The document is submitted as PDF.
 
 SubmitFormActionE_FlagWithCoordinates
 Bit 5. Coordinates of the mouse are transmitted as part of the form data.
 
 TableBorderInfoE_TableBorderStyleDashed
 Table border style: Dashed.
 
 TableBorderInfoE_TableBorderStyleSolid
 Table border style: Solid.
 
 TabOrderMgrE_Column
 C (column order): Annotations are visited in columns running vertically up and down the page.
 
 TabOrderMgrE_None
 None (index order): Annotations are visited in annotation's index across the page.
 
 TabOrderMgrE_Row
 R (row order): Annotations are visited in rows running horizontally across the page.
 
 TabOrderMgrE_Structure
 S (structure order): Annotations are visited in the order in which they appear in the structure tree.
 
 TaggedPDFCallbackE_ReportCategoryArtifact
 Report category type: artifact.
 
 TaggedPDFCallbackE_ReportCategoryFigure
 Report category type: figure.
 
 TaggedPDFCallbackE_ReportCategoryListItem
 Report category type: list item.
 
 TaggedPDFCallbackE_ReportCategoryParagraph
 Report category type: paragraph.
 
 TaggedPDFCallbackE_ReportCategoryRegion
 Report category type: region.
 
 TaggedPDFCallbackE_ReportCategoryTable
 Report category type: table.
 
 TaggedPDFCallbackE_ReportCategoryTableHeader
 Report category type: table header.
 
 TaggedPDFCallbackE_ReportCategoryTableRow
 Report category type: table row.
 
 TaggedPDFCallbackE_ReportCategoryTocItem
 Report category type: toc item.
 
 TaggedPDFCallbackE_ReportConfidenceHigh
 Report confidence: high.
 
 TaggedPDFCallbackE_ReportConfidenceLow
 Report confidence: low.
 
 TaggedPDFCallbackE_ReportConfidenceMedium
 Report confidence: medium.
 
 TaggedPDFCallbackE_ReportConfidenceMediumHigh
 Report confidence: medium high.
 
 TaggedPDFCallbackE_ReportConfidenceMediumLow
 Report confidence: medium low.
 
 TextPageCharInfoE_ComboWord
 Character flag: ComboWord.
 
 TextPageCharInfoE_Generated
 Character flag: Generated.
 
 TextPageCharInfoE_Hyphen
 Character flag: Hyphen.
 
 TextPageCharInfoE_Normal
 Character flag: Normal.
 
 TextPageCharInfoE_Unknown
 Character flag: Unknown.
 
 TextPageCharInfoE_UnUnicode
 Character flag: UnUnicode.
 
 TextPageE_ParseTextNormal
 Parse the text content of a PDF page by normalizing characters based on their positions in the PDF page.
 
 TextPageE_ParseTextOutputHyphen
 Parse the text content of a PDF page with outputting the hyphen on a line feed.
 
 TextPageE_ParseTextUseStreamOrder
 Parse the text content of a PDF page by the stream order.
 
 TextPageE_TextDisplayOrder
 If this is set, that means to get text content of a PDF page by the display order.
 
 TextPageE_TextStreamOrder
 If this is set, that means to get text content of a PDF page by the stream order.
 
 TextSearchE_SearchConsecutive
 If set, match the key word consecutively when searching. For example, "CC" will be matched twice in "CCC".
 
 TextSearchE_SearchMatchCase
 If set, match the case of keyword when searching.
 
 TextSearchE_SearchMatchWholeWord
 If set, match the whole word of keyword when searching.
 
 TextSearchE_SearchNormal
 No special searching options.
 
 TextSearchE_SearchNotMatchFullWidth
 If set, to ignore full-width characters and treat all characters as standard ASCII or standard-width characters during searches.
 
 TextStateE_ModeClip
 Text mode: add text to path for clipping.
 
 TextStateE_ModeFill
 Text mode: fill text.
 
 TextStateE_ModeFillClip
 Text mode: fill text and add to path for clipping.
 
 TextStateE_ModeFillStroke
 Text mode: fill and stroke text.
 
 TextStateE_ModeFillStrokeClip
 Text mode: fill and stroke text, and add to path for clipping.
 
 TextStateE_ModeInvisible
 Text mode: neither fill nor stroke text, to make it invisible.
 
 TextStateE_ModeStroke
 Text mode: stroke text.
 
 TextStateE_ModeStrokeClip
 Text mode: stroke text and add to path for clipping.
 
 TiledWatermarkSettingsE_FlagAsAnnot
 If set, the watermark will be an annotation when inserted to a PDF page, and the watermark will be show above other content.
 
 TiledWatermarkSettingsE_FlagAsPageContents
 If set, the watermark will be a part of page content when inserted to a PDF page.
 
 TiledWatermarkSettingsE_FlagInvisible
 If set, do not display a watermark.
 
 TiledWatermarkSettingsE_FlagNoPrint
 If set, do not print a watermark.
 
 TiledWatermarkSettingsE_FlagOnTop
 If set, show watermark above other page content.
 
 TimeStampServerE_SendResultFailToConnect
 Fail to connect during sending request process.
 
 TimeStampServerE_SendResultFailToCreateSocket
 Fail to create socket during sending request process.
 
 TimeStampServerE_SendResultFailToGetData
 Fail to get data during sending request process.
 
 TimeStampServerE_SendResultFailToReceiveData
 Fail to receive data during sending request process.
 
 TimeStampServerE_SendResultFailToRequest
 Fail to request during sending request process.
 
 TimeStampServerE_SendResultFailToSendData
 Fail to send data during sending request process.
 
 TimeStampServerE_SendResultOutOfMemory
 Out of memory during sending request process.
 
 TimeStampServerE_SendResultSuccess
 Send request successfully.
 
 WatermarkSettingsE_FlagASAnnot
 If set, the watermark will be an annotation when inserted to a PDF page.
 
 WatermarkSettingsE_FlagASPageContents
 If set, the watermark will be a part of page content when inserted to a PDF page.
 
 WatermarkSettingsE_FlagInvisible
 If set, do not display a watermark.
 
 WatermarkSettingsE_FlagNoPrint
 If set, do not print a watermark.
 
 WatermarkSettingsE_FlagOnTop
 If set, show watermark above other page content.
 
 WatermarkSettingsE_FlagShareImageStream
 If set, watermarks will share one image stream if these watermarks use the same image or bitmap.
 
 WatermarkSettingsE_FlagSharePageStream
 If set, watermarks will share one form xobject if these watermarks use the same page object.
 
 WatermarkSettingsE_FlagShareTextStream
 If set, watermarks will share one form xobject if these watermarks use the same text and text's related properties.
 
 WatermarkTextPropertiesE_FontStyleNormal
 Watermark font style: normal.
 
 WatermarkTextPropertiesE_FontStyleUnderline
 Watermark font style: with underline.
 
 WidgetE_LineSpacingAuto
 Line spacing style: auto line spacing.
 
 WidgetE_LineSpacingDouble
 Line spacing style: double line spacing.
 
 WidgetE_LineSpacingExactValue
 Line spacing style: exact value line spacing.
 
 WidgetE_LineSpacingOneAndHalf
 Line spacing style: one and half times line spacing.
 
 WidgetE_LineSpacingSingle
 Line spacing style: single line spacing.
 
 Word2PDFSettingDataE_ConvertBookmarkOptionNone
 Do not create bookmark in converted PDF file.
 
 Word2PDFSettingDataE_ConvertBookmarkOptionUseHeadings
 Create bookmarks in converted PDF file by using each heading of Word document. More...
 
 Word2PDFSettingDataE_ConvertBookmarkOptionUseWordBookmark
 Create bookmarks in converted PDF file by using each bookmarks of Word document. More...
 
 Word2PDFSettingDataE_ConvertContentOptionOnlyContent
 Convert Word document without markup.
 
 Word2PDFSettingDataE_ConvertContentOptionWithMarkup
 Convert Word document with markup.
 
 Word2PDFSettingDataE_ConvertOptimizeOptionForOnScreen
 Optimize option: convert for screen, which is a lower quality and results in a smaller file size.
 
 Word2PDFSettingDataE_ConvertOptimizeOptionForPrint
 Optimize option: convert for print, which is higher quality and results in a larger file size.
 
 XFADocE_Dynamic
 XFA document type: Dynamic.
 
 XFADocE_EventTypePostPrint
 This kind of event is triggered just after the rendered form has been sent to the printer, spooler, or output destination.
 
 XFADocE_EventTypePrePrint
 This kind of event is triggered just before the rendering for printing begins.
 
 XFADocE_EventTypeUnknown
 Event type: Unknown.
 
 XFADocE_ExportDataTypeStaticXDP
 Type of exported data: Static XDP.
 
 XFADocE_ExportDataTypeXDP
 Type of exported data: XDP.
 
 XFADocE_ExportDataTypeXML
 Type of exported data: XML.
 
 XFADocE_Static
 XFA document type: Static.
 
 XFADocE_XDP
 XFA document type: XDP, as Raw XML data.
 
 XFAWidgetE_HitTestAreaClient
 Hit test area: Client.
 
 XFAWidgetE_HitTestAreaHyperLink
 Hit test area: HyperLink.
 
 XFAWidgetE_HitTestAreaTitleBar
 Hit test area: Title Bar.
 
 XFAWidgetE_HitTestAreaUnknown
 Hit test area: Unknown.
 
 XFAWidgetE_PresenceHidden
 Presence property: Hidden. Participate in interaction but not layout or rendering.
 
 XFAWidgetE_PresenceInactive
 Presence property: Inactive. Do not participate in interaction, layout, or rendering.
 
 XFAWidgetE_PresenceInvisible
 Presence property: Invisible. Participate in interaction and layout but not rendering.
 
 XFAWidgetE_PresenceUnknown
 Presence property: Unknown.
 
 XFAWidgetE_PresenceVisible
 Presence property: Visible. Participate in interaction, layout, and rendering.
 
 XFAWidgetE_WidgetEdgePositionBottom
 Egde position: bottom.
 
 XFAWidgetE_WidgetEdgePositionLeft
 Egde position: left.
 
 XFAWidgetE_WidgetEdgePositionRight
 Egde position: right.
 
 XFAWidgetE_WidgetEdgePositionTop
 Egde position: top.
 
 XFAWidgetE_WidgethAlignTypeCenter
 Center the text horizontally within the available region.
 
 XFAWidgetE_WidgethAlignTypeJustify
 Left-align the last line and spread-justify the rest.
 
 XFAWidgetE_WidgethAlignTypeJustifyAll
 Spread-justify all lines to fill the available region.
 
 XFAWidgetE_WidgethAlignTypeLeft
 Align the text to the left edge of the available region.
 
 XFAWidgetE_WidgethAlignTypeRadix
 Align the radix indicator.
 
 XFAWidgetE_WidgethAlignTypeRight
 Align the text to the right edge of the available region.
 
 XFAWidgetE_WidgetNameTypeCaption
 Name type: caption name. Name in this type will be retrieved from caption entry.
 
 XFAWidgetE_WidgetNameTypeField
 Name type: field name. Name in this type will be retrieved from XFA widget's name entry and this may an empty string.
 
 XFAWidgetE_WidgetNameTypeFullName
 Name type: full name.
 
 XFAWidgetE_WidgetTypeArc
 XFA widget type: arc.
 
 XFAWidgetE_WidgetTypeBarcode
 XFA widget type: barcode.
 
 XFAWidgetE_WidgetTypeCheckButton
 XFA widget type: check button.
 
 XFAWidgetE_WidgetTypeChoiceList
 XFA widget type: choice list.
 
 XFAWidgetE_WidgetTypeDateTimeEdit
 XFA widget type: date time edit.
 
 XFAWidgetE_WidgetTypeExclGroup
 XFA widget type: Exclusion Group for radio button only.
 
 XFAWidgetE_WidgetTypeImage
 XFA widget type: image.
 
 XFAWidgetE_WidgetTypeImageEdit
 XFA widget type: image edit.
 
 XFAWidgetE_WidgetTypeLine
 XFA widget type: line.
 
 XFAWidgetE_WidgetTypeNumericEdit
 XFA widget type: numeric edit.
 
 XFAWidgetE_WidgetTypePasswordEdit
 XFA widget type: password edit.
 
 XFAWidgetE_WidgetTypePushButton
 XFA widget type: push button.
 
 XFAWidgetE_WidgetTypeRadioButton
 XFA widget type: radio button.
 
 XFAWidgetE_WidgetTypeRectangle
 XFA widget type: rectangle.
 
 XFAWidgetE_WidgetTypeSignature
 XFA widget type: signature.
 
 XFAWidgetE_WidgetTypeTextEdit
 XFA widget type: text edit.
 
 XFAWidgetE_WidgetTypeUnknown
 XFA widget type: unknown.
 
 XFAWidgetE_WidgetvAlignTypeBottom
 Align the text to the bottom of the available region.
 
 XFAWidgetE_WidgetvAlignTypeMiddle
 Align the text so that it is centered between the top and bottom of the available region.
 
 XFAWidgetE_WidgetvAlignTypeTop
 Align the text to the top of the available region.
 

Detailed Description

fsdk namespace.

Function Documentation

◆ ActionCreate()

def fsdk.ActionCreate ( )

Create a new action, for specified action type.

The newly created action has no action data (except action type) yet. User needs to call the functions in concrete action classes to set action data.

Parameters
[in]documentA valid PDF document, to which the new action belongs.
[in]action_typeAction type, used to specify which type of action is to be created. Currently only support:
fsdk.ActionE_TypeGoto , fsdk.ActionE_TypeURI , fsdk.ActionE_TypeJavaScript , fsdk.ActionE_TypeNamed , fsdk.ActionE_TypeGoToR , fsdk.ActionE_TypeGoToE , fsdk.ActionE_TypeSubmitForm , fsdk.ActionE_TypeResetForm , fsdk.ActionE_TypeHide , fsdk.ActionE_TypeLaunch , fsdk.ActionE_TypeImportData , fsdk.ActionE_TypeRendition , fsdk.ActionE_TypeSetOCGState , fsdk.ActionE_TypeThread ,
Returns
A new action object, with no action data.

◆ CodecBase64Decode()

def fsdk.CodecBase64Decode ( )

Decode the encoded data buffer by Base64 algorithm.

Parameters
[in]encoded_data_bufferThe encoded source data buffer.
[in]lengthThe length of data buffer in byte.
Returns
The decoded data.

◆ CodecBase64Encode()

def fsdk.CodecBase64Encode ( )

Encode the source data buffer by Base64 algorithm.

Parameters
[in]data_bufferThe raw source data buffer.
[in]lengthThe length of data buffer in byte.
Returns
The encoded data.

◆ CodecFlateCompress()

def fsdk.CodecFlateCompress ( )

Compress the source data buffer by DEFLATE algorithm.

Parameters
[in]data_bufferThe raw source data buffer.
[in]lengthThe length of data buffer in byte.
Returns
The compressed data.

◆ CodecFlateDecompress()

def fsdk.CodecFlateDecompress ( )

Decompress the compressed data buffer by DEFLATE algorithm.

Parameters
[in]compressed_data_bufferThe compressed source data buffer.
[in]lengthThe length of data buffer in byte.
Returns
The decompressed data.

◆ CombinationStartCombineDocuments()

def fsdk.CombinationStartCombineDocuments ( )

Start to combine PDF files.

It may take a long time to combining documents, so Foxit PDF SDK uses a progressive process to do this. This function does not support to combine XFA document.

Parameters
[in]dest_file_pathA full path to save the combined result PDF file. This should not be an empty string.
[in]document_arrayAn information array which represents information of source PDF files which are to be combined.
[in]optionsOptions for combining PDF documents. Please refer to values starting from fsdk.CombinationE_CombineDocsOptionBookmark and this can be one or a combination of these values. 0 means no option is used.
[in]pausePause object which decides if the combining process needs to be paused. This can be null which means not to pause during the parsing process. If this is not null, it should be a valid pause object implemented by user. Default value: null.
Returns
A progressive object. Please check the rate of current progress by function fsdk.Progressive.GetRateOfProgress . If the rate is not 100 yet, call function fsdk.Progressive.Continue to continue the progress until the progress is finished.

It may take a long time to combining documents, so Foxit PDF SDK uses a progressive process to do this. This function does not support to combine XFA document.

Parameters
[in]dest_fileA fsdk.FileWriterCallback object which is implemented by user to store the data of combined result PDF file in custom method.
[in]document_arrayAn information array which represents information of source PDF files which are to be combined.
[in]optionsOptions for combining PDF documents. Please refer to values starting from fsdk.CombinationE_CombineDocsOptionBookmark and this can be one or a combination of these values. 0 means no option is used.
[in]pausePause object which decides if the combining process needs to be paused. This can be null which means not to pause during the parsing process. If this is not null, it should be a valid pause object implemented by user. Default value: null.
Returns
A progressive object. Please check the rate of current progress by function fsdk.Progressive.GetRateOfProgress . If the rate is not 100 yet, call function fsdk.Progressive.Continue to continue the progress until the progress is finished.

◆ ConvertFromDWG()

def fsdk.ConvertFromDWG ( )

Convert a DWG format file to a PDF file.

Currently, this function can only be used for desktop platforms; for other platform, this function will return false directly without doing anything.

Parameters
[in]engine_pathThe directory path of "DWG to PDF" engine. This should not be an empty string.
[in]src_dwg_pathA DWG or DXF format file path. This should not be an empty string.
[in]saved_pdf_pathA path for saving the converted PDF file. This should not be an empty string.
[in]settingsThe DWG2PDFSettingData object used for converting.
Returns
None.

◆ ConvertFromExcel()

def fsdk.ConvertFromExcel ( )

Convert an Excel format file to a PDF file.

Currently, this function can be used for Linux armv8 or Linux desktop system. If you are on a Linux armv8 system, then please ensure that WPS professional is installed on the machine. If you are on a Linux desktop system, then please ensure that LibreOffice is installed on the machine.

Parameters
[in]src_excel_file_pathPath of a Excel format file. This should not be an empty string.
[in]src_file_passwordPassword for the input Excel format file. If no password is needed for the file, please pass an empty string.
[in]saved_pdf_pathPath of the saved PDF file as conversion result. This should not be an empty string.
[in]engine_pathIn linux armv8 system, it is used to represent the path of WPS engine(librpcetapi.so). For examples, "/opt/kingsoft /wps-office/office6". It can be empty. Default path: "/opt/kingsoft/wps-office/office6". In linux desktop system, it is used to represent the path of LibreOffice engine(soffice.bin), and it can not be empty. For examples, "/usr/lib/libreoffice/program".
[in]setting_data(Reserved, unsupported yet)Setting data used for converting.
[in]fx_engine_pathThe path of "Office to PDF" engine. This parameter is applicable only to Linux desktop systems. It can be empty. If the parameter is empty, LibreOffice engine will be called directly for Excel to PDF conversion, otherwise LibreOffice engine will be called through the "Office to PDF" engine for Excel to PDF conversion.
[in]specified_user_profile_pathThe User-defined directory path to store the user profile of the LibreOffice engine. It needs to be used with "Office to PDF" engine. It can be empty. If the parameter is empty, the LibreOffice engine will use the default user profile and does not suppot multi-threading, otherwise LibreOffice engine will create a new user profile in the User-defined directory to support multi-threading.
Returns
None.

◆ ConvertFromHTML()

def fsdk.ConvertFromHTML ( )

Convert a HTML format file or a URL of a Web page to a PDF file.

Currently, this function can only be used for desktop platforms; for other platform, this function will return directly without doing anything.

Parameters
[in]src_htmlA URL of Web page or a HTML format file path. This should not be an empty string.
[in]engine_pathThe directory path of "HTML to PDF" engine. This should not be an empty string.
[in]cookies_pathPath of cookies file. If this is an empty string, that means no cookie file is used. Data format is strongly recommended to use JSON format.
[in]setting_dataSetting data used for converting.
[in]saved_pdf_pathA path for saving the converted PDF file. This should not be an empty string.
[in]timeoutSeconds for timeout used for loading web pages. It should be set to a value greater than 15. If this is less than 15, 15 will be used by default.
Returns
None.

Currently, this function can only be used for desktop platforms; for other platform, this function will return directly without doing anything.

Parameters
[in]src_htmlA URL of Web page or a HTML format file path. This should not be an empty string.
[in]engine_pathThe directory path of "HTML to PDF" engine. This should not be an empty string.
[in]cookies_readerA fsdk.FileReaderCallback object which is implemented by user to pass cookies data to Foxit PDF SDK. If this is null, that means no cookie data is used. Data format is strongly recommended to use JSON format.
[in]setting_dataSetting data used for converting.
[in]saved_pdf_pathA path for saving the converted PDF file. This should not be an empty string.
[in]timeoutSeconds for timeout used for loading web pages. It should be set to a value greater than 15. If this is less than 15, 15 will be used by default.
Returns
None.

Currently, this function can only be used for desktop platforms; for other platform, this function will return directly without doing anything.

Parameters
[in]src_htmlA URL of Web page or a HTML format file path. This should not be an empty string.
[in]engine_pathThe directory path of "HTML to PDF" engine. This should not be an empty string.
[in]cookies_readerA fsdk.FileReaderCallback object which is implemented by user to pass cookies data to Foxit PDF SDK. If this is null, that means no cookie data is used. Data format is strongly recommended to use JSON format.
[in]setting_dataSetting data used for converting.
[in]saved_pdf_filestreamA fsdk.FileWriterCallback object for saving the converted PDF file. This should not be null.
[in]timeoutSeconds for timeout used for loading web pages. It should be set to a value greater than 15. If this is less than 15, 15 will be used by default.
Returns
None.

Currently, this function can only be used for desktop platforms and mac arm platforms; for other platform, this function will return directly without doing anything.

Parameters
[in]src_htmlA fsdk.FileReaderCallback object which is implemented by user to pass html data to Foxit PDF SDK. It must be vaild.
[in]html2pdf_related_resource_arrayThe HTML2PDFRelatedResourceArray which is related to source HTML.
[in]engine_pathThe directory path of "HTML to PDF" engine. This should not be an empty string.
[in]cookies_reader(Reserved;Not supported yet)A fsdk.FileReaderCallback object which is implemented by user to pass cookies data to Foxit PDF SDK. If this is null, that means no cookie data is used. Data format is strongly recommended to use JSON format.
[in]setting_dataSetting data used for converting.
[in]saved_pdf_filestreamA fsdk.FileWriterCallback object for saving the converted PDF file. This should not be null.
[in]timeoutSeconds for timeout used for loading web pages. It should be set to a value greater than 15. If this is less than 15, 15 will be used by default.
Returns
None.

◆ ConvertFromImage()

def fsdk.ConvertFromImage ( )

Convert a Image format file to a PDF file.

Parameters
[in]src_imgA image format file path. This should not be an empty string.
[in]saved_pdf_pathA path for saving the converted PDF file. This should not be an empty string.
Returns
None.
Parameters
[in]file_readerA fsdk.FileReaderCallback object which is implemented by user to pass image data to Foxit PDF SDK. It must be valid.
[in]saved_pdf_filestreamA fsdk.FileWriterCallback object for saving the converted PDF file. This should not be null.
Returns
None.

◆ ConvertFromOFD()

def fsdk.ConvertFromOFD ( )

Convert OFD file to PDF file.

Please ensure fsdk.LibraryInitializeOFDEngine has been called successfully before using this function.

Parameters
[in]src_ofd_pathA full path of an existing OFD file. It should not be an empty string.
[in]passwordPassword for the OFD file. It should be an empty string if the OFD file is not encrypted.
[in]saved_pdf_file_pathA full path for the converted PDF file. It should not be an empty string.
[in]convert_paramA convert parameter object.
Returns
true means success, while false means failure.

◆ ConvertFromPowerPoint()

def fsdk.ConvertFromPowerPoint ( )

Convert a PowerPoint format file to a PDF file.

Currently, this function can be used for Linux armv8 or Linux desktop system. If you are on a Linux armv8 system, then please ensure that WPS professional is installed on the machine. If you are on a Linux desktop system, then please ensure that LibreOffice is installed on the machine.

Parameters
[in]src_ppt_file_pathPath of a PowerPoint format file. This should not be an empty string.
[in]src_file_passwordPassword for the input Excel format file. If no password is needed for the file, please pass an empty string.
[in]saved_pdf_pathPath of the saved PDF file as conversion result. This should not be an empty string.
[in]engine_pathIn linux armv8 system, it is used to represent the path of WPS engine(librpcwppapi.so). For examples, "/opt/kingsoft/wps-office/office6". It can be empty. Default path: "/opt/kingsoft/wps-office/office6". In linux desktop system, it is used to represent the path of LibreOffice engine(soffice.bin), and it can not be empty. For examples, "/usr/lib/libreoffice/program".
[in]setting_data(Reserved, unsupported yet)Setting data used for converting.
[in]fx_engine_pathThe path of "Office to PDF" engine. This parameter is applicable only to Linux desktop systems. It can be empty. If the parameter is empty, LibreOffice engine will be called directly for PowerPoint to PDF conversion, otherwise LibreOffice engine will be called through the "Office to PDF" engine for PowerPoint to PDF conversion.
[in]specified_user_profile_pathThe User-defined directory path to store the user profile of the LibreOffice engine. It needs to be used with "Office to PDF" engine. It can be empty. If the parameter is empty, the LibreOffice engine will use the default user profile and does not suppot multi-threading, otherwise LibreOffice engine will create a new user profile in the User-defined directory to support multi-threading.
Returns
None.

◆ ConvertFromTXT()

def fsdk.ConvertFromTXT ( )

Convert a TXT format file to a PDF file.

Parameters
[in]src_txtA TXT format file path. This should not be an empty string.
[in]saved_pdf_pathA path for saving the converted PDF file. This should not be an empty string.
[in]setting_dataSetting data used for converting.
Returns
None.

◆ ConvertFromWord()

def fsdk.ConvertFromWord ( )

Convert a Word format file to a PDF file.

Currently, this function can be used for Linux armv8 or Linux desktop system. If you are on a Linux armv8 system, then please ensure that WPS professional is installed on the machine. If you are on a Linux desktop system, then please ensure that LibreOffice is installed on the machine.

Parameters
[in]src_word_file_pathPath of a Word format file. This should not be an empty string.
[in]src_file_passwordPassword for the input Word format file. If no password is needed for the file, please pass an empty string.
[in]saved_pdf_pathPath of the saved PDF file as conversion result. This should not be an empty string.
[in]engine_pathIn linux armv8 system, it is used to represent the path of WPS engine(librpcwpsapi.so). For examples, "/opt/kingsoft/wps-office/office6". It can be empty. Default path: "/opt/kingsoft/wps-office/office6". In linux desktop system, it is used to represent the path of LibreOffice engine(soffice.bin), and it can not be empty. For examples, "/usr/lib/libreoffice/program".
[in]setting_data(Reserved, unsupported yet)Setting data used for converting.
[in]fx_engine_pathThe path of "Office to PDF" engine. This parameter is applicable only to Linux desktop systems. It can be empty. If the parameter is empty, LibreOffice engine will be called directly for Word to PDF conversion, otherwise LibreOffice engine will be called through the "Office to PDF" engine for Word to PDF conversion.
[in]specified_user_profile_pathThe User-defined directory path to store the user profile of the LibreOffice engine. It needs to be used with "Office to PDF" engine. It can be empty. If the parameter is empty, the LibreOffice engine will use the default user profile and does not suppot multi-threading, otherwise LibreOffice engine will create a new user profile in the User-defined directory to support multi-threading.
Returns
None.

◆ ConvertToOFD()

def fsdk.ConvertToOFD ( )

Convert PDF file to OFD file.

Please ensure fsdk.LibraryInitializeOFDEngine has been called successfully before using this function.

Parameters
[in]src_pdf_pathA full path of an existing PDF file. It should not be an empty string.
[in]passwordPassword for the PDF file. It should be an empty string if the PDF file is not encrypted.
[in]saved_ofd_file_pathA full path for the converted OFD file. It should not be an empty string.
[in]convert_paramA convert parameter object.
Returns
true means success, while false means failure.

◆ ConvertToXML()

def fsdk.ConvertToXML ( )

Convert a PDF file to a XML format file.

Parameters
[in]src_pdf_pathPath of a PDF file. This should not be an empty string.
[in]src_file_passwordPassword for the input PDF file. If no password is needed for the file, please pass an empty string.
[in]saved_xml_pathPath of the saved XML format file as conversion result. This should not be an empty string.
[in]saved_image_folder_pathA path to specify a folder where image files will be generated during the converting. If this is an empty string, image files will be generated to a folder named "images" (if not exist, Foxit PDF SDK will generate such folder by default). Folder "images" would be in the same directory with saved XML format file (as parameter saved_xml_path).
[in]is_force_to_tagged_pdf(Only useful when input PDF file is not a tagged PDF file) A boolean value to decide whether input PDF file is allowed to be converted to a tagged PDF when input PDF file is not a tagged PDF:
  • true means input PDF file (which is not tagged PDF yet) will first be converted to a tagged PDF. Then the tagged PDF will be converted to a XML format file.

  • false means not allow to convert input PDF file (which is not tagged PDF yet) to a tagged PDF. In this case, input PDF file will not be converted to XML format file and this function will return false.

Returns
true means success, while false means failure.

◆ DateTimeGetLocalTime()

def fsdk.DateTimeGetLocalTime ( )

Get local time.

Returns
Local time.

◆ DateTimeGetUTCTime()

def fsdk.DateTimeGetUTCTime ( )

Get UTC time.

Returns
UTC time.

◆ DestinationCreateFitBBox()

def fsdk.DestinationCreateFitBBox ( )

Create a destination object for zoom mode fsdk.DestinationE_ZoomFitBBox .

Parameters
[in]documentA valid PDF document object.
[in]page_indexThe index of the destination page in the PDF document.
Returns
A new destination object.

◆ DestinationCreateFitBHorz()

def fsdk.DestinationCreateFitBHorz ( )

Create a destination object for zoom mode fsdk.DestinationE_ZoomFitBHorz .

Parameters
[in]documentA valid PDF document object.
[in]page_indexThe index of the destination page in the PDF document.
[in]topThe vertical coordinate of top edge
Returns
A new destination object.

◆ DestinationCreateFitBVert()

def fsdk.DestinationCreateFitBVert ( )

Create a destination object for zoom mode fsdk.DestinationE_ZoomFitBVert .

Parameters
[in]documentA valid PDF document object.
[in]page_indexThe index of the destination page in the PDF document.
[in]leftHorizontal coordinate of left edge.
Returns
A new destination object.

◆ DestinationCreateFitHorz()

def fsdk.DestinationCreateFitHorz ( )

Create a destination object for zoom mode fsdk.DestinationE_ZoomFitHorz .

Parameters
[in]documentA valid PDF document object.
[in]page_indexThe index of the destination page in the PDF document.
[in]topVertical coordinate of top edge.
Returns
A new destination object.

◆ DestinationCreateFitPage()

def fsdk.DestinationCreateFitPage ( )

Create a destination object for zoom mode fsdk.DestinationE_ZoomFitPage .

Parameters
[in]documentA valid PDF document object.
[in]page_indexThe index of the destination page in the PDF document.
Returns
A new destination object.

◆ DestinationCreateFitRect()

def fsdk.DestinationCreateFitRect ( )

Create a destination object for zoom mode fsdk.DestinationE_ZoomFitRect .

Parameters
[in]documentA valid PDF document object.
[in]page_indexThe index of the destination page in the PDF document.
[in]leftThe coordinate left of a rectangle.
[in]bottomThe coordinate bottom of a rectangle.
[in]rightThe coordinate right of a rectangle.
[in]topThe coordinate top of a rectangle.
Returns
A new destination object.

◆ DestinationCreateFitVert()

def fsdk.DestinationCreateFitVert ( )

Create a destination object for zoom mode fsdk.DestinationE_ZoomFitVert .

Parameters
[in]documentA valid PDF document object.
[in]page_indexThe index of the destination page in the PDF document.
[in]leftHorizontal coordinate of left edge.
Returns
A new destination object.

◆ DestinationCreateFromPDFArray()

def fsdk.DestinationCreateFromPDFArray ( )

Create a destination object from an existing destination array.

Parameters
[in]documentA valid PDF document object.
[in]pdf_arrayA destination PDF array. This PDF array can be retrieved from a fsdk.PDFNameTree in type fsdk.PDFNameTreeE_Dests .
Returns
A new destination object.

◆ DestinationCreateXYZ()

def fsdk.DestinationCreateXYZ ( )

Create a destination object for zoom mode fsdk.DestinationE_ZoomXYZ .

Parameters
[in]documentA valid PDF document object.
[in]page_indexThe index of the destination page in the PDF document.
[in]leftHorizontal coordinate value of a position as page's left-top position.
[in]topVertical coordinate value of a position as page's left-top position.
[in]zoom_factorZoom factor value.
Returns
A new destination object.

◆ FormCombinationCombineFormsToCSV()

def fsdk.FormCombinationCombineFormsToCSV ( )

Combine form data and export these data to a CSV file.

Parameters
[in]form_file_arrayA form file information array. This array contains information of source form files whose form data are to be combined.
[in]dest_csv_fileA full path of a CSV file, to which combined result will be saved to. This should not be an empty string.
[in]appendA boolean value used to decide whether combined form data is appended to the CSV file if the CSV file exists: true means to append combined form data to an existed CSV file, while false means not.
Returns
None.

◆ FormXObjectCreate()

def fsdk.FormXObjectCreate ( )

Create a new form XObject graphics object.

The newly created form XObject graphics object does not have any data yet. Then, setting functions can be called to set data to the new form XObject graphics object. If the newly created form XObject will not inserted to any page or other objects, please remember to call function fsdk.GraphicsObject.Release to release it when no use.

Parameters
[in]documentA valid PDF document object. The new form XObject graphics object should be inserted to one page of this PDF document then.
Returns
A new form XObject. If there is any error, this function will return null.

◆ ImageObjectCreate()

def fsdk.ImageObjectCreate ( )

Create a new image graphics object.

The newly created image graphics object does not have any data yet. Then, setting functions can be called to set data to the new image graphics object. If the newly created image graphics object will not inserted to any page or other objects, please remember to call function fsdk.GraphicsObject.Release to release it when no use.

Parameters
[in]documentA valid PDF document object. The new image graphics object should be inserted to one page of this PDF document then.
Returns
A new image object. If there is any error, this function will return null.

◆ ImageObjectCreateFromType3TextObject()

def fsdk.ImageObjectCreateFromType3TextObject ( )

Create an image graphics object from a type3 text object.

If the newly created image graphics object will not inserted to any page or other objects, please remember to call function fsdk.GraphicsObject.Release to release it when no use.

Parameters
[in]pageA valid PDF page object.
[in]text_objA valid text object. This text object should be a type3 text object.
Returns
A new image object. If there is any error, this function will return null.

◆ LibraryEnableJavaScript()

def fsdk.LibraryEnableJavaScript ( )

Enable or disable javascript for PDF.

Javascript for PDF is enabled by default.

Parameters
[in]enable_javascripttrue means to enable javascript, and false means to disable javascript. If this function is not called, javascript for PDF is enabled by default.
Returns
true means success, while false means failure.

◆ LibraryEnableThreadSafety()

def fsdk.LibraryEnableThreadSafety ( )

Enable thread safety.

From Foxit PDF SDK 11.0, document level thread safety is enabled by default except Javascript and xfa module without calling this function. This function will be deprecated in future version. And users need to ensure that one pdf document is only operated by one thread at a time. If users want to enable thread safety for javascript and xfa module, please pass the true to the enable_js_xfa_threadsafety during calling function fsdk.LibraryInitialize .

Currently, module "OCR" does not support thread safety.

Parameters
[in]is_enable_thread_safetyEnable thread safety.true means to enable thread safety, while false means to disable thread safety.
Returns
None.

◆ LibraryExecuteJavaScript()

def fsdk.LibraryExecuteJavaScript ( )

Execute javascript.

Parameters
Thejavascript which needs to be executed.
Returns
The result error information, such as syntax error warning, unsupported warning, and other error messages.

◆ LibraryFlushLog()

def fsdk.LibraryFlushLog ( )

Flush the log file.

Returns
Error code.

◆ LibraryGetRenderConfig()

def fsdk.LibraryGetRenderConfig ( )

Get the rendering configuration.

Returns
A rendering configuration object which shows current configuration.

◆ LibraryGetVersion()

def fsdk.LibraryGetVersion ( )

Get the version of current Foxit PDF SDK library.

Returns
Version string.

◆ LibraryHasModuleLicenseRight()

def fsdk.LibraryHasModuleLicenseRight ( )

Check if user has right to use a specified module of Foxit PDF SDK in current used license information (which is used to initialize Foxit PDF SDK).

In Foxit PDF SDK, once the library is initialized successfully, most feature can be used. But for some special features, they can be used only when specified modules are defined in license information. This function can be used to check if user has right for these special modules before using these feature.

Parameters
[in]module_nameName of the module whose right is to be checked. Please refer to values starting from fsdk.E_ModuleNameConnectedPDF and this should be one of these values.
Returns
true means user has right to use the specified module, while false means user does not have right to use the specified module.

◆ LibraryInitialize()

def fsdk.LibraryInitialize ( )

Initialize Foxit PDF SDK Library, with valid license information.

During the life-cycle of an application, this function can only be called once and should be called first before any other functions in Foxit PDF SDK can be called.
Once function fsdk.LibraryRelease is called, Foxit PDF SDK library cannot be initialized any more in the life-cycle of the application.

Parameters
[in]snString of sn information, which can be retrieved from "SN=" part in key file "gsdk_sn.txt" or "rdk_sn.txt".
[in]keyString of key information, which can be retrieved from "Sign=" part in key file "gsdk_key.txt" or "rdk_key.txt".
Returns
fsdk.E_ErrSuccess means success.
fsdk.E_ErrInvalidLicense means input license information is invalid.
fsdk.E_ErrParam means parameter sn or key is an empty string.
For more information about error code values, please refer to values starting from fsdk.E_ErrSuccess .

During the life-cycle of an application, this function can only be called once and should be called first before any other functions in Foxit PDF SDK can be called.
Once function fsdk.LibraryRelease is called, Foxit PDF SDK library cannot be initialized any more in the life-cycle of the application.

Parameters
[in]snString of sn information, which can be retrieved from "SN=" part in key file "gsdk_sn.txt" or "rdk_sn.txt".
[in]keyString of key information, which can be retrieved from "Sign=" part in key file "gsdk_key.txt" or "rdk_key.txt".
[in]is_optimize_memoryThe flag is used to attempt to optimize memory by cleaning up memory fragments. true means to clean up memory fragments, and false means not.
[in]enable_js_xfa_threadsafetyThe flag is used to enable javascript and XFA module threadsafety. true means to enable, and false means not. Default value is false. Users need to ensure that one pdf document is only operated by one thread at a time.
Returns
fsdk.E_ErrSuccess means success.
fsdk.E_ErrInvalidLicense means input license information is invalid.
fsdk.E_ErrParam means parameter sn or key is an empty string.
For more information about error code values, please refer to values starting from fsdk.E_ErrSuccess .

◆ LibraryInitializeOFDEngine()

def fsdk.LibraryInitializeOFDEngine ( )

Initialize OFD engine.

This function must be called before using any other functions in "OFD" module. Before using "OFD" module, please ensure the resource folders named "lib" in the OFD package is valid. Before initializing OFD engine and using any classes or methods in this module, please ensure Foxti PDF SDK has been initialized successfully by function fsdk.LibraryInitialize with a key including "OFD" module.
Currently, "OFD" module only supports Windows and Linux64 system.

Parameters
[in]ofd_library_pathPath of OFD library. This should not be an empty string.
Returns
fsdk.E_ErrSuccess means success.
For more information about error code values, please refer to values starting from fsdk.E_ErrSuccess .

◆ LibraryRegisterSecurityCallback()

def fsdk.LibraryRegisterSecurityCallback ( )

Register a fsdk.SecurityCallback object to Foxit PDF SDK for decryption of the PDFs with special encryption filters.

When this function is successful, Foxit PDF SDK will take over the input security callback object and user should not release this callback object directly anymore; otherwise unexpected crash may occurs later.
Foxit PDF SDK may release the security callback object by callback function fsdk.SecurityCallback.Release , when unregister it and find that it has not been used by other object. So, user is recommended not to use the security callback object any more after function fsdk.LibraryUnregisterSecurityCallback .

Parameters
[in]filterThe filter name of the security callback object. This should not be null or an empty string.
When users implement security callback of fsdk.CustomSecurityCallback , users could specified their own custom filter string, but need to follow the PDF name conventions.
When users implement security callback of fsdk.CertificateSecurityCallback , the filter value must be set to "Adobe.PubSec".
When users implement security callback of fsdk.DRMSecurityCallback , the filter value must be set to "FoxitDRM", or some error may occur later.
When users implement security callback of fsdk.RMSSecurityCallback , the filter value must be set to "MicrosoftIRMServices" or "FoxitRMS", or some error may occur later.
[in]callbackA fsdk.SecurityCallback object, which is implemented by user and based on callback class fsdk.SecurityCallback . User should not inherit fsdk.SecurityCallback directly, but inherit its derived class, such as fsdk.CustomSecurityCallback , fsdk.CertificateSecurityCallback , etc.
Returns
true means success, while false means failure.
Note
If module "RMS" is not defined in the license information which is used in function fsdk.LibraryInitialize , that means user has no right in using RMS related functions and this function will throw exception fsdk.E_ErrNoRMSModuleRight .

◆ LibraryRegisterSignatureCallback()

def fsdk.LibraryRegisterSignatureCallback ( )

Register a third-party fsdk.SignatureCallback object to Foxit PDF SDK for signing and verifying signature, along with the filter and sub filter name of the callback.

Foxit PDF SDK has default signature callbacks defined with filter and sub filter:

  • filter: "Adobe.PPKLite" and sub filter: "adbe.pkcs7.detached"

  • filter: "Adobe.PPKLite" and sub filter: "adbe.pkcs7.sha1"

  • filter: "Adobe.PPKLite" and sub filter: "ETSI.CAdES.detached"

  • filter: "Adobe.PPKLite" and sub filter: "ETSI.RFC3161"

If user wants to use a third-party signature callback, please call this function before signing or verifying signature process.
If user register a customized signature callback with the same filter and sub filter as default ones by this function, and the value of parameter is not null, the default signature callback in Foxit PDF SDK will not have effect. If user register a customized signature callback with the same filter and sub filter as default ones by this function, and the value of parameter is null,

the default signature callback in Foxit PDF SDK will have effect again.

Parameters
[in]filterThe filter name of the signature callback, in ASCII encoding. This should not be an empty string. Filter name is the name of the signature callback.
[in]sub_filterThe sub filter name of the signature callback, in ASCII encoding. Sub filter is to describe the encoding of signature value and key information in the signature dictionary.
[in]signature_callbackA customized fsdk.SignatureCallback object, which is implemented by user and based on callback class fsdk.SignatureCallback . User should ensure all the callback functions have been implemented in application level and should also ensure this signature callback object valid until Foxit PDF SDK is released by function fsdk.LibraryRelease .
If this is null, that means the registered third-party callback is to be removed from Foxit PDF SDK.
Returns
true means success, while false means failure.

◆ LibraryRegisterXFAAppProviderCallback()

def fsdk.LibraryRegisterXFAAppProviderCallback ( )

Register an fsdk.AppProviderCallback object to Foxit PDF SDK.

This function should be called first before processing XFA document.

Parameters
[in]callbackAn fsdk.AppProviderCallback object, which is implemented by user and based on callback class fsdk.AppProviderCallback . User should ensure all the callback functions have been implemented in application level and should also ensure this XFA application provider callback object valid until Foxit PDF SDK is released by function fsdk.LibraryRelease .
Returns
None.
Note
If module "XFA" is not defined in the license information which is used in function fsdk.LibraryInitialize , that means user has no right in using XFA related functions and this function will throw exception fsdk.E_ErrNoXFAModuleRight .

◆ LibraryReinitialize()

def fsdk.LibraryReinitialize ( )

Re-initialize Foxit PDF SDK Library.

When user meets out-of-memory error or user wants to re-initialize Foxit PDF SDK library before function fsdk.LibraryRelease is called, user can call this function to re-initialize Foxit PDF SDK Library.
Once function fsdk.LibraryRelease is called, Foxit PDF SDK library cannot be initialized any more in the life-cycle of the application.

Returns
fsdk.E_ErrSuccess means success. For more information about error code values, please refer to values starting from fsdk.E_ErrSuccess .

◆ LibraryRelease()

def fsdk.LibraryRelease ( )

Release all resource allocated by Foxit PDF SDK Library.

User should call this function to release all memory blocks allocated by the library.
Once this fucntion is called, Foxit PDF SDK library cannot be initialized any more in the life-cycle of the application.

Returns
None.

◆ LibraryReleaseOFDEngine()

def fsdk.LibraryReleaseOFDEngine ( )

Release OFD engine.

This function can be called to release OFD engine when no need to use it any more before Foxit PDF SDK is released.

Returns
None.

◆ LibrarySetActionCallback()

def fsdk.LibrarySetActionCallback ( )

Set a fsdk.ActionCallback object to Foxit PDF SDK, in aid of performing PDF actions.

User should implement an action callback object and call this function to set the action callback object to Foxit PDF SDK if PDF actions need to be performed, such as filling a PDF form.

Parameters
[in]action_callbackA customized fsdk.ActionCallback object. null means not use any action callback object. User should ensure all the callback functions have been implemented in application level. If this is a valid action callback object, Foxit PDF SDK will take over the management of this callback object and user should not release it directly.
Returns
true means success, while false means failure.

◆ LibrarySetAnnotIconProviderCallback()

def fsdk.LibrarySetAnnotIconProviderCallback ( )

Set a customized fsdk.IconProviderCallback object to Foxit PDF SDK.

User can call this function to set a customized icon provider for annotation. If this function has been called several times, Foxit PDF SDK will only keep the last icon provider. If this function has not been called even once, Foxit PDF SDK will use the default standard icon provider.

Parameters
[in]annot_icon_providerA customized annotation icon provider, which is implemented based on callback class fsdk.IconProviderCallback . If this is null, customized annotation icon provider will be removed from Foxit PDF SDK and default standard icon provider will be used instead. Application should ensure this icon provider object valid until it has been removed from Foxit PDF SDK or function fsdk.LibraryRelease is called.
Returns
true means success, while false means failure.
Note
Icon provider's ID and version are treated as the name of the icon provider, so please offer different "ID + version" for different icon providers by callback functions fsdk.IconProviderCallback.GetProviderID and fsdk.IconProviderCallback.GetProviderVersion .

◆ LibrarySetCacheSize()

def fsdk.LibrarySetCacheSize ( )

Set the upper limit of PDF library cache size.

If no cache size limit is set by application, the cache size will be set to 200 MegaBytes internally by default.

Parameters
[in]sizeThe upper limit of the cache, in MegaBytes, 0~4096. If set to 0, that means not to use limit of cache size.
Returns
true means success, while false means failure.

◆ LibrarySetDefaultICCProfilesPath()

def fsdk.LibrarySetDefaultICCProfilesPath ( )

Set path of folder which contains default ICC profile files.

Default ICC profile files are offered in "res" folder Foxit PDF SDK package. Default ICC profile files are "sRGB Color Space Profile.icm", "sGray.icc", and "USWebCoatedSWOP.icc". Foxit PDF SDK will load these default ICC profile files from input folder path.
If input folder path does not exist or default ICC profile files are not all in the specified folder, this function will throw fsdk.E_ErrFilePathNotExist .

Parameters
[in]icc_profile_folder_pathA valid path of a folder which contains default ICC profile files.
Returns
None.

◆ LibrarySetDocEventCallback()

def fsdk.LibrarySetDocEventCallback ( )

Set a DocEventCallback object to Foxit PDF SDK.

Parameters
[in]callbackA DocEventCallback object. null means not use any document event callback object.
Returns
true means success, while false means failure.

◆ LibrarySetFontMapperCallback()

def fsdk.LibrarySetFontMapperCallback ( )

Set a FontMapperCallback object to Foxit PDF SDK.

Once a valid custom font mapper callback is set to Foxit PDF SDK, Foxit PDF SDK will first use this callback when mapping a font.

Parameters
[in]callbackA FontMapperCallback object. null means not use any custom font mapper callback object.
Returns
true means success, while false means failure.

◆ LibrarySetLogFile()

def fsdk.LibrarySetLogFile ( )

Set the log file path.

Set the log file stream.

After a log file path is set to Foxit PDF SDK, all the logs will be written to the log file. Currently, the log information in Foxit PDF SDK is simple; this will be improved in future version.

Parameters
[in]log_file_pathA log file path.
Returns
None.

After a log file is set to Foxit PDF SDK, all the logs will be written to the log file stream. Currently, the log information in Foxit PDF SDK is simple; this will be improved in future version.

Parameters
[in]log_fileA log file stream.
Returns
None.

◆ LibrarySetNotifierCallback()

def fsdk.LibrarySetNotifierCallback ( )

Set a NotifierCallback object to Foxit PDF SDK.

User can call this function to set a notifier callback object to Foxit PDF SDK, so that when events (such as OOM) happens, user would be notified.

Parameters
[in]notifierA NotifierCallback object. User should ensure all the callback functions have been implemented in application level.
Returns
true means success, while false means failure.

◆ LibrarySetRenderConfig()

def fsdk.LibrarySetRenderConfig ( )

Set the rendering configuration.

Parameters
[in]render_configA rendering configuration object to be set.
Returns
None.

◆ LibrarySetRenderTextGamma()

def fsdk.LibrarySetRenderTextGamma ( )

Set gamma value for text rendering.

If this function is not called to set gamma value, Foxit PDF SDK will use 2.2 as the default value.

Parameters
[in]gammaGamma value. It should be greater than 0.
Returns
None.

◆ LibrarySetTimeStampCallback()

def fsdk.LibrarySetTimeStampCallback ( )

Set a fsdk.TimeStampCallback object to Foxit PDF SDK, in aid of interacting with time stamp server.

When this function is successful, Foxit PDF SDK will take over the default time stamp interaction during signing and user should not release this callback object directly anymore; otherwise unexpected crash may occurs later.
Foxit PDF SDK may release the time stamp callback object by callback function fsdk.TimeStampCallback.Release , when timestamp_callback is null.

Parameters
[in]timestamp_callbackA customized fsdk.TimeStampCallback object, which is implemented by user and based on callback class fsdk.TimeStampCallback . User should ensure all the callback functions have been implemented in application level and should also ensure this time stamp callback object valid until Foxit PDF SDK is released by function fsdk.LibraryRelease .
If this is null, that means the registered third-party callback is to be removed from Foxit PDF SDK.
Returns
true means success, while false means failure.

◆ LibraryUnregisterSecurityCallback()

def fsdk.LibraryUnregisterSecurityCallback ( )

Unregister a fsdk.SecurityCallback object from Foxit PDF SDK.

Foxit PDF SDK may release the security callback function by callback function fsdk.SecurityCallback.Release , when unregister it and find that it has not been used by other object. So, user is recommended not to use the security callback object any more after function fsdk.LibraryUnregisterSecurityCallback .

Parameters
[in]filterThe filter name which is used for registering a security callback object. Please refer to comment of parameter filter in function fsdk.LibraryRegisterSecurityCallback .
Returns
true means success, while false means failure.
Note
If module "RMS" is not defined in the license information which is used in function fsdk.LibraryInitialize , that means user has no right in using RMS related functions and this function will throw exception fsdk.E_ErrNoRMSModuleRight .

◆ LibraryUnregisterSignatureCallback()

def fsdk.LibraryUnregisterSignatureCallback ( )

Unregister the third-party fsdk.SignatureCallback object, which is associated with a specific filter and sub-filter, from the Foxit PDF SDK. If a default signature is available, it will be restored together with its filter and sub-filter values.

Foxit PDF SDK has default signature callbacks defined with filter and sub filter:

  • filter: "Adobe.PPKLite" and sub filter: "adbe.pkcs7.detached"

  • filter: "Adobe.PPKLite" and sub filter: "adbe.pkcs7.sha1"

  • filter: "Adobe.PPKLite" and sub filter: "ETSI.CAdES.detached"

  • filter: "Adobe.PPKLite" and sub filter: "ETSI.RFC3161"

Parameters
[in]filterThe filter name of the signature callback, in ASCII encoding. This should not be an empty string. Filter name is the name of the signature callback.
[in]sub_filterThe sub filter name of the signature callback, in ASCII encoding. Sub filter is to describe the encoding of signature value and key information in the signature dictionary.
Returns
None.

◆ LRElementStringifyElementType()

def fsdk.LRElementStringifyElementType ( )

Convert enum value of a specified element type to a short and memorable string (text) representation.

Parameters
[in]typeA specified element type. Please refer to values starting from fsdk.LRElementE_ElementTypeDocument and this should be one of these values.
Returns
A string that represents the short and memorable string representation for specified type. If there is no short and memorable string representation or input type is an invalid enum value, this function would return an empty string.

◆ LRStructureElementIsArrayAttributeValueType()

def fsdk.LRStructureElementIsArrayAttributeValueType ( )

Check whether input attribute value type represents an array.

Parameters
[in]typeAttribute value type. Please refer to values starting from fsdk.LRStructureElementE_AttributeValueTypeEmpty and this should be one of these values.
Returns
true means input type represents an array, while false means input type does not represent an array.

◆ LRStructureElementParseAttributeType()

def fsdk.LRStructureElementParseAttributeType ( )

Parse a string representation for attribute type and retrieve the enum value for this attribute type.

Parameters
[in]type_stringA string representation for a structure element attribute type.
Returns
Enum value for attribute type. Please refer to values starting from fsdk.LRStructureElementE_AttributeTypeInvalid and this would be one of these values.

◆ LRStructureElementStringifyAttributeType()

def fsdk.LRStructureElementStringifyAttributeType ( )

Convert the enum value of a specified attribute type to a short and memorable string (text) representation.

Parameters
[in]typeEnum value of a specified attribute type. Please refer to values starting from fsdk.LRStructureElementE_AttributeTypeInvalid and this should be one of these values.
Returns
A string that represents the short and memorable string representation for specified type. If there is no short and memorable string representation, or input type is fsdk.LRStructureElementE_AttributeTypeInvalid or an invalid enum value, this function would return an empty string.

◆ LRStructureElementStringifyEnumVariant()

def fsdk.LRStructureElementStringifyEnumVariant ( )

Convert the enum value of a specified attribute value enum to a short and memorable string (text) representation.

Parameters
[in]typeEnum value of a specified attribute value enum. Please refer to values starting from fsdk.LRStructureElementE_AttributeValueEnumInvalid and this should be one of these values.
Returns
A string that represents the short and memorable string representation for specified enum. If there is no short and memorable string representation, or input enum value is fsdk.LRStructureElementE_AttributeValueEnumInvalid or an invalid enum value, this function would return an empty string.

◆ Office2PDFConvertFromExcel()

def fsdk.Office2PDFConvertFromExcel ( )

Convert an Excel format file to a PDF file.

Currently,this function is only available for Windows, and it supports conversion only from XLSX format files.

Parameters
[in]src_excel_file_pathPath of an Excel format file. This should not be an empty string.
[in]src_file_password(Reserved,encrypted files are unsupported yet)Password for the input Excel format file. If no password is needed for the file, please pass an empty string.
[in]saved_pdf_pathPath of the saved PDF file as conversion result. This should not be an empty string.
[in]setting_dataA fsdk.Office2PDFSettingData object which is used for converting.
Returns
true means success, while false means failure.

Currently,this function is only available for Windows, and it supports conversion only from XLSX format files. The file is read all at once, rather than progressively.

Parameters
[in]src_excel_readerA FileReaderCallback object which is implemented by user to load an excel document. It should not be null.
[in]src_file_password(Reserved,encrypted files are unsupported yet)Password for the input Excel format file. If no password is needed for the file, please pass an empty string.
[in]saved_pdf_file_streamA fsdk.StreamCallback object which is implemented by user to read the contents of the converted PDF file. It should not be null.
[in]setting_dataA fsdk.Office2PDFSettingData object which is used for converting.
Returns
true means success, while false means failure.

◆ Office2PDFConvertFromPowerPoint()

def fsdk.Office2PDFConvertFromPowerPoint ( )

Convert a PowerPoint format file to a PDF file.

Currently,this function is only available for Windows, and it supports conversion only from PPTX format files.

Parameters
[in]src_ppt_file_pathPath of a PowerPoint format file. This should not be an empty string.
[in]src_file_password(Reserved,encrypted files are unsupported yet)Password for the input PowerPoint format file. If no password is needed for the file, please pass an empty string.
[in]saved_pdf_pathPath of the saved PDF file as conversion result. This should not be an empty string.
[in]setting_dataA fsdk.Office2PDFSettingData object which is used for converting.
Returns
true means success, while false means failure.

Currently,this function is only available for Windows, and it supports conversion only from PPTX format files. The file is read all at once, rather than progressively.

Parameters
[in]src_ppt_readerA FileReaderCallback object which is implemented by user to load a PowerPoint document. It should not be null.
[in]src_file_password(Reserved,encrypted files are unsupported yet)Password for the input PowerPoint format file. If no password is needed for the file, please pass an empty string.
[in]saved_pdf_file_streamA fsdk.StreamCallback object which is implemented by user to read the contents of the converted PDF file. It should not be null.
[in]setting_dataA fsdk.Office2PDFSettingData object which is used for converting.
Returns
true means success, while false means failure.

◆ Office2PDFConvertFromWord()

def fsdk.Office2PDFConvertFromWord ( )

Convert a Word format file to a PDF file.

Currently,this function is only available for Windows, and it supports conversion only from DOCX format files.

Parameters
[in]src_word_file_pathPath of a Word format file. This should not be an empty string.
[in]src_file_password(Reserved,encrypted files are unsupported yet)Password for the input Word format file. If no password is needed for the file, please pass an empty string.
[in]saved_pdf_pathPath of the saved PDF file as conversion result. This should not be an empty string.
[in]setting_dataA fsdk.Office2PDFSettingData object which is used for converting.
Returns
true means success, while false means failure.

Currently,this function is only available for Windows, and it supports conversion only from DOCX format files. The file is read all at once, rather than progressively.

Parameters
[in]src_word_readerA FileReaderCallback object which is implemented by user to load a word document. It should not be null.
[in]src_file_password(Reserved,encrypted files are unsupported yet)Password for the input Word format file. If no password is needed for the file, please pass an empty string.
[in]saved_pdf_file_streamA fsdk.StreamCallback object which is implemented by user to read the contents of the converted PDF file. It should not be null.
[in]setting_dataA fsdk.Office2PDFSettingData object which is used for converting.
Returns
true means success, while false means failure.

◆ Office2PDFInitialize()

def fsdk.Office2PDFInitialize ( )

Initialize Foxit PDF Conversion.

During the life-cycle of "Office2PDF" module, this function can only be called once and should be called first before any other functions in "Office2PDF" module can be called.

Parameters
[in]library_pathPath of Foxit PDF Conversion SDK library. This should not be an empty string.
Returns
None.
Note
If module "Office2PDF" is not defined in the license information which is used in function fsdk.LibraryInitialize , that means user has no right in using Office2PDF related functions and this function will throw exception fsdk.E_ErrNoOffice2PDFModuleRight .

◆ Office2PDFRelease()

def fsdk.Office2PDFRelease ( )

Release all resource allocated by Foxit PDF Conversion.

When the user does not use "Office2PDF" module, this function should be called to release all memory blocks allocated by the library.

Returns
None.

◆ OptimizerComputeAuditSpace()

def fsdk.OptimizerComputeAuditSpace ( )

Compute audit space.

Parameters
[in]docA valid PDF document object to audit space.
Returns
A struct that contain all audit space contents.

◆ OptimizerOptimize()

def fsdk.OptimizerOptimize ( )

Optimize the given PDF document with specified optimizer settings.

Parameters
[in]docA valid PDF document object to be optimized.
[in]settingsSetting data used for optimization processing settings.
[in]pausePause object which decides if the process needs to be paused. This can be null which means not to pause during the optimization process. If this is not null, it should be a valid pause object implemented by user.
Note
If module "Optimizer" is not defined in the license information which is used in function fsdk.LibraryInitialize , that means user has no right in using Optimization related functions and this function will throw exception fsdk.E_ErrNoOptimizerModuleRight .
Returns
A progressive object. Please check the rate of current progress by function fsdk.Progressive.GetRateOfProgress . If the rate is not 100 yet, call function fsdk.Progressive.Continue to continue the progress until the progress is finished.

◆ OptimizerOptimizeScannedPDF()

def fsdk.OptimizerOptimizeScannedPDF ( )

Optimize the scanned PDF document with specified optimizers settings.

Parameters
[in]docA valid PDF document object to be optimized.
[in]settingsSetting data used for optimization processing settings.
[in]image_compress_callbackA fsdk.ImageCompressionCallback object which is implemented by user for temp file data during replacing page process. When replacing pages process is finished (no matter successfully or not), callback function fsdk.ImageCompressionCallback.Release will be called by Foxit PDF SDK.
[in]pausePause object which decides if the process needs to be paused. This can be null which means not to pause during the optimization process. If this is not null, it should be a valid pause object implemented by user.
Note
If module "Optimizer" is not defined in the license information which is used in function fsdk.LibraryInitialize , that means user has no right in using Optimization related functions and this function will throw exception fsdk.E_ErrNoOptimizerModuleRight . If optimize the scanned pdf finished, the specify pages to be optimized needs to be reloaded.
Returns
A progressive object. Please check the rate of current progress by function fsdk.Progressive.GetRateOfProgress . If the rate is not 100 yet, call function fsdk.Progressive.Continue to coninue the progress until the progress is finished.

◆ OptimizerStartSubsetEmbedFont()

def fsdk.OptimizerStartSubsetEmbedFont ( )

Start to make subsets for embedded fonts in the given PDF document.

This function can be used to remove useless embedded characters from the data of embedded fonts (if there's any in a PDF document) in order to reduce the size of a PDF document.

Parameters
[in]docA valid PDF document object to be processed a subset of embedded fonts.
[in]pausePause object which decides if the process needs to be paused. This can be null which means not to pause during the embeded font subset process. If this is not null, it should be a valid pause object implemented by user.
Note
If module "Optimizer" is not defined in the license information which is used in function fsdk.LibraryInitialize , that means user has no right in using Optimization related functions and this function will throw exception fsdk.E_ErrNoOptimizerModuleRight .
Returns
A progressive object. Please check the rate of current progress by function fsdk.Progressive.GetRateOfProgress . If the rate is not 100 yet, call function fsdk.Progressive.Continue to continue the progress until the progress is finished.

◆ PathObjectCreate()

def fsdk.PathObjectCreate ( )

Create a new path graphics object.

The newly created path graphics object does not have any data yet. Then, setting functions can be called to set data to the new path graphics object. If the newly created path graphics object will not inserted to any page or other objects, please remember to call function fsdk.GraphicsObject.Release to release it when no use.

Returns
A new path graphics object. If there is any error, this function will return null.

◆ PathObjectCreateFromTextObject()

def fsdk.PathObjectCreateFromTextObject ( )

Create a path graphics object from a text object.

If the newly created path graphics object will not inserted to any page or other objects, please remember to call function fsdk.GraphicsObject.Release to release it when no use.

Parameters
[in]pageA valid PDF page object.
[in]text_objA text graphics object. It should not be null. Please ensure the text graphics object is in the PDF page specified by parameter page.
Returns
A new path graphics object. If there is any error, this function will return null.

◆ PDF2OfficeInitialize()

def fsdk.PDF2OfficeInitialize ( )

Initialize Foxit PDF Conversion.

During the life-cycle of "PDF2Office" module, this function can only be called once and should be called first before any other functions in "PDF2Office" module can be called.

Parameters
[in]library_pathPath of Foxit PDF Conversion SDK library. This should not be an empty string.
[in]fx_engine_pathPath of Foxit PDF Conversion engine. It can be an empty string. If the parameter is empty, PDF Conversion SDK library will be called directly for PDF to Office conversion, otherwise Foxit PDF Conversion SDK library will be called through the Foxit PDF Conversion engine for PDF to Office conversion.
Returns
None.
Note
If module "PDF2Office" is not defined in the license information which is used in function fsdk.LibraryInitialize , that means user has no right in using PDF2Office related functions and this function will throw exception fsdk.E_ErrNoPDF2OfficeModuleRight .

◆ PDF2OfficeRelease()

def fsdk.PDF2OfficeRelease ( )

Release all resource allocated by Foxit PDF Conversion.

When the user does not use "pdf2office" module, this function should be called to release all memory blocks allocated by the library.

Returns
None.

◆ PDF2OfficeSetConvertCheckCallback()

def fsdk.PDF2OfficeSetConvertCheckCallback ( )

Set the callback object to check the PDF to Office conversion conditions.

This method allows you to specify a custom convert check callback that will be called to evaluate whether the conversion from PDF to Office should proceed, based on user-defined logic , when the required permissions for converting the PDF documents are not met.

Parameters
[in]convert_check_callbackA customized convert check callback which is implemented based on callback class ConvertCheckCallback . If this is null, customized convert check callback will be removed and default convert check will be used instead.
Note
When Foxit PDF Conversion engine is set by function fsdk.PDF2OfficeInitialize , the ConvertCheckCallback will be not work, and it will use the internal ConvertCheckcallbacks to allow conversion.
Returns
true means success, while false means failure.

◆ PDF2OfficeStartConvertToExcel()

def fsdk.PDF2OfficeStartConvertToExcel ( )

Start to convert a PDF file to a Excel format file. Function fsdk.PDF2OfficeInitialize must be called before calling this function.

Currently only support converting to XLSX format file.

Parameters
[in]src_pdf_pathPath of a PDF file. This should not be an empty string.
[in]src_pdf_passwordPassword for the input PDF file. If no password is needed for the file, please pass an empty string.
[in]saved_excel_file_pathPath of the saved Excel format file as conversion result. This should not be an empty string. If the suffix name of the saved Excel format file is not "xlsx", a new suffix named "xlsx" will be added to the original file name.
[in]setting_dataSetting data used for converting.If the parameter page_range of PDF2OfficeSettingData object is empty, that means convert each page of the PDF file to Excel format file.
[in]convert_callbackA fsdk.ConvertCallback object which is implemented by user to pause and notify the conversion progress during the converting process. This can be null which means not to pause and notify the conversion progress. If this is not null, it should be a valid fsdk.ConvertCallback object implemented by user.
Default value: null.
Returns
A progressive object. Please check the rate of current progress by function fsdk.Progressive.GetRateOfProgress . If the rate is not 100 yet, call function fsdk.Progressive.Continue to continue the progress until the progress is finished.
Note
When Foxit PDF Conversion engine is set by function fsdk.PDF2OfficeInitialize , the ConvertCallback will be not work.

Currently only support converting to XLSX format file.

Parameters
[in]src_pdf_readerA FileReaderCallback object which is implemented by user to load a PDF document. It should not be null.
[in]src_pdf_passwordPassword for the input PDF file. If no password is needed for the file, please pass an empty string.
[in]saved_excel_file_streamA fsdk.StreamCallback object which is implemented by user to read the contents of the converted Excel format file. It should not be null.
[in]setting_dataSetting data used for converting.If the parameter page_range of PDF2OfficeSettingData object is empty, that means convert each page of the PDF file to Excel format file.
[in]convert_callbackA fsdk.ConvertCallback object which is implemented by user to pause and notify the conversion progress during the converting process. This can be null which means not to pause and notify the conversion progress. If this is not null, it should be a valid fsdk.ConvertCallback object implemented by user.
Default value: null.
Returns
A progressive object. Please check the rate of current progress by function fsdk.Progressive.GetRateOfProgress . If the rate is not 100 yet, call function fsdk.Progressive.Continue to continue the progress until the progress is finished.
Note
When Foxit PDF Conversion engine is set by function fsdk.PDF2OfficeInitialize , the ConvertCallback will be not work.

◆ PDF2OfficeStartConvertToPowerPoint()

def fsdk.PDF2OfficeStartConvertToPowerPoint ( )

Start to convert a PDF file to a PowerPoint format file. Function fsdk.PDF2OfficeInitialize must be called before calling this function.

Currently only support converting to PPTX format file.

Parameters
[in]src_pdf_pathPath of a PDF file. This should not be an empty string.
[in]src_pdf_passwordPassword for the input PDF file. If no password is needed for the file, please pass an empty string.
[in]saved_ppt_file_pathPath of the saved PowerPoint format file as conversion result. This should not be an empty string. If the suffix name of the saved PowerPoint format file is not "pptx", a new suffix named "pptx" will be added to the original file name.
[in]setting_dataSetting data used for converting.If the parameter page_range of PDF2OfficeSettingData object is empty, that means convert each page of the PDF file to Power Point format file.
[in]convert_callbackA fsdk.ConvertCallback object which is implemented by user to pause and notify the conversion progress during the converting process. This can be null which means not to pause and notify the conversion progress. If this is not null, it should be a valid fsdk.ConvertCallback object implemented by user.
Default value: null.
Returns
A progressive object. Please check the rate of current progress by function fsdk.Progressive.GetRateOfProgress . If the rate is not 100 yet, call function fsdk.Progressive.Continue to continue the progress until the progress is finished.
Note
When Foxit PDF Conversion engine is set by function fsdk.PDF2OfficeInitialize , the ConvertCallback will be not work.

Currently only support converting to PPTX format file.

Parameters
[in]src_pdf_readerA FileReaderCallback object which is implemented by user to load a PDF document. It should not be null.
[in]src_pdf_passwordPassword for the input PDF file. If no password is needed for the file, please pass an empty string.
[in]saved_ppt_file_streamA fsdk.StreamCallback object which is implemented by user to read the contents of the converted PowerPoint format file. It should not be null.
[in]setting_dataSetting data used for converting.If the parameter page_range of PDF2OfficeSettingData object is empty, that means convert each page of the PDF file to Power Point format file.
[in]convert_callbackA fsdk.ConvertCallback object which is implemented by user to pause and notify the conversion progress during the converting process. This can be null which means not to pause and notify the conversion progress. If this is not null, it should be a valid fsdk.ConvertCallback object implemented by user.
Default value: null.
Returns
A progressive object. Please check the rate of current progress by function fsdk.Progressive.GetRateOfProgress . If the rate is not 100 yet, call function fsdk.Progressive.Continue to continue the progress until the progress is finished.
Note
When Foxit PDF Conversion engine is set by function fsdk.PDF2OfficeInitialize , the ConvertCallback will be not work.

◆ PDF2OfficeStartConvertToWord()

def fsdk.PDF2OfficeStartConvertToWord ( )

Start to convert a PDF file to a Word format file. Function fsdk.PDF2OfficeInitialize must be called before calling this function.

Currently only support converting to DOCX format file.

Parameters
[in]src_pdf_pathPath of a PDF file. This should not be an empty string.
[in]src_pdf_passwordPassword for the input PDF file. If no password is needed for the file, please pass an empty string.
[in]saved_word_file_pathPath of the saved Word format file as conversion result. This should not be an empty string. If the suffix name of the saved Word format file is not "docx", a new suffix named "docx" will be added to the original file name.
[in]setting_dataSetting data used for converting.If the parameter page_range of PDF2OfficeSettingData object is empty, that means convert each page of the PDF file to Word format file.
[in]convert_callbackA fsdk.ConvertCallback object which is implemented by user to pause and notify the conversion progress during the converting process. This can be null which means not to pause and notify the conversion progress. If this is not null, it should be a valid fsdk.ConvertCallback object implemented by user.
Default value: null.
Returns
A progressive object. Please check the rate of current progress by function fsdk.Progressive.GetRateOfProgress . If the rate is not 100 yet, call function fsdk.Progressive.Continue to continue the progress until the progress is finished.
Note
When Foxit PDF Conversion engine is set by function fsdk.PDF2OfficeInitialize , the ConvertCallback will be not work.

Currently only support converting to DOCX format file.

Parameters
[in]src_pdf_readerA FileReaderCallback object which is implemented by user to load a PDF document. It should not be null.
[in]src_pdf_passwordPassword for the input PDF file. If no password is needed for the file, please pass an empty string.
[in]saved_word_file_streamA fsdk.StreamCallback object which is implemented by user to read the contents of the converted Word format file. It should not be null.
[in]setting_dataSetting data used for converting.If the parameter page_range of PDF2OfficeSettingData object is empty, that means convert each page of the PDF file to Word format file.
[in]convert_callbackA fsdk.ConvertCallback object which is implemented by user to pause and notify the conversion progress during the converting process. This can be null which means not to pause and notify the conversion progress. If this is not null, it should be a valid fsdk.ConvertCallback object implemented by user.
Default value: null.
Returns
A progressive object. Please check the rate of current progress by function fsdk.Progressive.GetRateOfProgress . If the rate is not 100 yet, call function fsdk.Progressive.Continue to continue the progress until the progress is finished.
Note
When Foxit PDF Conversion engine is set by function fsdk.PDF2OfficeInitialize , the ConvertCallback will be not work.

◆ PDFArrayCreate()

def fsdk.PDFArrayCreate ( )

Create a new array object.

Please call function fsdk.PDFObject.Release to release the created object if it has not been added/set into PDF document or other PDF object and will not be used any more.

Returns
A new PDFArray object. If there is any error, this function will return null.

◆ PDFArrayCreateFromMatrix()

def fsdk.PDFArrayCreateFromMatrix ( )

Create a new array object for a matrix.

Please call function fsdk.PDFObject.Release to release the created object if it has not been added/set into PDF document or other PDF object and will not be used any more.

Parameters
[in]matrixA matrix.
Returns
A new PDFArray object. If there is any error, this function will return null.

◆ PDFArrayCreateFromRect()

def fsdk.PDFArrayCreateFromRect ( )

Create a new array object for a rectangle.

Please call function fsdk.PDFObject.Release to release the created object if it has not been added/set into PDF document or other PDF object and will not be used any more.

Parameters
[in]rectA rectangle.
Returns
A new PDFArray object. If there is any error, this function will return null.

◆ PDFDictionaryCreate()

def fsdk.PDFDictionaryCreate ( )

Create a new dictionary object.

Please call function fsdk.PDFObject.Release to release the created object if it has not been added/set into PDF document or other PDF object and will not be used any more.

Returns
A new PDFDictionary object. If there is any error, this function will return null.

◆ PDFObjectCreateFromBoolean()

def fsdk.PDFObjectCreateFromBoolean ( )

Create a PDF object from a boolean value.

Please call function fsdk.PDFObject.Release to release the created object if it has not been added/set into PDF document or other PDF object and will not be used any more.

Parameters
[in]boolean_valueA boolean value.
Returns
A new PDFObject object, whose object type is fsdk.PDFObjectE_Boolean . If there is any error, this function will return null.

◆ PDFObjectCreateFromDateTime()

def fsdk.PDFObjectCreateFromDateTime ( )

Create a PDF object from date time.

PDF defines a standard date format, which closely follows that of the international standard ASN.1 (Abstract Syntax Notation One), defined in ISO/ IEC 8824 (see the Bibliography). A date is defined as an ASCII string of the form (D:YYYYMMDDHHmmSSOHH'mm'). Please call function fsdk.PDFObject.Release to release the created object if it has not been added/set into PDF document or other PDF object and will not be used any more.

Parameters
[in]date_timeA date and time object.
Returns
A new PDFObject object, whose object type is fsdk.PDFObjectE_String . If there is any error, this function will return null.

◆ PDFObjectCreateFromFloat()

def fsdk.PDFObjectCreateFromFloat ( )

Create a PDF object from a float number.

Please call function fsdk.PDFObject.Release to release the created object if it has not been added/set into PDF document or other PDF object and will not be used any more.

Parameters
[in]float_valueA float value.
Returns
A new PDFObject object, whose object type is fsdk.PDFObjectE_Number . If there is any error, this function will return null.

◆ PDFObjectCreateFromInteger()

def fsdk.PDFObjectCreateFromInteger ( )

Create a PDF object from a integer number.

Please call function fsdk.PDFObject.Release to release the created object if it has not been added/set into PDF document or other PDF object and will not be used any more.

Parameters
[in]integer_valueAn integer value.
Returns
A new PDFObject object, whose object type is fsdk.PDFObjectE_Number . If there is any error, this function will return null.

◆ PDFObjectCreateFromName()

def fsdk.PDFObjectCreateFromName ( )

Create a PDF object from a string which represents a name.

Please call function fsdk.PDFObject.Release to release the created object if it has not been added/set into PDF document or other PDF object and will not be used any more.

Parameters
[in]nameA string. It should not be an empty string.
Returns
A new PDFObject object, whose object type is fsdk.PDFObjectE_Name . If there is any error, this function will return null.

◆ PDFObjectCreateFromNameW()

def fsdk.PDFObjectCreateFromNameW ( )

Create a PDF object from a string which represents a name.

Parameters
[in]nameA string. It should not be an empty string.
Returns
A new PDFObject object, whose object type is fsdk.PDFObjectE_Name . Please call function fsdk.PDFObject.Release to release the created object if it has not been added/set into PDF document or other PDF object and will not be used any more.

◆ PDFObjectCreateFromString()

def fsdk.PDFObjectCreateFromString ( )

Create a PDF object from string.

Please call function fsdk.PDFObject.Release to release the created object if it has not been added/set into PDF document or other PDF object and will not be used any more.

Parameters
[in]string_valueA string. It should not be an empty string.
Returns
A PDFObject object, whose object type is fsdk.PDFObjectE_String . If there is any error, this function will return null.

Please call function fsdk.PDFObject.Release to release the created object if it has not been added/set into PDF document or other PDF object and will not be used any more.

Parameters
[in]string_valueA string. It should not be an empty string.
[in]lengthThe length of the wide character string. The length should either be a positive value or -1. A value of -1 represents a zero-terminated wide character string.
Returns
A PDFObject object, whose object type is fsdk.PDFObjectE_String . If there is any error, this function will return null.

◆ PDFObjectCreateReference()

def fsdk.PDFObjectCreateReference ( )

Create a reference for an indirect object.

The indirect object can be retrieved by following methods:

Please call function fsdk.PDFObject.Release to release the created object if it has not been added/set into PDF document or other PDF object and will not be used any more.

Parameters
[in]documentA valid PDF document object.
[in]object_numberThe indirect object number of the indirect PDF object. This should be above 0.
Returns
A new PDFObject object, whose object type is fsdk.PDFObjectE_Reference . If there is any error, this function will return null.

◆ PDFStreamCreate()

def fsdk.PDFStreamCreate ( )

Create a new stream object based on a dictionary.

Please call function fsdk.PDFObject.Release to release the created object if it has not been added/set into PDF document or other PDF object and will not be used any more.

Parameters
[in]dictionaryA PDF dictionary object:
  • If this is null, PDF stream object will be created based on an empty PDF dictionary.

  • If this is not null, after creating PDF stream object successfully, do not call fsdk.PDFObject.Release for this PDF dictionary object.

Returns
A new PDFStream object. If there is any error, this function will return null.

◆ PortfolioCreatePortfolio()

def fsdk.PortfolioCreatePortfolio ( )

Create a PDF portfolio with a new and blank PDF document created automatically.

Create a PDF portfolio with an existed portfolio PDF document.

This function will create a new and blank PDF document as a portfolio PDF document automatically. Function fsdk.Portfolio.GetPortfolioPDFDoc can be used to retrieve the related PDF document object. Function fsdk.Portfolio.GetSchemaFields can be used to retrieve default schema fields.

Returns
A PDF portfolio object.

This function is just to create a PDF portfolio object to be associated with an existed portfolio PDF document in order to access portfolio information.

Parameters
[in]portfolio_pdf_docA portfolio PDF document.
Returns
A PDF portfolio object.

◆ SplitPDFDocStartSplitByFileSize()

def fsdk.SplitPDFDocStartSplitByFileSize ( )

Start to split the PDF document into multiple PDF documents.

This function can be used to batch process multiple documents.
The specific information of the PDF documents after splitting will be returned in the callback function fsdk.SplitPDFDocCallback.ResultNotify .

Parameters
[in]max_file_sizeThe maximum file size of the PDF document generated by splitting (unit is Megabytes). If the file size of the PDF document to be split is smaller than the value of this parameter, the PDF document cannot be split and status fsdk.SplitFileResultE_SplitFileErrSizeTooSmall will be returned. The lower limit of this parameter's value is 0.5 Megabytes.
[in]setting_dataSetting data used for splitting.
[in]split_doc_arrayAn array of PDF documents to be split. The size of this array should be greater than 0.
[in]split_callbackA SplitPDFDocCallback object which is implemented by user to pause and notify the splitting progress during the splitting process, as well as to notify the result of the split. This can be null which means not to pause and notify the splitting progress. If this is not null, it should be a valid SplitPDFDocCallback object implemented by user.
Default value: null.
Returns
A progressive object. Please check the rate of current progress by function fsdk.Progressive.GetRateOfProgress . If the rate is not 100 yet, call function fsdk.Progressive.Continue to continue the progress until the progress is finished.

◆ TableGeneratorAddTableToPage()

def fsdk.TableGeneratorAddTableToPage ( )

Add a new table to the PDF page.

Parameters
[in]pageA valid PDF page object.
[in]dataThe object of TableData . Please make sure that the product of TableData::row_count and TableData::col_count in data is the same as the number of cell_array, otherwise an exception will be thrown. Please make sure that the TableData::rect in data is not empty and is in the page box of the current page, otherwise an exception will be thrown.
[in]cell_arrayThis is a two-dimensional array, an array of TableCellDataColArray objects. Exception fsdk.E_ErrUnsupported will be thrown if the text and image are in the same cell.
Returns
true means success, while false means failure.

◆ TableGeneratorInsertTablePagesToDocument()

def fsdk.TableGeneratorInsertTablePagesToDocument ( )

Insert a new table which is contained in one or multi pages into the document.

Parameters
[in]docA valid PDF document object.
[in]dest_page_indexA dest page index in current PDF document. This is used to specify where the new pages will be inserted. If parameter dest_page_index is less than 0, the new pages will be inserted to the first.
If parameter dest_page_index is equal to or larger than current page count, the new pages will be inserted to the end.
[in]page_widthThe new pages width (unit is 1/72 inch).
[in]page_heightThe new pages height (unit is 1/72 inch).
[in]dataThe object of TableData . Please make sure that the product of TableData::row_count and TableData::col_count in data is the same as the number of cell_array, otherwise an exception will be thrown. Please make sure that the TableData::rect in data is not empty and is in the page box of the current page, otherwise an exception will be thrown.
[in]cell_arrayThis is a two-dimensional array, an array of TableCellDataColArray objects. Exception fsdk.E_ErrUnsupported will be thrown if the text and image are in the same cell.
[in]allow_to_cross_pageA boolean value spacifies that whether to allow the table to cross page.true means allow, false means not. Currently, cell merging is not supported if parameter allow_to_cross_page is true.
[in]tablegenerator_callbackThe callback for table generator, which is implemented based on callback class fsdk.TableGeneratorCallback .
Returns
true means success, while false means failure.

◆ TextObjectCreate()

def fsdk.TextObjectCreate ( )

Create a new text graphics object.

The newly created text graphics object does not have any data yet. Then, setting functions can be called to set data to the new text graphics object. If the newly created text graphics object will not inserted to any page or other objects, please remember to call function fsdk.GraphicsObject.Release to release it when no use.

Returns
A new text graphics object. If there is any error, this function will return null.

◆ TimeStampServerMgrAddServer()

def fsdk.TimeStampServerMgrAddServer ( )

Add a time stamp server to the manager.

Parameters
[in]server_nameName of time stamp server. It should not be an empty string.
[in]server_urlURL of time stamp server. It should not be an empty string.
[in]user_nameUser name for the time stamp server. If no need, please pass an empty string.
[in]passwordPassword for the time stamp server. If no need, please pass an empty string.
Returns
The newly added time stamp server object.

◆ TimeStampServerMgrGetDefaultServer()

def fsdk.TimeStampServerMgrGetDefaultServer ( )

Get default time stamp server object.

Returns
A time stamp server object which is the default one.

◆ TimeStampServerMgrGetServer()

def fsdk.TimeStampServerMgrGetServer ( )

Get time stamp server with specified index.

Parameters
[in]indexTime stamp server index. Valid range: from 0 to (count-1). count is returned by function fsdk.TimeStampServerMgrGetServerCount .
Returns
A time stamp server object.

◆ TimeStampServerMgrGetServerCount()

def fsdk.TimeStampServerMgrGetServerCount ( )

Get time stamp server count.

Returns
Server count.

◆ TimeStampServerMgrGetServerIndex()

def fsdk.TimeStampServerMgrGetServerIndex ( )

Get the index of a speicified time stamp server object.

Parameters
[in]serverA time stamp server object.
Returns
Index of specified time stamp server object.

◆ TimeStampServerMgrInitialize()

def fsdk.TimeStampServerMgrInitialize ( )

Initialize time stamp server manager.

This function should be called first before any other functions in TimeStampServerMgr can be called.

Returns
fsdk.E_ErrSuccess means success.
For more information about error code values, please refer to values starting from fsdk.E_ErrSuccess .

◆ TimeStampServerMgrRelease()

def fsdk.TimeStampServerMgrRelease ( )

Release time stamp server manager.

User can call this function to release time stamp server manager when no need to use it any more. After this function is called, if user wants to use time stamp server manager again, please call function fsdk.TimeStampServerMgrInitialize again.

Returns
None.

◆ TimeStampServerMgrRemoveServer()

def fsdk.TimeStampServerMgrRemoveServer ( )

Remove a time stamp server from the manager, by index.

Parameters
[in]indexIndex of the time stamp server which is to be removed from the manager.
Returns
None.
Parameters
[in]serverA time stamp server object to be removed from the manager. If input server object is invalid, this function will do nothing and return directly.
Returns
None.

◆ TimeStampServerMgrSetDefaultServer()

def fsdk.TimeStampServerMgrSetDefaultServer ( )

Set default time stamp server object by index.

Parameters
[in]indexIndex of a time stamp server to be set as default one.Valid range: from 0 to (count-1). count is returned by function fsdk.TimeStampServerMgrGetServerCount .
Returns
None.
Parameters
[in]serverA time stamp server object to be set as default server. If input server object is invalid, this function wil throw exception fsdk.E_ErrNotFound .
Returns
None.

Variable Documentation

◆ AdditionalActionE_TriggerAnnotCursorEnter

fsdk.AdditionalActionE_TriggerAnnotCursorEnter

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.

◆ AdditionalActionE_TriggerAnnotCursorExit

fsdk.AdditionalActionE_TriggerAnnotCursorExit

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.

◆ AdditionalActionE_TriggerAnnotLoseInputFocus

fsdk.AdditionalActionE_TriggerAnnotLoseInputFocus

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

◆ AdditionalActionE_TriggerAnnotMouseButtonPressed

fsdk.AdditionalActionE_TriggerAnnotMouseButtonPressed

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.

◆ AdditionalActionE_TriggerAnnotMouseButtonReleased

fsdk.AdditionalActionE_TriggerAnnotMouseButtonReleased

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.

◆ AdditionalActionE_TriggerAnnotPageClosed

fsdk.AdditionalActionE_TriggerAnnotPageClosed

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 fsdk.AdditionalActionE_TriggerPageClosed is triggered, if such action present.

◆ AdditionalActionE_TriggerAnnotPageInvisible

fsdk.AdditionalActionE_TriggerAnnotPageInvisible

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.

◆ AdditionalActionE_TriggerAnnotPageOpened

fsdk.AdditionalActionE_TriggerAnnotPageOpened

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 fsdk.AdditionalActionE_TriggerPageOpened is triggered and open action of PDF document, if such actions present.

◆ AdditionalActionE_TriggerAnnotPageVisible

fsdk.AdditionalActionE_TriggerAnnotPageVisible

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.

◆ AdditionalActionE_TriggerAnnotReceiveInputFocus

fsdk.AdditionalActionE_TriggerAnnotReceiveInputFocus

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

◆ AdditionalActionE_TriggerDocPrinted

fsdk.AdditionalActionE_TriggerDocPrinted

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.

◆ AdditionalActionE_TriggerDocSaved

fsdk.AdditionalActionE_TriggerDocSaved

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.

◆ AdditionalActionE_TriggerDocWillClose

fsdk.AdditionalActionE_TriggerDocWillClose

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.

◆ AdditionalActionE_TriggerDocWillPrint

fsdk.AdditionalActionE_TriggerDocWillPrint

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.

◆ AdditionalActionE_TriggerDocWillSave

fsdk.AdditionalActionE_TriggerDocWillSave

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.

◆ AdditionalActionE_TriggerFieldKeyStroke

fsdk.AdditionalActionE_TriggerFieldKeyStroke

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.

◆ AdditionalActionE_TriggerFieldRecalculateValue

fsdk.AdditionalActionE_TriggerFieldRecalculateValue

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 fsdk.Form.GetFieldsInCalculationOrder .

◆ AdditionalActionE_TriggerFieldValueChanged

fsdk.AdditionalActionE_TriggerFieldValueChanged

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.

◆ AdditionalActionE_TriggerFieldWillFormat

fsdk.AdditionalActionE_TriggerFieldWillFormat

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.

◆ AdditionalActionE_TriggerPageClosed

fsdk.AdditionalActionE_TriggerPageClosed

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.

◆ AdditionalActionE_TriggerPageOpened

fsdk.AdditionalActionE_TriggerPageOpened

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.

◆ AnnotE_FlagHidden

fsdk.AnnotE_FlagHidden

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.

◆ AnnotE_FlagInvisible

fsdk.AnnotE_FlagInvisible

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.

◆ AnnotE_FlagLocked

fsdk.AnnotE_FlagLocked

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.

◆ AnnotE_FlagLockedContents

fsdk.AnnotE_FlagLockedContents

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.

◆ AnnotE_FlagNoRotate

fsdk.AnnotE_FlagNoRotate

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.

◆ AnnotE_FlagNoView

fsdk.AnnotE_FlagNoView

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

◆ AnnotE_FlagNoZoom

fsdk.AnnotE_FlagNoZoom

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.

◆ AnnotE_FlagPrint

fsdk.AnnotE_FlagPrint

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.

◆ AnnotE_FlagReadOnly

fsdk.AnnotE_FlagReadOnly

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 fsdk.AnnotE_FlagNoView and fsdk.AnnotE_FlagPrint ) 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 fsdk.FieldE_FlagReadOnly of related form field.

◆ AnnotE_FlagToggleNoView

fsdk.AnnotE_FlagToggleNoView

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.

◆ AnnotE_MKEntryDownCaption

fsdk.AnnotE_MKEntryDownCaption

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

Note
Only applicable for widget annotation associated with pushbutton field.

◆ AnnotE_MKEntryDownIcon

fsdk.AnnotE_MKEntryDownIcon

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

Note
Only applicable for widget annotation associated with pushbutton field.

◆ AnnotE_MKEntryIconCaptionRelation

fsdk.AnnotE_MKEntryIconCaptionRelation

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.

◆ AnnotE_MKEntryIconFit

fsdk.AnnotE_MKEntryIconFit

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

Note
Only applicable for widget annotation associated with pushbutton field.

◆ AnnotE_MKEntryNormalCaption

fsdk.AnnotE_MKEntryNormalCaption

Normal caption entry. "CA" in MK dictionary.

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

◆ AnnotE_MKEntryNormalIcon

fsdk.AnnotE_MKEntryNormalIcon

Normal icon entry. "I" in MK dictionary.

Note
Only applicable for widget annotation associated with pushbutton field.

◆ AnnotE_MKEntryRolloverCaption

fsdk.AnnotE_MKEntryRolloverCaption

Rollover caption entry. "RC" in MK dictionary.

Note
Only applicable for widget annotation associated with pushbutton field.

◆ AnnotE_MKEntryRolloverIcon

fsdk.AnnotE_MKEntryRolloverIcon

Rollover icon entry. "RI" in MK dictionary.

Note
Only applicable for widget annotation associated with pushbutton field.

◆ AnnotE_PropertyBorderColor

fsdk.AnnotE_PropertyBorderColor

Annotation property: border color.

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

◆ AnnotE_PropertyCreationDate

fsdk.AnnotE_PropertyCreationDate

Annotation property: creation date.

Only markup annotations can have creation date property.

◆ AnnotE_PropertyFillColor

fsdk.AnnotE_PropertyFillColor

Annotation property: fill color.

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

◆ AnnotE_Widget

fsdk.AnnotE_Widget

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

Note
Foxit PDF SDK treats widget annotation as form control.

◆ BorderInfoE_Beveled

fsdk.BorderInfoE_Beveled

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 fsdk.BorderInfoE_Solid by default internally.

◆ BorderInfoE_Cloudy

fsdk.BorderInfoE_Cloudy

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 fsdk.BorderInfoE_Solid by default internally.

◆ BorderInfoE_Dashed

fsdk.BorderInfoE_Dashed

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 fsdk.BorderInfoE_Solid by default internally.

◆ BorderInfoE_Inset

fsdk.BorderInfoE_Inset

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 fsdk.BorderInfoE_Solid by default internally.

◆ BorderInfoE_UnderLine

fsdk.BorderInfoE_UnderLine

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 fsdk.BorderInfoE_Solid by default internally.

◆ DestinationE_ZoomFitBBox

fsdk.DestinationE_ZoomFitBBox

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.

◆ DestinationE_ZoomFitBHorz

fsdk.DestinationE_ZoomFitBHorz

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.

◆ DestinationE_ZoomFitBVert

fsdk.DestinationE_ZoomFitBVert

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.

◆ DestinationE_ZoomFitHorz

fsdk.DestinationE_ZoomFitHorz

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.

◆ DestinationE_ZoomFitPage

fsdk.DestinationE_ZoomFitPage

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.

◆ DestinationE_ZoomFitRect

fsdk.DestinationE_ZoomFitRect

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.

◆ DestinationE_ZoomFitVert

fsdk.DestinationE_ZoomFitVert

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.

◆ DestinationE_ZoomXYZ

fsdk.DestinationE_ZoomXYZ

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.

◆ DWG2PDFSettingDataE_FlagZoomToExtentsMode

fsdk.DWG2PDFSettingDataE_FlagZoomToExtentsMode

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.

◆ FieldE_FlagTextComb

fsdk.FieldE_FlagTextComb

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

◆ FieldE_FlagTextPassword

fsdk.FieldE_FlagTextPassword

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

◆ GraphicsObjectE_BlendColor

fsdk.GraphicsObjectE_BlendColor

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

◆ GraphicsObjectE_BlendColorBurn

fsdk.GraphicsObjectE_BlendColorBurn

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
        

◆ GraphicsObjectE_BlendColorDodge

fsdk.GraphicsObjectE_BlendColorDodge

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
        

◆ GraphicsObjectE_BlendDarken

fsdk.GraphicsObjectE_BlendDarken

Select darker one of backdrop and source colors.

Here is the formula :

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

◆ GraphicsObjectE_BlendDifference

fsdk.GraphicsObjectE_BlendDifference

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

Here is the formula :

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

◆ GraphicsObjectE_BlendExclusion

fsdk.GraphicsObjectE_BlendExclusion

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

◆ GraphicsObjectE_BlendHardlight

fsdk.GraphicsObjectE_BlendHardlight

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
        

◆ GraphicsObjectE_BlendHue

fsdk.GraphicsObjectE_BlendHue

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

◆ GraphicsObjectE_BlendLighten

fsdk.GraphicsObjectE_BlendLighten

Select lighter one of backdrop and source colors.

Here is the formula :

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

◆ GraphicsObjectE_BlendLuminosity

fsdk.GraphicsObjectE_BlendLuminosity

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

◆ GraphicsObjectE_BlendMultiply

fsdk.GraphicsObjectE_BlendMultiply

Multiply backdrop by source color values.

Here is the formula :

B(Cb, Cs) = Cb * Cs.

◆ GraphicsObjectE_BlendNormal

fsdk.GraphicsObjectE_BlendNormal

Selecting source color and ignoring backdrop color.

Here is the formula :

B(Cb, Cs) = Cs.

◆ GraphicsObjectE_BlendOverlay

fsdk.GraphicsObjectE_BlendOverlay

Multiply or screens colors, depending on backdrop color value.

Here is the formula :

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

◆ GraphicsObjectE_BlendSaturation

fsdk.GraphicsObjectE_BlendSaturation

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

◆ GraphicsObjectE_BlendScreen

fsdk.GraphicsObjectE_BlendScreen

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.

◆ GraphicsObjectE_BlendSoftlight

fsdk.GraphicsObjectE_BlendSoftlight

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
        

◆ GraphicsObjectsE_TextMergeBTET

fsdk.GraphicsObjectsE_TextMergeBTET

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.

◆ GraphStateE_LineJoinBevel

fsdk.GraphStateE_LineJoinBevel

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.

◆ GraphStateE_LineJoinMiter

fsdk.GraphStateE_LineJoinMiter

Miter line join type.

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

◆ GraphStateE_LineJoinRound

fsdk.GraphStateE_LineJoinRound

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.

◆ ImageE_JBIG2

fsdk.ImageE_JBIG2

Image type is JBIG2.

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

◆ ImageE_None

fsdk.ImageE_None

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.

◆ ImageE_WEBP

fsdk.ImageE_WEBP

Image type is webp.

Note
Currently, unsupported on Android, iOS, linux arm and mac arm platforms.

◆ LRStructureElementE_AttributeTypeABox

fsdk.LRStructureElementE_AttributeTypeABox

(Reserved) Attribute type: ABox.

Note
Value type for this attribute type is an array of four numbers.

◆ LRStructureElementE_AttributeTypeAttached

fsdk.LRStructureElementE_AttributeTypeAttached

Attribute type: Attached, which specifies the edges of the page, if any, to which the artifact is logically attached.

Note
Value type for this attribute type is an array of specified enum values. Valid enum values are:

◆ LRStructureElementE_AttributeTypeBackgroundColor

fsdk.LRStructureElementE_AttributeTypeBackgroundColor

Attribute type: BackgroundColor, which represents the color to be used to fill the background of a table cell or any element's content rectangle.

Note
Value type for this attribute type is RGB color.

◆ LRStructureElementE_AttributeTypeBaselineShift

fsdk.LRStructureElementE_AttributeTypeBaselineShift

Attribute type: BaselineShift, which means the distance by which the element's baseline is shifted relative to that of its parent element.

Note
Value type for this attribute type is number.

◆ LRStructureElementE_AttributeTypeBBox

fsdk.LRStructureElementE_AttributeTypeBBox

Attribute type: BBox, which represents the element's bounding box (the rectangle that completely encloses its visible content).

Note
Value type for this attribute type is an array of four numbers in [PDF coordinate system] () giving the coordinates of the left, bottom, right, and top edges of the elements's bounding box.

◆ LRStructureElementE_AttributeTypeBlockAlign

fsdk.LRStructureElementE_AttributeTypeBlockAlign

Attribute type: BlockAlign, which represents the alignment, in the block-progression direction, of content within the table cell.

Note
Value type for this attribute type is enum. Valid enum values are:

◆ LRStructureElementE_AttributeTypeBorderColor

fsdk.LRStructureElementE_AttributeTypeBorderColor

Attribute type: BorderColor, which represents the color of the border drawn on the edges of a table cell or any element's content rectangle.

Note
Value type for this attribute type is RGB color or an array of RGB color values.

◆ LRStructureElementE_AttributeTypeBorderStyle

◆ LRStructureElementE_AttributeTypeBorderThickness

fsdk.LRStructureElementE_AttributeTypeBorderThickness

Attribute type: BorderThickness, which represents the thickness of the border drawn on the edges of a table cell or any element's content rectangle.

Note
Value type for this attribute type is number (for all four edges) or an array of four numbers (for one edge of the border, in the order of the before, after, start, and end edge).

◆ LRStructureElementE_AttributeTypeColor

fsdk.LRStructureElementE_AttributeTypeColor

Attribute type: Color, which represents the color to be used for drawing text and the default value for the color of table borders and text decorations.

Note
Value type for this attribute type is RGB color.

◆ LRStructureElementE_AttributeTypeColSpan

fsdk.LRStructureElementE_AttributeTypeColSpan

Attribute type only for Table: ColSpan, which represents the number of columns in the enclosing table that are spanned by the cell.

Note
Value type for this attribute type is number.

◆ LRStructureElementE_AttributeTypeColumnCount

fsdk.LRStructureElementE_AttributeTypeColumnCount

Attribute type: ColumnCount, which represents the number of columns in the content of the grouping element.

Note
Value type for this attribute type is number.

◆ LRStructureElementE_AttributeTypeColumnGap

fsdk.LRStructureElementE_AttributeTypeColumnGap

Attribute type: ColumnGap, which represents the desired space between adjacent columns, measured in the inline- progression direction.

Note
Value type for this attribute type can be number (for all columns) or an array of numbers. When the value type is array:
  • if the array contains (ColumnCount-1) numbers, these numbers represent the space between the first and second columns, the second and third columns, and so on, respectively.

  • if there are fewer than (ColumnCount-1) numbers, the last element specifies all remaining spaces; excess array elements are ignored.

◆ LRStructureElementE_AttributeTypeColumnWidths

fsdk.LRStructureElementE_AttributeTypeColumnWidths

Attribute type: ColumnWidths, which represents the desired width of the columns, measured in the inline-progression direction.

Note
Value type for this attribute type can be number (for all columns) or an array of numbers. When the value type is array:
  • if the array contains ColumnCount numbers, these numbers represent the width of each column, in order.

  • if there are fewer than ColumnCount numbers, the last element specifies all remaining widths; excess array elements are ignored.

◆ LRStructureElementE_AttributeTypeDestination

fsdk.LRStructureElementE_AttributeTypeDestination

Attribute type: Destination (PDF 2.0), which provides a means to access content.

Note
Value type for this attribute type is an array of zero or stirngs with ID.

◆ LRStructureElementE_AttributeTypeDirection

fsdk.LRStructureElementE_AttributeTypeDirection

◆ LRStructureElementE_AttributeTypeEndIndent

fsdk.LRStructureElementE_AttributeTypeEndIndent

Attribute type: EndIndent, which represents the distance from the end edge of the BLSE to that of the reference area.

Note
Value type for this attribute type is number.

◆ LRStructureElementE_AttributeTypeFieldChecked

fsdk.LRStructureElementE_AttributeTypeFieldChecked

Attribute type only for PrintField: checked, which represents the state of a radio button or check box field.

Note
Value type for this attribute type is enum. Valid enum values are:

◆ LRStructureElementE_AttributeTypeFieldDesc

fsdk.LRStructureElementE_AttributeTypeFieldDesc

Attribute type only for PrintField: Desc, which represents the alternate name of the field, similar to the value supplied in the TU entry of the field dictionary for interactive fields.

Note
Value type for this attribute type is string.

◆ LRStructureElementE_AttributeTypeFieldRole

fsdk.LRStructureElementE_AttributeTypeFieldRole

Attribute type only for PrintField: Role, which represents the type of form field represented by this graphic.

Note
Value type for this attribute type is enum. Valid enum values are:

◆ LRStructureElementE_AttributeTypeGlyphOrientationVertical

fsdk.LRStructureElementE_AttributeTypeGlyphOrientationVertical

Attribute type: GlyphOrientationVertical, which specifies the orientation of glyphs when the inline-progression direction is top to bottom or bottom to top.

Note
Value type for this attribute type is number (which should be one of specified numbers -90, 0, 90, 180, and 270) or enum (which should be value fsdk.LRStructureElementE_AttributeValueEnumAuto ).

◆ LRStructureElementE_AttributeTypeHeight

fsdk.LRStructureElementE_AttributeTypeHeight

Attribute type: Height, which represents the height of the element's content rectangle.

Note
Value type for this attribute type is number or enum value fsdk.LRStructureElementE_AttributeValueEnumAuto .

◆ LRStructureElementE_AttributeTypeInlineAlign

fsdk.LRStructureElementE_AttributeTypeInlineAlign

Attribute type: InlineAlign, which represents the alignment, in the inline-progression direction, of content within the table cell.

Note
Value type for this attribute type is enum. Valid enum values are:

◆ LRStructureElementE_AttributeTypeLineHeight

fsdk.LRStructureElementE_AttributeTypeLineHeight

Attribute type: LineHeight, which means the element's preferred height, in the block-progression direction.

Note
Value type for this attribute type can be number or enum. Valid enum values are:

◆ LRStructureElementE_AttributeTypeListNumbering

fsdk.LRStructureElementE_AttributeTypeListNumbering

◆ LRStructureElementE_AttributeTypePadding

fsdk.LRStructureElementE_AttributeTypePadding

Attribute type: Padding, which specifies an offset to account for the separation between the element's content rectangle and the surrounding border.

Note
Value type for this attribute type is number (for all four sides) or an array of four numbers (for the before, after, start, and end edge).

◆ LRStructureElementE_AttributeTypePlacement

fsdk.LRStructureElementE_AttributeTypePlacement

Attribute type: Placement, which means the positioning of the element with respect to the enclosing reference area and other content.

Note
Value type for this attribute type is enum. Valid enum values are:

◆ LRStructureElementE_AttributeTypeRole

fsdk.LRStructureElementE_AttributeTypeRole

Attribute type: role, which means strings of structure element meaning and standard type it maps to.

Note
Value type for this attribute type is string.

◆ LRStructureElementE_AttributeTypeRotation

fsdk.LRStructureElementE_AttributeTypeRotation

Attribute type: Rotation.

Note
Value type for this attribute type is number.

◆ LRStructureElementE_AttributeTypeRowSpan

fsdk.LRStructureElementE_AttributeTypeRowSpan

Attribute type only for Table: RowSpan, which represents the number of rows in the enclosing table that are spanned by the cell.

Note
Value type for this attribute type is number.

◆ LRStructureElementE_AttributeTypeRubyAlign

fsdk.LRStructureElementE_AttributeTypeRubyAlign

Attribute type: RubyAlign, which represents the justification of the lines within a ruby assembly.

Note
Value type for this attribute type is enum or an array of specified enum values. Valid enum values are:

◆ LRStructureElementE_AttributeTypeRubyPosition

fsdk.LRStructureElementE_AttributeTypeRubyPosition

Attribute type: RubyPosition, which represents the placement of the RT structure element relative to the RB element in a ruby assembly.

Note
Value type for this attribute type is enum. Valid enum values are:

◆ LRStructureElementE_AttributeTypeShort

fsdk.LRStructureElementE_AttributeTypeShort

Attribute type: Short (PDF 2.0), which contains a short form of the content of a TH structure element's content.

Note
Value type for this attribute type is string.

◆ LRStructureElementE_AttributeTypeSpaceAfter

fsdk.LRStructureElementE_AttributeTypeSpaceAfter

Attribute type: SpaceAfter, which represents the amount of extra space following the after edge of the BLSE.

Note
Value type for this attribute type is number.

◆ LRStructureElementE_AttributeTypeSpaceBefore

fsdk.LRStructureElementE_AttributeTypeSpaceBefore

Attribute type: SpaceBefore, which represents the amount of extra space preceding the before edge of the BLSE.

Note
Value type for this attribute type is number.

◆ LRStructureElementE_AttributeTypeStartIndent

fsdk.LRStructureElementE_AttributeTypeStartIndent

Attribute type: StartIndent, which represents the distance from the start edge of the reference area to that of the BLSE.

Note
Value type for this attribute type is number.

◆ LRStructureElementE_AttributeTypeSubType

fsdk.LRStructureElementE_AttributeTypeSubType

Attribute type: Subtype, which means the subtype of annotation or artifact.

Note
Value type for this attribute type:

◆ LRStructureElementE_AttributeTypeTableHeaders

fsdk.LRStructureElementE_AttributeTypeTableHeaders

(Currently, unsupported) Attribute type only for Table: Headers, which represents an array of element identifiers.

Note
Value type for this attribute type is an array of strings.

◆ LRStructureElementE_AttributeTypeTableHeaderScope

fsdk.LRStructureElementE_AttributeTypeTableHeaderScope

Attribute type only for Table: Scope, which indicates whether the header cell applies to the rest of the cells in the row that contains it, the column that contains it, or both the row and the column that contain it.

Note
Value type for this attribute type is enum. Valid enum values are:

◆ LRStructureElementE_AttributeTypeTableSummary

fsdk.LRStructureElementE_AttributeTypeTableSummary

Attribute type only for Table: Summary, which represents a summary of the table's purpose and structure, for use in non- visual rendering such as speech or braille.

Note
Value type for this attribute type is string.

◆ LRStructureElementE_AttributeTypeTBorderStyle

◆ LRStructureElementE_AttributeTypeTextAlign

fsdk.LRStructureElementE_AttributeTypeTextAlign

Attribute type: TextAlign, which represents the alignment of text and other content within lines of the BLSE.

Note
Value type for this attribute type is enum. Valid enum values are:

◆ LRStructureElementE_AttributeTypeTextDecorationColor

fsdk.LRStructureElementE_AttributeTypeTextDecorationColor

Attribute type: TextDecorationColor, which represents the color to be used for drawing text decorations.

Note
Value type for this attribute type is RGB color.

◆ LRStructureElementE_AttributeTypeTextDecorationThickness

fsdk.LRStructureElementE_AttributeTypeTextDecorationThickness

Attribute type: TextDecorationThickness, which represents the thickness of each line drawn as part of the text decoration.

Note
Value type for this attribute type is number.

◆ LRStructureElementE_AttributeTypeTextDecorationType

fsdk.LRStructureElementE_AttributeTypeTextDecorationType

Attribute type: TextDecorationType, which represents the text decoration, if any, to be applied to the element's text.

Note
Value type for this attribute type is enum or an array of specified enum values. Valid enum values are:

◆ LRStructureElementE_AttributeTypeTextIndent

fsdk.LRStructureElementE_AttributeTypeTextIndent

Attribute type: TextIndent, which represents the additional distance from the start edge of the BLSE, as specified by fsdk.LRStructureElementE_AttributeTypeStartIndent , to that of the first line of text.

Note
Value type for this attribute type is number.

◆ LRStructureElementE_AttributeTypeTPadding

fsdk.LRStructureElementE_AttributeTypeTPadding

Attribute type: TPadding, which specifies an offset to account for the separation between the table cell's content rectangle and the surrounding border.

Note
Value type for this attribute type is number (for all four edges of the table cell) or an array of four numbers (for the before edge, after edge, start edge, and end edge of the content rectangle).

◆ LRStructureElementE_AttributeTypeVersion

fsdk.LRStructureElementE_AttributeTypeVersion

(Reserved) Attribute type: Version, which represents schema version of layout recognition engine.

Note
Value type for this attribute type is number.

◆ LRStructureElementE_AttributeTypeWidth

fsdk.LRStructureElementE_AttributeTypeWidth

Attribute type: Width, which represents the width of the element's content rectangle.

Note
Value type for this attribute type is number or enum value fsdk.LRStructureElementE_AttributeValueEnumAuto .

◆ LRStructureElementE_AttributeTypeWritingMode

fsdk.LRStructureElementE_AttributeTypeWritingMode

Attribute type: WritingMode, which means the directions of layout progression for packing of ILSEs (inline progression) and stacking of BLSEs (block progression).

Note
Value type for this attribute type is enum. Valid enum values are:

◆ LRStructureElementE_AttributeValueEnumAfter

fsdk.LRStructureElementE_AttributeValueEnumAfter

Enum value: After, which means the alignment for attribute BlockAlign or the placement for attribute RubyPosition.

  • For attribute BlockAlign, this means after edge of the last child's allocation rectangle aligned with that of the table cell's content rectangle.

  • For attribute RubyPosition, this means the RT content is to be aligned along the after edge of the element.

Note
This can be used with attribute types fsdk.LRStructureElementE_AttributeTypeBlockAlign , and fsdk.LRStructureElementE_AttributeTypeRubyPosition .

◆ LRStructureElementE_AttributeValueEnumAuto

fsdk.LRStructureElementE_AttributeValueEnumAuto

Enum value: Auto.

  • For attribute Width and Height, this indicates that no specific value and the value will be determined automatically.

  • For attribute LineHeight, this means not to adjust for the value of BaselineShift.

  • For attribute GlyphOrientationVertical, this specifies a default orientation for text depending on whether it is fullwidth(as wide as it is high).

Note
This can be used with attribute types fsdk.LRStructureElementE_AttributeTypeWidth , fsdk.LRStructureElementE_AttributeTypeHeight , fsdk.LRStructureElementE_AttributeTypeLineHeight , and fsdk.LRStructureElementE_AttributeTypeGlyphOrientationVertical .

◆ LRStructureElementE_AttributeValueEnumBackground

fsdk.LRStructureElementE_AttributeValueEnumBackground

Enum value: Background, which means background artifacts. Background artifacts typically serve as a background for content shown either on top of or placed adjacent to that background.

Note
This can be used with attribute type fsdk.LRStructureElementE_AttributeTypeSubType .

◆ LRStructureElementE_AttributeValueEnumBefore

fsdk.LRStructureElementE_AttributeValueEnumBefore

Enum value: Before, which means the placement for attributes Placement/RubyPosition or alignment for attribute BlockAlign.

  • For attribute Placement, this means to be placed so that the before edge of the element's allocation rectangle coincides with that of the nearest enclosing reference area.

  • For attribute BlockAlign, this means before edge of the first child's allocation rectangle aligned with that of the table cell's content rectangle.

  • For attribute RubyPosition, this means the placement of the RT structure element relative to the RB element in a ruby assembly.

Note
This can be used with attribute types fsdk.LRStructureElementE_AttributeTypePlacement , fsdk.LRStructureElementE_AttributeTypeBlockAlign , and fsdk.LRStructureElementE_AttributeTypeRubyPosition .

◆ LRStructureElementE_AttributeValueEnumBlock

fsdk.LRStructureElementE_AttributeValueEnumBlock

Enum value: Block, which means to be stacked in the block-progression direction within an enclosing reference area or parent BLSE.

Note
This can be used with attribute type fsdk.LRStructureElementE_AttributeTypePlacement .

◆ LRStructureElementE_AttributeValueEnumBoth

fsdk.LRStructureElementE_AttributeValueEnumBoth

Enum value: Row, which means both row and column of a table.

Note
This can be used with attribute type fsdk.LRStructureElementE_AttributeTypeTableHeaderScope .

◆ LRStructureElementE_AttributeValueEnumBottom

fsdk.LRStructureElementE_AttributeValueEnumBottom

Enum value: Bottom, which means bottom edge of the page.

Note
This can be used with attribute type fsdk.LRStructureElementE_AttributeTypeAttached .

◆ LRStructureElementE_AttributeValueEnumCB

fsdk.LRStructureElementE_AttributeValueEnumCB

Enum value: cb, which means check box.

Note
This can be used with attribute type fsdk.LRStructureElementE_AttributeTypeFieldRole .

◆ LRStructureElementE_AttributeValueEnumCenter

fsdk.LRStructureElementE_AttributeValueEnumCenter

Enum value: Center, which means the alignment for attributes TextAlign/InlineAlign/RubyAlign.

  • For attribute TextAlign, this means to be centered between the start and end edges.

  • For attribute InlineAlign, this means that each child centered within the table cell.

  • For attribute RubyAlign, this means that the content is to be centered in the inline-progression direction

Note
This can be used with attribute types fsdk.LRStructureElementE_AttributeTypeTextAlign , fsdk.LRStructureElementE_AttributeTypeInlineAlign , and fsdk.LRStructureElementE_AttributeTypeRubyAlign .

◆ LRStructureElementE_AttributeValueEnumCircle

fsdk.LRStructureElementE_AttributeValueEnumCircle

Enum value: Circle, which means open circular bullet.

Note
This can be used with attribute type fsdk.LRStructureElementE_AttributeTypeListNumbering .

◆ LRStructureElementE_AttributeValueEnumColumn

fsdk.LRStructureElementE_AttributeValueEnumColumn

Enum value: Row, which means column of a table.

Note
This can be used with attribute type fsdk.LRStructureElementE_AttributeTypeTableHeaderScope .

◆ LRStructureElementE_AttributeValueEnumDashed

fsdk.LRStructureElementE_AttributeValueEnumDashed

Enum value: Dashed, which means the border is a series of short line segments.

Note
This can be used with attribute types fsdk.LRStructureElementE_AttributeTypeBorderStyle , and fsdk.LRStructureElementE_AttributeTypeTBorderStyle .

◆ LRStructureElementE_AttributeValueEnumDecimal

fsdk.LRStructureElementE_AttributeValueEnumDecimal

Enum value: Decimal, which means decimal arabic numerals (1-9, 10-99, ...).

Note
This can be used with attribute type fsdk.LRStructureElementE_AttributeTypeListNumbering .

◆ LRStructureElementE_AttributeValueEnumDisc

fsdk.LRStructureElementE_AttributeValueEnumDisc

Enum value: Disc, which means solid circular bullet.

Note
This can be used with attribute type fsdk.LRStructureElementE_AttributeTypeListNumbering .

◆ LRStructureElementE_AttributeValueEnumDistribute

fsdk.LRStructureElementE_AttributeValueEnumDistribute

Enum value: Distribute, which means the content is to be expanded to fill the available width in the inline-progression direction.

Note
This can be used with attribute type fsdk.LRStructureElementE_AttributeTypeRubyAlign .

◆ LRStructureElementE_AttributeValueEnumDotted

fsdk.LRStructureElementE_AttributeValueEnumDotted

Enum value: Dotten, which means the border is a series of dots.

Note
This can be used with attribute types fsdk.LRStructureElementE_AttributeTypeBorderStyle , and fsdk.LRStructureElementE_AttributeTypeTBorderStyle .

◆ LRStructureElementE_AttributeValueEnumDouble

fsdk.LRStructureElementE_AttributeValueEnumDouble

Enum value: Double, which means the border is two solid lines.

Note
This can be used with attribute types fsdk.LRStructureElementE_AttributeTypeBorderStyle , and fsdk.LRStructureElementE_AttributeTypeTBorderStyle .

◆ LRStructureElementE_AttributeValueEnumEnd

fsdk.LRStructureElementE_AttributeValueEnumEnd

Enum value: End, which means the place for attribute Placement, or the alignment for attributes TextAlign/InlineAlign/RubyAlign.

  • For attribute Placement, this means to be placed so that the end edge of the element's allocation rectangle coincides with that of the nearest enclosing reference area.

  • For attribute TextAlign, this means to be aligned with the end edge.

  • For attribute InlineAlign, this means end edge of each child's allocation rectangle aligned with that of the table cell's content rectangle.

  • For attribute RubyAlign, this means that the content is to be aligned on the end edge in the inlineprogression direction.

Note
This can be used with attribute types fsdk.LRStructureElementE_AttributeTypePlacement , fsdk.LRStructureElementE_AttributeTypeTextAlign , fsdk.LRStructureElementE_AttributeTypeInlineAlign , and fsdk.LRStructureElementE_AttributeTypeRubyAlign .

◆ LRStructureElementE_AttributeValueEnumGroove

fsdk.LRStructureElementE_AttributeValueEnumGroove

Enum value: Groove, which means the border looks as though it were carved into the canvas.

Note
This can be used with attribute types fsdk.LRStructureElementE_AttributeTypeBorderStyle , and fsdk.LRStructureElementE_AttributeTypeTBorderStyle .

◆ LRStructureElementE_AttributeValueEnumHidden

fsdk.LRStructureElementE_AttributeValueEnumHidden

Enum value: Hidden, which is same as None except in terms of border conflict resolution for table elements.

Note
This can be used with attribute types fsdk.LRStructureElementE_AttributeTypeBorderStyle , and fsdk.LRStructureElementE_AttributeTypeTBorderStyle .

◆ LRStructureElementE_AttributeValueEnumInline

fsdk.LRStructureElementE_AttributeValueEnumInline

Enum value: Inline, which means the placement for attributes Placement/RubyPosition.

  • For attribute Placement, this means to be packed in the inline-progression direction within an enclosing BLSE.

  • For attribute RubyPosition, this means that the RT and associated RP elements are to be formatted as a parenthesis comment, following the RB element

Note
This can be used with attribute types fsdk.LRStructureElementE_AttributeTypePlacement , and fsdk.LRStructureElementE_AttributeTypeRubyPosition .

◆ LRStructureElementE_AttributeValueEnumInset

fsdk.LRStructureElementE_AttributeValueEnumInset

Enum value: Inset, which means the border makes the entire box look as though it were embedded in the canvas.

Note
This can be used with attribute types fsdk.LRStructureElementE_AttributeTypeBorderStyle , and fsdk.LRStructureElementE_AttributeTypeTBorderStyle .

◆ LRStructureElementE_AttributeValueEnumJustify

fsdk.LRStructureElementE_AttributeValueEnumJustify

Enum value: Justify, which means the alignment for attributes TextAlign/BlockAlign/RubyAlign.

  • For attribute TextAlign, this means to be aligned with both the start and end edges, with internal spacing within each line expanded, if necessary, to achieve such alignment.

  • For attribute BlockAlign, this means that children are aligned with both the before and after edges of the table cell's content rectangle.

  • For attribute RubyAlign, this means that the content is to be centered in the inline-progression direction

Note
This can be used with attribute types fsdk.LRStructureElementE_AttributeTypeTextAlign , fsdk.LRStructureElementE_AttributeTypeBlockAlign , and fsdk.LRStructureElementE_AttributeTypeRubyAlign .

◆ LRStructureElementE_AttributeValueEnumLayout

fsdk.LRStructureElementE_AttributeValueEnumLayout

Enum value: Layout, which means layout artifacts. Purely cosmetic typographical or design elements such as footnote rules or background screens.

Note
This can be used with attribute type fsdk.LRStructureElementE_AttributeTypeSubType .

◆ LRStructureElementE_AttributeValueEnumLeft

fsdk.LRStructureElementE_AttributeValueEnumLeft

Enum value: Left, which means left edge of the page.

Note
This can be used with attribute type fsdk.LRStructureElementE_AttributeTypeAttached .

◆ LRStructureElementE_AttributeValueEnumLineThrough

fsdk.LRStructureElementE_AttributeValueEnumLineThrough

Enum value: LineThrough, which means a line through the middle of the text.

Note
This can be used with attribute type fsdk.LRStructureElementE_AttributeTypeTextDecorationType .

◆ LRStructureElementE_AttributeValueEnumLowerAlpha

fsdk.LRStructureElementE_AttributeValueEnumLowerAlpha

Enum value: LowerAlpha, which means lowercase letters (a, b, c, ...).

Note
This can be used with attribute type fsdk.LRStructureElementE_AttributeTypeListNumbering .

◆ LRStructureElementE_AttributeValueEnumLowerRoman

fsdk.LRStructureElementE_AttributeValueEnumLowerRoman

Enum value: LowerRoman, which means lowercase roman numerals (i, ii, iii, iv, ...).

Note
This can be used with attribute type fsdk.LRStructureElementE_AttributeTypeListNumbering .

◆ LRStructureElementE_AttributeValueEnumLrTb

fsdk.LRStructureElementE_AttributeValueEnumLrTb

Enum value: LtTb, which means inline progression from left to right; block progression from top to bottom.

Note
This can be used with attribute type fsdk.LRStructureElementE_AttributeTypeWritingMode .

◆ LRStructureElementE_AttributeValueEnumMiddle

fsdk.LRStructureElementE_AttributeValueEnumMiddle

Enum value: Middle, which means children are centered within the table cell.

Note
This can be used with attribute type fsdk.LRStructureElementE_AttributeTypeBlockAlign .

◆ LRStructureElementE_AttributeValueEnumNeutral

fsdk.LRStructureElementE_AttributeValueEnumNeutral

Enum value: neutral, which means the state is neutral.

Note
This can be used with attribute type fsdk.LRStructureElementE_AttributeTypeFieldChecked .

◆ LRStructureElementE_AttributeValueEnumNone

fsdk.LRStructureElementE_AttributeValueEnumNone

◆ LRStructureElementE_AttributeValueEnumOff

fsdk.LRStructureElementE_AttributeValueEnumOff

Enum value: off, which means the state is off.

Note
This can be used with attribute type fsdk.LRStructureElementE_AttributeTypeFieldChecked .

◆ LRStructureElementE_AttributeValueEnumOn

fsdk.LRStructureElementE_AttributeValueEnumOn

Enum value: on, which means the state is on.

Note
This can be used with attribute type fsdk.LRStructureElementE_AttributeTypeFieldChecked .

◆ LRStructureElementE_AttributeValueEnumOrdered

fsdk.LRStructureElementE_AttributeValueEnumOrdered

Enum value: Ordered (PDF 2.0), which means ordered lists with unspecified numbering.

Note
This can be used with attribute type fsdk.LRStructureElementE_AttributeTypeListNumbering .

◆ LRStructureElementE_AttributeValueEnumOther

fsdk.LRStructureElementE_AttributeValueEnumOther

Enum value: Other (PDF 2.0).

Note
This can be used with attribute type fsdk.LRStructureElementE_AttributeTypeDirection .

◆ LRStructureElementE_AttributeValueEnumOutset

fsdk.LRStructureElementE_AttributeValueEnumOutset

Enum value: Outset, which means the border makes the entire box look as though it were coming out of the canvas (the opposite of Inset).

Note
This can be used with attribute types fsdk.LRStructureElementE_AttributeTypeBorderStyle , and fsdk.LRStructureElementE_AttributeTypeTBorderStyle .

◆ LRStructureElementE_AttributeValueEnumOverline

fsdk.LRStructureElementE_AttributeValueEnumOverline

Enum value: Overline, which means a line above the text.

Note
This can be used with attribute type fsdk.LRStructureElementE_AttributeTypeTextDecorationType .

◆ LRStructureElementE_AttributeValueEnumPage

fsdk.LRStructureElementE_AttributeValueEnumPage

Enum value: Page, which means page artifacts. Production aids extraneous to the document itself, such as cut marks and color bars.

Note
This can be used with attribute type fsdk.LRStructureElementE_AttributeTypeSubType .

◆ LRStructureElementE_AttributeValueEnumPagination

fsdk.LRStructureElementE_AttributeValueEnumPagination

Enum value: Pagination, which means pagination artifacts. Ancillary page features such as running heads and folios (page numbers).

Note
This can be used with attribute type fsdk.LRStructureElementE_AttributeTypeSubType .

◆ LRStructureElementE_AttributeValueEnumPB

fsdk.LRStructureElementE_AttributeValueEnumPB

Enum value: pb, which means push button.

Note
This can be used with attribute type fsdk.LRStructureElementE_AttributeTypeFieldRole .

◆ LRStructureElementE_AttributeValueEnumRB

fsdk.LRStructureElementE_AttributeValueEnumRB

Enum value: rb, which means radio button.

Note
This can be used with attribute type fsdk.LRStructureElementE_AttributeTypeFieldRole .

◆ LRStructureElementE_AttributeValueEnumRidge

fsdk.LRStructureElementE_AttributeValueEnumRidge

Enum value: Ridge, which means the border looks as though it were coming out of the canvas (the opposite of Groove).

Note
This can be used with attribute types fsdk.LRStructureElementE_AttributeTypeBorderStyle , and fsdk.LRStructureElementE_AttributeTypeTBorderStyle .

◆ LRStructureElementE_AttributeValueEnumRight

fsdk.LRStructureElementE_AttributeValueEnumRight

Enum value: Right, which means right edge of the page.

Note
This can be used with attribute type fsdk.LRStructureElementE_AttributeTypeAttached .

◆ LRStructureElementE_AttributeValueEnumRlTb

fsdk.LRStructureElementE_AttributeValueEnumRlTb

Enum value: RlTb, which means inline progression from right to left; block progression from top to bottom.

Note
This can be used with attribute type fsdk.LRStructureElementE_AttributeTypeWritingMode .

◆ LRStructureElementE_AttributeValueEnumRow

fsdk.LRStructureElementE_AttributeValueEnumRow

Enum value: Row, which means row of a table.

Note
This can be used with attribute type fsdk.LRStructureElementE_AttributeTypeTableHeaderScope .

◆ LRStructureElementE_AttributeValueEnumSolid

fsdk.LRStructureElementE_AttributeValueEnumSolid

Enum value: Solid, which means the border is a single line segment.

Note
This can be used with attribute types fsdk.LRStructureElementE_AttributeTypeBorderStyle , and fsdk.LRStructureElementE_AttributeTypeTBorderStyle .

◆ LRStructureElementE_AttributeValueEnumSquare

fsdk.LRStructureElementE_AttributeValueEnumSquare

Enum value: Square, which means solid square bullet.

Note
This can be used with attribute type fsdk.LRStructureElementE_AttributeTypeListNumbering .

◆ LRStructureElementE_AttributeValueEnumStart

fsdk.LRStructureElementE_AttributeValueEnumStart

Enum value: Start, which means the place for attribute Placement, or the alignment for attributes TextAlign/InlineAlign/RubyAlign.

  • For attribute Placement, this means to be placed so that the start edge of the element's allocation rectangle coincides with that of the nearest enclosing reference area.

  • For attribute TextAlign, this means to be aligned with the start edge.

  • For attribute InlineAlign, this means start edge of each child's allocation rectangle aligned with that of the table cell's content rectangle.

  • For attribute RubyAlign, this means that the content is to be aligned on the start edge in the inlineprogression direction.

Note
This can be used with attribute types fsdk.LRStructureElementE_AttributeTypePlacement , fsdk.LRStructureElementE_AttributeTypeTextAlign , fsdk.LRStructureElementE_AttributeTypeInlineAlign , and fsdk.LRStructureElementE_AttributeTypeRubyAlign .

◆ LRStructureElementE_AttributeValueEnumTbLr

fsdk.LRStructureElementE_AttributeValueEnumTbLr

Enum value: TbLr (PDF 2.0), which means inline progression from top to bottom; block progression from left to right.

Note
This can be used with attribute type fsdk.LRStructureElementE_AttributeTypeWritingMode .

◆ LRStructureElementE_AttributeValueEnumTbRl

fsdk.LRStructureElementE_AttributeValueEnumTbRl

Enum value: TbRl, which means inline progression from top to bottom; block progression from right to left.

Note
This can be used with attribute type fsdk.LRStructureElementE_AttributeTypeWritingMode .

◆ LRStructureElementE_AttributeValueEnumTop

fsdk.LRStructureElementE_AttributeValueEnumTop

Enum value: Top, which means top edge of the page.

Note
This can be used with attribute type fsdk.LRStructureElementE_AttributeTypeAttached .

◆ LRStructureElementE_AttributeValueEnumTV

fsdk.LRStructureElementE_AttributeValueEnumTV

Enum value: tv, which means text-value field.

Note
This can be used with attribute type fsdk.LRStructureElementE_AttributeTypeFieldRole .

◆ LRStructureElementE_AttributeValueEnumUnderline

fsdk.LRStructureElementE_AttributeValueEnumUnderline

Enum value: Underline, which means a line below the text.

Note
This can be used with attribute type fsdk.LRStructureElementE_AttributeTypeTextDecorationType .

◆ LRStructureElementE_AttributeValueEnumUnordered

fsdk.LRStructureElementE_AttributeValueEnumUnordered

Enum value: Unordered (PDF 2.0), which means unordered list with unspecified bullets.

Note
This can be used with attribute type fsdk.LRStructureElementE_AttributeTypeListNumbering .

◆ LRStructureElementE_AttributeValueEnumUpperAlpha

fsdk.LRStructureElementE_AttributeValueEnumUpperAlpha

Enum value: UpperAlpha, which means uppercase letters (A, B, C, ...).

Note
This can be used with attribute type fsdk.LRStructureElementE_AttributeTypeListNumbering .

◆ LRStructureElementE_AttributeValueEnumUpperRoman

fsdk.LRStructureElementE_AttributeValueEnumUpperRoman

Enum value: UpperRoman, which means uppercase roman numerals (I, II, III, IV, ...).

Note
This can be used with attribute type fsdk.LRStructureElementE_AttributeTypeListNumbering .

◆ LRStructureElementE_AttributeValueEnumWarichu

fsdk.LRStructureElementE_AttributeValueEnumWarichu

Enum value: Warichu, which means the RT and associated RP elements are to be formatted as a warichu, following the RB element.

Note
This can be used with attribute type fsdk.LRStructureElementE_AttributeTypeRubyPosition .

◆ LTVVerifierE_VRICreationTime

fsdk.LTVVerifierE_VRICreationTime

Use the creation time of VRI dictionary of a signature.

Note
VRI means "validation-related information".

◆ OptimizerSettingsE_DiscardObjectsAlternateImages

fsdk.OptimizerSettingsE_DiscardObjectsAlternateImages

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.

◆ OptimizerSettingsE_DiscardObjectsJavaScriptActions

fsdk.OptimizerSettingsE_DiscardObjectsJavaScriptActions

Discard all JavaScript actions.

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

◆ PageLabelsE_LowerLetters

fsdk.PageLabelsE_LowerLetters

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.

◆ PageLabelsE_None

fsdk.PageLabelsE_None

Page label style: no numbering style.

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

◆ PageLabelsE_UpperLetters

fsdk.PageLabelsE_UpperLetters

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.

◆ PDFDocE_ImportFlagShareStream

fsdk.PDFDocE_ImportFlagShareStream

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.

◆ PDFDocE_PermAnnotForm

fsdk.PDFDocE_PermAnnotForm

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

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

◆ PDFDocE_PermAssemble

fsdk.PDFDocE_PermAssemble

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

◆ PDFDocE_PermExtract

fsdk.PDFDocE_PermExtract

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 fsdk.PDFDocE_PermExtractAccess .

◆ PDFDocE_PermExtractAccess

fsdk.PDFDocE_PermExtractAccess

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.

◆ PDFDocE_PermFillForm

fsdk.PDFDocE_PermFillForm

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

◆ PDFDocE_PermModify

fsdk.PDFDocE_PermModify

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 fsdk.PDFDocE_PermAnnotForm , fsdk.PDFDocE_PermFillForm and fsdk.PDFDocE_PermAssemble .

◆ PDFDocE_PermPrint

fsdk.PDFDocE_PermPrint

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 fsdk.PDFDocE_PermPrintHigh together.

◆ PDFDocE_PermPrintHigh

fsdk.PDFDocE_PermPrintHigh

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

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

◆ PDFDocE_SaveFlagIncremental

fsdk.PDFDocE_SaveFlagIncremental

Save document incrementally.

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

◆ PDFDocE_SaveFlagLinearized

fsdk.PDFDocE_SaveFlagLinearized

Save document as a linearized file.

This should be used alone and cannot be used with other saving flags except fsdk.PDFDocE_SaveFlagNoUpdatingMetadataDateTime .. This can only be used for function fsdk.PDFDoc.SaveAs or fsdk.PDFDoc.StartSaveAs .

◆ PDFDocE_SaveFlagNoOriginal

fsdk.PDFDocE_SaveFlagNoOriginal

Save document without original data or unchanged objects.

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

◆ PDFDocE_SaveFlagNormal

fsdk.PDFDocE_SaveFlagNormal

Save document normally, without using any special flag.

This can only be combined with flag fsdk.PDFDocE_SaveFlagNoUpdatingMetadataDateTime .

◆ PDFDocE_SaveFlagNoUpdatingMetadataDateTime

fsdk.PDFDocE_SaveFlagNoUpdatingMetadataDateTime

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 fsdk.PDFDoc.SaveAs and fsdk.PDFDoc.StartSaveAs .

◆ PDFDocE_SaveFlagRemoveRedundantObjects

fsdk.PDFDocE_SaveFlagRemoveRedundantObjects

Save document with removing redundant PDF objects.

This can be used alone or be combined with fsdk.PDFDocE_SaveFlagNoOriginal , fsdk.PDFDocE_SaveFlagXRefStream or fsdk.PDFDocE_SaveFlagNoUpdatingMetadataDateTime . This can only be used for function fsdk.PDFDoc.SaveAs or fsdk.PDFDoc.StartSaveAs .

◆ PDFDocE_SaveFlagXRefStream

fsdk.PDFDocE_SaveFlagXRefStream

Save document by using XRef stream.

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

◆ PDFPageE_ArtBox

fsdk.PDFPageE_ArtBox

Art Box for page boundary.

The intended dimensions of a finished page after trimming.

◆ PDFPageE_BleedBox

fsdk.PDFPageE_BleedBox

Bleed Box for page boundary.

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

◆ PDFPageE_CropBox

fsdk.PDFPageE_CropBox

Crop Box for page boundary.

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

◆ PDFPageE_MediaBox

fsdk.PDFPageE_MediaBox

Media Box for page boundary.

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

◆ PDFPageE_TrimBox

fsdk.PDFPageE_TrimBox

Trim Box for page boundary.

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

◆ PortfolioE_InitialViewDetailMode

fsdk.PortfolioE_InitialViewDetailMode

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.

◆ PortfolioE_InitialViewTileMode

fsdk.PortfolioE_InitialViewTileMode

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.

◆ ReflowPageE_NoTruncate

fsdk.ReflowPageE_NoTruncate

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.

◆ RenditionActionE_OpTypeAssociate

fsdk.RenditionActionE_OpTypeAssociate

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.

◆ SignatureE_FieldMDPActionExclude

fsdk.SignatureE_FieldMDPActionExclude

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

Note
"Specified form fields" can be get/set by functions fsdk.Signature.GetFieldMDPActionFields and Signature::SetFieldMDPActionFields. Please refer to these functions for more details.

◆ SignatureE_FieldMDPActionInclude

fsdk.SignatureE_FieldMDPActionInclude

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

Note
"Specified form fields" can be get/set by functions fsdk.Signature.GetFieldMDPActionFields and Signature::SetFieldMDPActionFields. Please refer to these functions for more details.

◆ SignatureE_LabelNameDN

fsdk.SignatureE_LabelNameDN

Signature key name for distinguish name.

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

◆ SignatureE_LabelNameLocation

fsdk.SignatureE_LabelNameLocation

Signature label name for location.

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

◆ SignatureE_LabelNameProducer

fsdk.SignatureE_LabelNameProducer

Signature key name for producer name.

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

◆ SignatureE_LabelNameReason

fsdk.SignatureE_LabelNameReason

Signature label name for reason.

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

◆ SignatureE_LabelNameSigner

fsdk.SignatureE_LabelNameSigner

Signature label name for signer.

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

◆ SignatureE_LabelNameSignTime

fsdk.SignatureE_LabelNameSignTime

Signature label name for sign time.

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

◆ SplitFileResultE_SplitFileErrAccessDeny

fsdk.SplitFileResultE_SplitFileErrAccessDeny

The state is failed due to file access being denied.

@detail If the PDF document to be split is denied access, then this state will be returned in the file split result.The state is failed due to file access being denied.

◆ SplitFileResultE_SplitFileErrFileExist

fsdk.SplitFileResultE_SplitFileErrFileExist

The state is failed due to file exist.

@detail If a PDF document generated by splitting already exists, and the value of is_overwrite in the object of SplitOutputSettingData is set to false, then this state will be returned in the file split result.

◆ SplitFileResultE_SplitFileErrSizeTooSmall

fsdk.SplitFileResultE_SplitFileErrSizeTooSmall

The state is failed due to file size being too small.

@detail If the file size of the PDF document to be split is smaller than the value of parameter max_file_size in function , then this state will be returned in the file split result.

◆ SubmitFormActionE_FlagExportFormat

fsdk.SubmitFormActionE_FlagExportFormat

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

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

◆ SubmitFormActionE_FlagGetMethod

fsdk.SubmitFormActionE_FlagGetMethod

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

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

◆ SubmitFormActionE_FlagIncludeAnnotations

fsdk.SubmitFormActionE_FlagIncludeAnnotations

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.

◆ SubmitFormActionE_FlagIncludeAppendSaves

fsdk.SubmitFormActionE_FlagIncludeAppendSaves

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.

◆ SubmitFormActionE_FlagIncludeNoValueFields

fsdk.SubmitFormActionE_FlagIncludeNoValueFields

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

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

◆ Word2PDFSettingDataE_ConvertBookmarkOptionUseHeadings

fsdk.Word2PDFSettingDataE_ConvertBookmarkOptionUseHeadings

Create bookmarks in converted PDF file by using each heading of Word document.

Here, "Word heading" includes only headings within the main document and text boxes not within headers, footers, endnotes, footnotes, or comments.

◆ Word2PDFSettingDataE_ConvertBookmarkOptionUseWordBookmark

fsdk.Word2PDFSettingDataE_ConvertBookmarkOptionUseWordBookmark

Create bookmarks in converted PDF file by using each bookmarks of Word document.

Here, "Word bookmark" includes all bookmarks except those contained within headers and footers.