|
Foxit PDF SDK
|
Foxit PDF SDK namespace. More...
Variables | |
| const | e_AlignmentCenter |
| Center alignment. | |
| const | e_AlignmentLeft |
| Enumeration for alignment (horizontal). More... | |
| const | e_AlignmentRight |
| Right alignment. | |
| const | e_CheckStateFailed |
| Check state : failed. | |
| const | e_CheckStateHumanCheck |
| Check state : human check. | |
| const | e_CheckStateHumanFailed |
| Check state : human failed. | |
| const | e_CheckStateHumanPassed |
| Check state : human passed. | |
| const | e_CheckStateLast |
| Check state : last. | |
| const | e_CheckStateNone |
| Enumeration for check state. More... | |
| const | e_CheckStatePassed |
| Check state : passed. | |
| const | e_CheckStateSkipped |
| Check state : skipped. | |
| const | e_ColorSpaceCalGray |
| Color space: CalGray. (1 component, A) | |
| const | e_ColorSpaceCalRGB |
| Color space: CalRGB. (3 components, A, B, C) | |
| const | e_ColorSpaceDeviceCMYK |
| Color space: DeviceCMYK. (4 components, C, M, Y, K) | |
| const | e_ColorSpaceDeviceGray |
| Color space: DeviceGray. (1 component, gray) | |
| const | e_ColorSpaceDeviceN |
| Color space: DeviceN. | |
| const | e_ColorSpaceDeviceRGB |
| Color space: DeviceRGB. (3 components, R, G, B) | |
| const | e_ColorSpaceICCBasedDeviceCMYK |
| Color space: ICCBased DeviceCMYK. (4 components, C, M, Y, K) | |
| const | e_ColorSpaceICCBasedDeviceGray |
| Color space: ICCBased DeviceGray. (1 component, gray) | |
| const | e_ColorSpaceICCBasedDeviceRGB |
| Color space: ICCBased DeviceRGB. (3 components, R, G, B) | |
| const | e_ColorSpaceInvalid |
| Enumeration for color space. More... | |
| const | e_ColorSpaceLab |
| Color space: Lab. (3 components, A, B, C) | |
| const | e_ColorSpacePattern |
| Color space: Pattern. | |
| const | e_ColorSpaceSeparation |
| Color space: Separation. | |
| const | e_ContentTypeAnnot |
| Annotation item type. | |
| const | e_ContentTypeAnnotGroup |
| Annotation group item type. | |
| const | e_ContentTypeContainer |
| Container item type. | |
| const | e_ContentTypeDoc |
| Doc item type. | |
| const | e_ContentTypeEmptyObject |
| Empty object item type. | |
| const | e_ContentTypeFormXObject |
| Form XObject item type. | |
| const | e_ContentTypeImageObject |
| Image object item type. | |
| const | e_ContentTypePage |
| Page item type. | |
| const | e_ContentTypePathObject |
| Path object item type. | |
| const | e_ContentTypeShadingObject |
| Shading object item type. | |
| const | e_ContentTypeTextGroup |
| Text group item type. | |
| const | e_ContentTypeTextObject |
| Text object item type. | |
| const | e_ContentTypeUnknown |
| Enumeration for content type. More... | |
| const | e_ErrCanNotConnectToServer |
| (For ConnectedPDF only) Cannot connect to ConnectedPDF server. | |
| const | e_ErrCanNotGetACL |
| (For ConnectedPDF only) Cannot get the ACL from ConnectedPDF server. | |
| const | e_ErrCanNotGetClientID |
| (For ConnectedPDF only) Cannot get client ID from ConnectedPDF server. | |
| const | e_ErrCanNotGetUserToken |
| (For ConnectedPDF only) Cannot get user token from ConnectedPDF server. | |
| const | e_ErrCanNotRemoveSecurityFromServer |
| (For ConnectedPDF only) Cannot remove the security from ConnectedPDF server. | |
| const | e_ErrCanNotSetACL |
| (For ConnectedPDF only) Cannot set the ACL to ConnectedPDF server. | |
| const | e_ErrCanNotUploadCDRMInfo |
| (For ConnectedPDF only) Cannot upload ConnectedPDF DRM document info to ConnectedPDF server. | |
| const | e_ErrCanNotUploadDocInfo |
| (For ConnectedPDF only) Cannot upload ConnectedPDF document info to ConnectedPDF server. | |
| const | e_ErrCertificate |
| Certificate error: PDF document is encrypted by digital certificate but current user does not have the correct certificate. | |
| const | e_ErrComplianceEngineInitFailed |
| (For compliance only) Fail to initialize compliance engine. | |
| const | e_ErrComplianceEngineInvalidUnlockCode |
| (For compliance only) Invalid unlock code is used to initialize compliance engine. | |
| const | e_ErrComplianceEngineNotInit |
| (For compliance only) Compliance engine has not been initialized successfully. | |
| const | e_ErrComplianceResourceFile |
| (For compliance only) Compliance resource file(s) cannot be found or opened. Please check if compliance resource folder and files in this folder are valid. | |
| const | e_ErrConflict |
| New data conflicts with existed data. | |
| const | e_ErrDataNotReady |
| Data is not ready. Usually this is used as an exception error code when loading document in asynchronous way. | |
| const | e_ErrDefaultTimeStampServer |
| Cannot use current default time stamp server. Please check if default time stamp server can be used. | |
| const | e_ErrDeviceLimitation |
| (For ConnectedPDF only) Current device is limited to open the ConnectedPDF DRM document. | |
| const | e_ErrDiskFull |
| (For OCR only) Not enough disk space. | |
| const | e_ErrExcelHasNoContent |
| (For Excel-to-PDF conversion only) Excel document does not have any content so it cannot be converted to PDF file. | |
| const | e_ErrFile |
| File cannot be found or could not be opened. | |
| const | e_ErrFilePathNotExist |
| File or folder path does not exist. | |
| const | e_ErrFormat |
| Format is invalid. For files, this may also mean that file is corrupted. | |
| const | e_ErrFXOCREngineNotInit |
| (For FXOCR only) FXOCR Engine has not been initialized successfully. | |
| const | e_ErrHandle |
| Error handle. | |
| const | e_ErrInvalidACL |
| (For ConnectedPDF only) Input ACL is invalid. | |
| const | e_ErrInvalidClientID |
| (For ConnectedPDF only) Input client ID is invalid. | |
| const | e_ErrInvalidData |
| Data of current object is invalid. | |
| const | e_ErrInvalidLicense |
| Invalid license is used to initialize Foxit PDF SDK library. | |
| const | e_ErrInvalidRegex |
| Invalid regular expression. | |
| const | e_ErrInvalidState |
| Invalid or incorrect state. | |
| const | e_ErrInvalidType |
| The type of input object or current object is invalid. | |
| const | e_ErrInvalidUserToken |
| (For ConnectedPDF only) Input user token is invalid. | |
| const | e_ErrInvalidWrapper |
| (For ConnectedPDF only) The input ConnectedPDF DRM wrapper document is invalid. | |
| const | e_ErrIsAlreadyCDRM |
| (For ConnectedPDF only) Loaded document is already a ConnectedPDF DRM document. | |
| const | e_ErrIsAlreadyCPDF |
| (For ConnectedPDF only) Loaded document is already a ConnectedPDF document. | |
| const | e_ErrLibreofficeEngineNotFound |
| (For Office-to-PDF conversion only) Libre office engine is not found. | |
| const | e_ErrLTVCannotCheckDTS |
| (For LTV only) Fail to check DTS. | |
| const | e_ErrLTVCannotLoadDSS |
| (For LTV only) Fail to load DSS. | |
| const | e_ErrLTVCannotLoadDTS |
| (For LTV only) Fail to load DTS. | |
| const | e_ErrLTVCannotSwitchVersion |
| (For LTV only) Fail to switch PDF verion. | |
| const | e_ErrLTVRevocationCallbackNotSet |
| (For LTV only) Revocation callback for LTV has not been set. | |
| const | e_ErrLTVVerifyModeNotSet |
| (For LTV only) LTV verify mode has not been set. | |
| const | e_ErrMIPCreateProtectionHandlerFailed |
| MIP engine: create protection handler failed. | |
| const | e_ErrMIPGetExtendedLabelInfoByIdFailed |
| MIP engine: get extended label information by id failed. | |
| const | e_ErrMIPProtectionEngineInitFailed |
| MIP engine: add upe engine failed. | |
| const | e_ErrMIPUPEEngineInitFailed |
| MIP engine: add upe engine failed. | |
| const | e_ErrNeedSigned |
| (For signature only) The signature being operated needs to be signed. | |
| const | e_ErrNoAccessibilityModuleRight |
| No "Accessibility" module right. | |
| const | e_ErrNoAdvEditModuleRight |
| No "AdvEdit" module right. | |
| const | e_ErrNoComparisonModuleRight |
| No "Comparison" module right. | |
| const | e_ErrNoComplianceModuleRight |
| No "Compliance" module right. | |
| const | e_ErrNoConnectedPDFModuleRight |
| No "ConnectedPDF" module right. | |
| const | e_ErrNoConversionModuleRight |
| No "Conversion" module right. | |
| const | e_ErrNoDocumentPermission |
| No document permission to operate. | |
| const | e_ErrNoDWG2PDFModuleRight |
| No "DWG2PDF" module right. | |
| const | e_ErrNoImageObject |
| (For PDF Optimizer PDF) There are some objects not image type. | |
| const | e_ErrNoLayoutRecognitionModuleRight |
| No "LayoutRecognition" module right. | |
| const | e_ErrNoMD2PDFModileRight |
| No "MD2PDF" module right. | |
| const | e_ErrNoMicroOfficeInstalled |
| (For Office-to-PDF conversion only) No Microsoft Office is installed in current system. | |
| const | e_ErrNoOCRModuleRight |
| No "OCR" module right. | |
| const | e_ErrNoOffice2PDFModuleRight |
| No "Office2PDF" module right. | |
| const | e_ErrNoOptimizerModuleRight |
| No "Optimizer" module right. | |
| const | e_ErrNoPDF2MDModuleRight |
| No "PDF2MD" module right. | |
| const | e_ErrNoPDF2OfficeModuleRight |
| No "PDF2Office" module right. | |
| const | e_ErrNoPrint2PDFModuleRight |
| No "Print2PDF" module right. | |
| const | e_ErrNoRedactionModuleRight |
| No "Redaction" module right. | |
| const | e_ErrNoRights |
| (For ConnectedPDF only) Current user has no right to open the ConnectedPDF DRM document. | |
| const | e_ErrNoRMSModuleRight |
| No "RMS" module right. | |
| const | e_ErrNoTableMakerModuleRight |
| No "TableMaker" module right. | |
| const | e_ErrNotCDRM |
| (For ConnectedPDF only) The loaded document is not a ConnectedPDF DRM document. | |
| const | e_ErrNotFound |
| Expected data or object is not found. | |
| const | e_ErrNotLoaded |
| Current object has not been loaded yet. | |
| const | e_ErrNotMatchFont |
| Not match font . | |
| const | e_ErrNotParsed |
| Content has not been parsed yet. Usually, this represents PDF page has not been parsed yet. | |
| const | e_ErrNoXFAModuleRight |
| No "XFA" module right. | |
| const | e_ErrOCREngineNotInit |
| (For OCR only) OCR engine has not been initialized successfully. | |
| const | e_ErrOCRTrialIsEnd |
| (For OCR only) The trial for OCR module is end. | |
| const | e_ErrODAEngineNotFound |
| (For DWG-to-PDF conversion only) ODA engine is not found. | |
| const | e_ErrOfficeComNotInit |
| (For Office-to-PDF conversion only) Office COM has not been initialized successfully. | |
| const | e_ErrOutOfMemory |
| Out-of-memory error occurs. | |
| const | e_ErrParam |
| Parameter error: value of any input parameter for a function is invalid. | |
| const | e_ErrPassword |
| Invalid password. Usually, this error may occur when loading a PDF document with password. When meet this, user should load document again with correct password. | |
| const | e_ErrResponseDataError |
| (For ConnectedPDF only) There is some error in response data. | |
| const | e_ErrRightsExpired |
| (For ConnectedPDF only) The rights of Current user has expired. | |
| const | e_ErrSecurityHandler |
| PDF document is encrypted by some unsupported security handler. | |
| const | e_ErrSuccess |
| Success, and no error occurs. | |
| const | e_ErrTimeout |
| (For HTML2PDF only)Occuring timeout during loading web page. | |
| const | e_ErrTimeStampServerMgrNoDefaltServer |
| No default server has been set to time stamp server manager yet. | |
| const | e_ErrTimeStampServerMgrNotInit |
| Time stamp server manager has not been initialized successfully. | |
| const | e_ErrUnknown |
| Any unknown error occurs. | |
| const | e_ErrUnknownState |
| Any unknown state occurs. | |
| const | e_ErrUnsupported |
| Some types are not supported. | |
| const | e_ErrURLInBlackList |
| (For converting html to pdf only) The converted URL is on blacklist. | |
| const | e_ErrWPSEngineNotFound |
| (For Office-to-PDF conversion only) WPS office engine is not found. | |
| const | e_ErrXFALoadError |
| XFA loading error. | |
| const | e_FileFormatTypeFDF |
| Enumeration for file format type. More... | |
| const | e_FileFormatTypeHTML |
| File format type: HTML. | |
| const | e_FileFormatTypePDF |
| File format type: PDF. | |
| const | e_FileFormatTypeTXT |
| File format type: TXT. | |
| const | e_FileFormatTypeXDP |
| File format type: XDP. | |
| const | e_FileFormatTypeXFD |
| File format type: XFD. | |
| const | e_FileFormatTypeXFDF |
| File format type: XFDF. | |
| const | e_FileFormatTypeXML |
| File format type: XML. | |
| const | e_FillModeAlternate |
| Alternate fill mode, in which the system fills this area between odd-numbered and even-numbered polygon sides on each scan line. | |
| const | e_FillModeNone |
| Enumeration for filling mode type, mainly for path graphics object. More... | |
| const | e_FillModeWinding |
| Winding fill mode, in which the system uses a direction in which a figure is drawn to determine whether to fill an area. | |
| const | e_LocaleIDFrance |
| Locale ID for country: France. | |
| const | e_LocaleIDGermany |
| Locale ID for country: Germany. | |
| const | e_LocaleIDHongKong |
| Locale ID for region: HongKong. | |
| const | e_LocaleIDItaly |
| Locale ID for country: Italy. | |
| const | e_LocaleIDJapan |
| Locale ID for country: Japan. | |
| const | e_LocaleIDKorea |
| Locale ID for country: Korea. | |
| const | e_LocaleIDNetherlands |
| Locale ID for country: Netherlands. | |
| const | e_LocaleIDTaiwan |
| Locale ID for region: Taiwan. | |
| const | e_LocaleIDUnspecified |
| Enumeration for locale ID. More... | |
| const | e_ModuleName3D |
| Name for moudle "3D". | |
| const | e_ModuleNameAccessibility |
| Name for module "Accessibility". | |
| const | e_ModuleNameAdvEdit |
| Name for module "AdvEdit". | |
| const | e_ModuleNameComparison |
| Name for module "Comparison". | |
| const | e_ModuleNameCompliance |
| Name for module "Compliance". | |
| const | e_ModuleNameConnectedPDF |
| Enumeration for module name which is used in license information. More... | |
| const | e_ModuleNameConversion |
| Name for module "Conversion". | |
| const | e_ModuleNameDWG2PDF |
| Name for module "DWG2PDF". | |
| const | e_ModuleNameLayoutRecognition |
| (Reserved, currently, this module is not provided) Name for module "LayoutRecognition". | |
| const | e_ModuleNameMD2PDF |
| Name for module "MD2PDF". | |
| const | e_ModuleNameOCR |
| Name for module "OCR". | |
| const | e_ModuleNameOffice2PDF |
| Name for module "Office2PDF". | |
| const | e_ModuleNameOptimizer |
| Name for module "Optimizer". | |
| const | e_ModuleNamePDF2MD |
| Name for module "PDF2MD". | |
| const | e_ModuleNamePDF2Office |
| Name for module "PDF2Office". | |
| const | e_ModuleNamePrint2PDF |
| Name for module "Print2PDF". | |
| const | e_ModuleNameRedaction |
| Name for module "Redaction". | |
| const | e_ModuleNameRMS |
| Name for module "RMS". | |
| const | e_ModuleNameTableMaker |
| Name for module "TableMaker". | |
| const | e_ModuleNameXFA |
| Name for module "XFA". | |
| const | e_PosBottomCenter |
| Position: bottom center. | |
| const | e_PosBottomLeft |
| Position: bottom left. | |
| const | e_PosBottomRight |
| Position: bottom right. | |
| const | e_PosCenter |
| Position: center. | |
| const | e_PosCenterLeft |
| Position center left. | |
| const | e_PosCenterRight |
| Position: center right. | |
| const | e_PosTopCenter |
| Position: top center. | |
| const | e_PosTopLeft |
| Enumeration for watermark position in a PDF page. More... | |
| const | e_PosTopRight |
| Position: top right. | |
| const | e_Rotation0 |
| Enumeration for rotation. More... | |
| const | e_Rotation180 |
| Rotate 180 degrees in clockwise direction. | |
| const | e_Rotation270 |
| Rotate 270 degrees in clockwise direction. | |
| const | e_Rotation90 |
| Rotate 90 degrees in clockwise direction. | |
| const | e_RotationPointCenter |
| Enumeration for rotation point options. More... | |
| const | e_RotationPointLeftBottom |
| Rotate the text block based on the left-bottom point of the rectangle. | |
| const | e_RotationPointLeftTop |
| Rotate the text block based on the left-top point of the rectangle. | |
| const | e_RotationPointRightBottom |
| Rotate the text block based on the right-bottom point of the rectangle. | |
| const | e_RotationPointRightTop |
| Rotate the text block based on the right-top point of the rectangle. | |
| const | e_RotationUnknown |
| Unknown rotation. | |
| const | e_RuleTypeAlternateTextAnnot |
| Rule: Alternate text hide annotation. | |
| const | e_RuleTypeAlternateTextContent |
| Rule: Alternate text has content. | |
| const | e_RuleTypeAlternateTextFigures |
| Rule: Alternate text for figures. | |
| const | e_RuleTypeAlternateTextNested |
| Rule: Alternate text not nested. | |
| const | e_RuleTypeAlternateTextOther |
| Rule: Alternate text for other elements. | |
| const | e_RuleTypeDocBookmark |
| Rule: Document bookmark. | |
| const | e_RuleTypeDocColorcontrast |
| Rule: Document color contrast. | |
| const | e_RuleTypeDocImageOnly |
| Rule: Document is pure image. | |
| const | e_RuleTypeDocLang |
| Rule: Document language specified. | |
| const | e_RuleTypeDocPermission |
| Enumeration for rule type. More... | |
| const | e_RuleTypeDocStructreeOrder |
| Rule: Document structure tree order. | |
| const | e_RuleTypeDocTagged |
| Rule: Document is tagged. | |
| const | e_RuleTypeDocTitle |
| Rule: Document title. | |
| const | e_RuleTypeFormFieldAltText |
| Rule: Form field alternate text. | |
| const | e_RuleTypeFormFieldTagged |
| Rule: Form field is tagged. | |
| const | e_RuleTypeHeading |
| Rule: Heading proper nest. | |
| const | e_RuleTypeListItems |
| Rule: List items proper used. | |
| const | e_RuleTypeListLblAndLbody |
| Rule: List label and LBody proper used. | |
| const | e_RuleTypePageAnnotTagged |
| Rule: Page annotation is tagged. | |
| const | e_RuleTypePageContentTagged |
| Rule: Page content is tagged. | |
| const | e_RuleTypePageFlickering |
| Rule: Page flickering. | |
| const | e_RuleTypePageFontEncoding |
| Rule: Page font encoding. | |
| const | e_RuleTypePageLink |
| Rule: Page link. | |
| const | e_RuleTypePageMultiMediaTagged |
| Rule: Page multimedia object is tagged. | |
| const | e_RuleTypePageResponses |
| Rule: Page responses. | |
| const | e_RuleTypePageScript |
| Rule: Page script. | |
| const | e_RuleTypePageTabOrder |
| Rule: Page tab order. | |
| const | e_RuleTypeTableHeaders |
| Rule: Table headers exist. | |
| const | e_RuleTypeTableRegularity |
| Rule: Table regularity (span correct). | |
| const | e_RuleTypeTableRows |
| Rule: Table rows proper used. | |
| const | e_RuleTypeTableSummary |
| Rule: Table summary. | |
| const | e_RuleTypeTableThAndTd |
| Rule: Table TH and TD proper used. | |
Foxit PDF SDK namespace.
| const FSDK.e_AlignmentLeft |
Enumeration for alignment (horizontal).
Values of this enumeration should be used alone.Left alignment.
| const FSDK.e_CheckStateNone |
Enumeration for check state.
Values of this enumeration should be used alone.Check state : none.
| const FSDK.e_ColorSpaceInvalid |
Enumeration for color space.
Values of this enumeration should be used alone.Color space: Invalid.
| const FSDK.e_ContentTypeUnknown |
Enumeration for content type.
This enumeration is used to specify the type of content in the reading order and content tree. Values of this enumeration should be used alone.Unknown content.
| const FSDK.e_FileFormatTypeFDF |
Enumeration for file format type.
Values of this enumeration can be used alone.File format type: FDF.
| const FSDK.e_FillModeNone |
Enumeration for filling mode type, mainly for path graphics object.
Values of this enumeration should be used alone.Fill mode: none.
| const FSDK.e_LocaleIDUnspecified |
Enumeration for locale ID.
Values of this enumeration can be used alone.Locale ID: Unspecified, used when locale is not specified.
| const FSDK.e_ModuleNameConnectedPDF |
Enumeration for module name which is used in license information.
Values of this enumeration should be used alone.(Reserved, currently, this module is not provided) Name for module "ConnectedPDF".
| const FSDK.e_PosTopLeft |
Enumeration for watermark position in a PDF page.
Values of this enumeration should be used alone.Position: top left.
| const FSDK.e_Rotation0 |
Enumeration for rotation.
Values of this enumeration should be used alone.No rotation.
| const FSDK.e_RotationPointCenter |
Enumeration for rotation point options.
Values of this enumeration indicate the reference point for rotation. Each value should be used separately.Rotate the text block based on the center point.
| const FSDK.e_RuleTypeDocPermission |
Enumeration for rule type.
Values of this enumeration should be used alone.Rule: Document permission.