Foxit PDF SDK
foxit.common Namespace Reference

Common namespace. More...

Namespaces

namespace  file
 File namespace.
 
namespace  fxcrt
 Data type and callback namespace.
 

Classes

class  Barcode
 
class  Base
 
class  Bitmap
 
class  Codec
 
class  Color
 
class  ColorSpace
 
class  DateTime
 
class  DocEventCallback
 
class  Font
 
class  FontMapperCallback
 
class  FontMapResult
 
class  GraphState
 
class  Image
 
class  Library
 
class  NotifierCallback
 
class  Path
 
class  PathArray
 
class  Progressive
 
class  Range
 
class  RenderConfig
 
class  Renderer
 
class  StringArray
 
class  WStringArray
 

Enumerations

enum  Alignment { Alignment.e_AlignmentLeft = 0, Alignment.e_AlignmentCenter = 1, Alignment.e_AlignmentRight = 2 }
 Enumeration for alignment (horizontal). More...
 
enum  ColorSpaceType {
  ColorSpaceType.e_ColorSpaceInvalid = 0, ColorSpaceType.e_ColorSpaceDeviceGray = 1, ColorSpaceType.e_ColorSpaceDeviceRGB = 2, ColorSpaceType.e_ColorSpaceDeviceCMYK = 3,
  ColorSpaceType.e_ColorSpaceCalGray = 4, ColorSpaceType.e_ColorSpaceCalRGB = 5, ColorSpaceType.e_ColorSpaceLab = 6, ColorSpaceType.e_ColorSpaceSeparation = 8,
  ColorSpaceType.e_ColorSpaceDeviceN = 9, ColorSpaceType.e_ColorSpacePattern = 11, ColorSpaceType.e_ColorSpaceICCBasedDeviceGray = 12, ColorSpaceType.e_ColorSpaceICCBasedDeviceRGB = 13,
  ColorSpaceType.e_ColorSpaceICCBasedDeviceCMYK = 14
}
 Enumeration for color space. More...
 
enum  ErrorCode {
  ErrorCode.e_ErrSuccess = 0, ErrorCode.e_ErrFile = 1, ErrorCode.e_ErrFormat = 2, ErrorCode.e_ErrPassword = 3,
  ErrorCode.e_ErrHandle = 4, ErrorCode.e_ErrCertificate = 5, ErrorCode.e_ErrUnknown = 6, ErrorCode.e_ErrInvalidLicense = 7,
  ErrorCode.e_ErrParam = 8, ErrorCode.e_ErrUnsupported = 9, ErrorCode.e_ErrOutOfMemory = 10, ErrorCode.e_ErrSecurityHandler = 11,
  ErrorCode.e_ErrNotParsed = 12, ErrorCode.e_ErrNotFound = 13, ErrorCode.e_ErrInvalidType = 14, ErrorCode.e_ErrConflict = 15,
  ErrorCode.e_ErrUnknownState = 16, ErrorCode.e_ErrDataNotReady = 17, ErrorCode.e_ErrInvalidData = 18, ErrorCode.e_ErrXFALoadError = 19,
  ErrorCode.e_ErrNotLoaded = 20, ErrorCode.e_ErrInvalidState = 21, ErrorCode.e_ErrNotCDRM = 22, ErrorCode.e_ErrCanNotConnectToServer = 23,
  ErrorCode.e_ErrInvalidUserToken = 24, ErrorCode.e_ErrNoRights = 25, ErrorCode.e_ErrRightsExpired = 26, ErrorCode.e_ErrDeviceLimitation = 27,
  ErrorCode.e_ErrCanNotRemoveSecurityFromServer = 28, ErrorCode.e_ErrCanNotGetACL = 29, ErrorCode.e_ErrCanNotSetACL = 30, ErrorCode.e_ErrIsAlreadyCPDF = 31,
  ErrorCode.e_ErrIsAlreadyCDRM = 32, ErrorCode.e_ErrCanNotUploadDocInfo = 33, ErrorCode.e_ErrCanNotUploadCDRMInfo = 34, ErrorCode.e_ErrInvalidWrapper = 35,
  ErrorCode.e_ErrCanNotGetClientID = 36, ErrorCode.e_ErrCanNotGetUserToken = 37, ErrorCode.e_ErrInvalidACL = 38, ErrorCode.e_ErrInvalidClientID = 39,
  ErrorCode.e_ErrOCREngineNotInit = 40, ErrorCode.e_ErrDiskFull = 41, ErrorCode.e_ErrOCRTrialIsEnd = 42, ErrorCode.e_ErrFilePathNotExist = 43,
  ErrorCode.e_ErrComplianceEngineNotInit = 44, ErrorCode.e_ErrComplianceEngineInvalidUnlockCode = 45, ErrorCode.e_ErrComplianceEngineInitFailed = 46, ErrorCode.e_ErrTimeStampServerMgrNotInit = 47,
  ErrorCode.e_ErrLTVVerifyModeNotSet = 48, ErrorCode.e_ErrLTVRevocationCallbackNotSet = 49, ErrorCode.e_ErrLTVCannotSwitchVersion = 50, ErrorCode.e_ErrLTVCannotCheckDTS = 51,
  ErrorCode.e_ErrLTVCannotLoadDSS = 52, ErrorCode.e_ErrLTVCannotLoadDTS = 53, ErrorCode.e_ErrNeedSigned = 54, ErrorCode.e_ErrComplianceResourceFile = 55,
  ErrorCode.e_ErrTimeStampServerMgrNoDefaltServer = 56, ErrorCode.e_ErrDefaultTimeStampServer = 57, ErrorCode.e_ErrNoConnectedPDFModuleRight = 58, ErrorCode.e_ErrNoXFAModuleRight = 59,
  ErrorCode.e_ErrNoRedactionModuleRight = 60, ErrorCode.e_ErrNoRMSModuleRight = 61, ErrorCode.e_ErrNoOCRModuleRight = 62, ErrorCode.e_ErrNoComparisonModuleRight = 63,
  ErrorCode.e_ErrNoComplianceModuleRight = 64, ErrorCode.e_ErrNoOptimizerModuleRight = 65, ErrorCode.e_ErrNoConversionModuleRight = 66, ErrorCode.e_ErrOfficeComNotInit = 67,
  ErrorCode.e_ErrNoMicroOfficeInstalled = 68, ErrorCode.e_ErrExcelHasNoContent = 69, ErrorCode.e_ErrNoLayoutRecognitionModuleRight = 70, ErrorCode.e_ErrWPSEngineNotFound = 71
}
 Enumeration for error code. More...
 
enum  FileFormatType {
  FileFormatType.e_FileFormatTypeFDF = 0, FileFormatType.e_FileFormatTypeXFDF = 1, FileFormatType.e_FileFormatTypeHTML = 2, FileFormatType.e_FileFormatTypeXDP = 3,
  FileFormatType.e_FileFormatTypeXML = 4, FileFormatType.e_FileFormatTypeXFD = 5, FileFormatType.e_FileFormatTypePDF = 6, FileFormatType.e_FileFormatTypeTXT = 7
}
 Enumeration for file format type. More...
 
enum  FillMode { FillMode.e_FillModeNone = 0, FillMode.e_FillModeAlternate = 1, FillMode.e_FillModeWinding = 2 }
 Enumeration for filling mode type, mainly for path graphics object. More...
 
enum  LocaleID {
  LocaleID.e_LocaleIDUnspecified = 0, LocaleID.e_LocaleIDHongKong = 1, LocaleID.e_LocaleIDTaiwan = 2, LocaleID.e_LocaleIDNetherlands = 3,
  LocaleID.e_LocaleIDFrance = 4, LocaleID.e_LocaleIDGermany = 5, LocaleID.e_LocaleIDItaly = 6, LocaleID.e_LocaleIDKorea = 7,
  LocaleID.e_LocaleIDJapan = 8
}
 Enumeration for locale ID. More...
 
enum  ModuleName {
  ModuleName.e_ModuleNameConnectedPDF = 1, ModuleName.e_ModuleNameXFA = 2, ModuleName.e_ModuleNameRedaction = 3, ModuleName.e_ModuleNameRMS = 4,
  ModuleName.e_ModuleNameOCR = 5, ModuleName.e_ModuleNameComparison = 6, ModuleName.e_ModuleNameCompliance = 7, ModuleName.e_ModuleNameOptimizer = 8,
  ModuleName.e_ModuleNameConversion = 9, ModuleName.e_ModuleNameLayoutRecognition = 10
}
 Enumeration for module name which is used in license information. More...
 
enum  Position {
  Position.e_PosTopLeft = 0, Position.e_PosTopCenter = 1, Position.e_PosTopRight = 2, Position.e_PosCenterLeft = 3,
  Position.e_PosCenter = 4, Position.e_PosCenterRight = 5, Position.e_PosBottomLeft = 6, Position.e_PosBottomCenter = 7,
  Position.e_PosBottomRight = 8
}
 Enumeration for watermark position in a PDF page. More...
 
enum  Rotation {
  Rotation.e_Rotation0 = 0, Rotation.e_Rotation90 = 1, Rotation.e_Rotation180 = 2, Rotation.e_Rotation270 = 3,
  Rotation.e_RotationUnknown = 4
}
 Enumeration for rotation. More...
 

Detailed Description

Common namespace.

Enumeration Type Documentation

◆ Alignment

Enumeration for alignment (horizontal).

Values of this enumeration should be used alone.

Enumerator
e_AlignmentLeft 

Left alignment.

e_AlignmentCenter 

Center alignment.

e_AlignmentRight 

Right alignment.

◆ ColorSpaceType

Enumeration for color space.

Values of this enumeration should be used alone.

Enumerator
e_ColorSpaceInvalid 

Color space: Invalid.

e_ColorSpaceDeviceGray 

Color space: DeviceGray. (1 component, gray)

e_ColorSpaceDeviceRGB 

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

e_ColorSpaceDeviceCMYK 

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

e_ColorSpaceCalGray 

Color space: CalGray. (1 component, A)

e_ColorSpaceCalRGB 

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

e_ColorSpaceLab 

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

e_ColorSpaceSeparation 

Color space: Separation.

e_ColorSpaceDeviceN 

Color space: DeviceN.

e_ColorSpacePattern 

Color space: Pattern.

e_ColorSpaceICCBasedDeviceGray 

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

e_ColorSpaceICCBasedDeviceRGB 

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

e_ColorSpaceICCBasedDeviceCMYK 

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

◆ ErrorCode

Enumeration for error code.

Values of this enumeration should be used alone.

Enumerator
e_ErrSuccess 

Success, and no error occurs.

e_ErrFile 

File cannot be found or could not be opened.

e_ErrFormat 

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

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_ErrHandle 

Error handle.

e_ErrCertificate 

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

e_ErrUnknown 

Any unknown error occurs.

e_ErrInvalidLicense 

Invalid license is used to initialize Foxit PDF SDK library.

e_ErrParam 

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

e_ErrUnsupported 

Some types are not supported.

e_ErrOutOfMemory 

Out-of-memory error occurs.

e_ErrSecurityHandler 

PDF document is encrypted by some unsupported security handler.

e_ErrNotParsed 

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

e_ErrNotFound 

Expected data or object is not found.

e_ErrInvalidType 

The type of input object or current object is invalid.

e_ErrConflict 

New data conflicts with existed data.

e_ErrUnknownState 

Any unknown state occurs.

e_ErrDataNotReady 

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

e_ErrInvalidData 

Data of current object is invalid.

e_ErrXFALoadError 

XFA loading error.

e_ErrNotLoaded 

Current object has not been loaded yet.

e_ErrInvalidState 

Invalid or incorrect state.

e_ErrNotCDRM 

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

e_ErrCanNotConnectToServer 

(For ConnectedPDF only) Cannot connect to ConnectedPDF server.

e_ErrInvalidUserToken 

(For ConnectedPDF only) Input user token is invalid.

e_ErrNoRights 

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

e_ErrRightsExpired 

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

e_ErrDeviceLimitation 

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

e_ErrCanNotRemoveSecurityFromServer 

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

e_ErrCanNotGetACL 

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

e_ErrCanNotSetACL 

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

e_ErrIsAlreadyCPDF 

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

e_ErrIsAlreadyCDRM 

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

e_ErrCanNotUploadDocInfo 

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

e_ErrCanNotUploadCDRMInfo 

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

e_ErrInvalidWrapper 

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

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_ErrInvalidACL 

(For ConnectedPDF only) Input ACL is invalid.

e_ErrInvalidClientID 

(For ConnectedPDF only) Input client ID is invalid.

e_ErrOCREngineNotInit 

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

e_ErrDiskFull 

(For OCR only) Not enough disk space.

e_ErrOCRTrialIsEnd 

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

e_ErrFilePathNotExist 

File or folder path does not exist.

e_ErrComplianceEngineNotInit 

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

e_ErrComplianceEngineInvalidUnlockCode 

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

e_ErrComplianceEngineInitFailed 

(For compliance only) Fail to initialize compliance engine.

e_ErrTimeStampServerMgrNotInit 

Time stamp server manager has not been initialized successfully.

e_ErrLTVVerifyModeNotSet 

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

e_ErrLTVRevocationCallbackNotSet 

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

e_ErrLTVCannotSwitchVersion 

(For LTV only) Fail to switch PDF verion.

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_ErrNeedSigned 

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

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_ErrTimeStampServerMgrNoDefaltServer 

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

e_ErrDefaultTimeStampServer 

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

e_ErrNoConnectedPDFModuleRight 

No "ConnectedPDF" module right.

e_ErrNoXFAModuleRight 

No "XFA" module right.

e_ErrNoRedactionModuleRight 

No "Redaction" module right.

e_ErrNoRMSModuleRight 

No "RMS" module right.

e_ErrNoOCRModuleRight 

No "OCR" module right.

e_ErrNoComparisonModuleRight 

No "Comparison" module right.

e_ErrNoComplianceModuleRight 

No "Compliance" module right.

e_ErrNoOptimizerModuleRight 

No "Optimizer" module right.

e_ErrNoConversionModuleRight 

No "Conversion" module right.

e_ErrOfficeComNotInit 

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

e_ErrNoMicroOfficeInstalled 

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

e_ErrExcelHasNoContent 

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

e_ErrNoLayoutRecognitionModuleRight 

No "LayoutRecognition" module right.

e_ErrWPSEngineNotFound 

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

◆ FileFormatType

Enumeration for file format type.

Values of this enumeration can be used alone.

Enumerator
e_FileFormatTypeFDF 

File format type: FDF.

e_FileFormatTypeXFDF 

File format type: XFDF.

e_FileFormatTypeHTML 

File format type: HTML.

e_FileFormatTypeXDP 

File format type: XDP.

e_FileFormatTypeXML 

File format type: XML.

e_FileFormatTypeXFD 

File format type: XFD.

e_FileFormatTypePDF 

File format type: PDF.

e_FileFormatTypeTXT 

File format type: TXT.

◆ FillMode

enum foxit.common.FillMode
strong

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

Values of this enumeration should be used alone.

Enumerator
e_FillModeNone 

Fill mode: none.

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_FillModeWinding 

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

◆ LocaleID

enum foxit.common.LocaleID
strong

Enumeration for locale ID.

Values of this enumeration can be used alone.

Enumerator
e_LocaleIDUnspecified 

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

e_LocaleIDHongKong 

Locale ID for region: HongKong.

e_LocaleIDTaiwan 

Locale ID for region: Taiwan.

e_LocaleIDNetherlands 

Locale ID for country: Netherlands.

e_LocaleIDFrance 

Locale ID for country: France.

e_LocaleIDGermany 

Locale ID for country: Germany.

e_LocaleIDItaly 

Locale ID for country: Italy.

e_LocaleIDKorea 

Locale ID for country: Korea.

e_LocaleIDJapan 

Locale ID for country: Japan.

◆ ModuleName

Enumeration for module name which is used in license information.

Values of this enumeration should be used alone.

Enumerator
e_ModuleNameConnectedPDF 

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

e_ModuleNameXFA 

Name for module "XFA".

e_ModuleNameRedaction 

Name for module "Redaction".

e_ModuleNameRMS 

Name for module "RMS".

e_ModuleNameOCR 

Name for module "OCR".

e_ModuleNameComparison 

Name for module "Comparison".

e_ModuleNameCompliance 

Name for module "Compliance".

e_ModuleNameOptimizer 

Name for module "Optimizer".

e_ModuleNameConversion 

Name for module "Conversion".

e_ModuleNameLayoutRecognition 

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

◆ Position

enum foxit.common.Position
strong

Enumeration for watermark position in a PDF page.

Values of this enumeration should be used alone.

Enumerator
e_PosTopLeft 

Position: top left.

e_PosTopCenter 

Position: top center.

e_PosTopRight 

Position: top right.

e_PosCenterLeft 

Position center left.

e_PosCenter 

Position: center.

e_PosCenterRight 

Position: center right.

e_PosBottomLeft 

Position: bottom left.

e_PosBottomCenter 

Position: bottom center.

e_PosBottomRight 

Position: bottom right.

◆ Rotation

enum foxit.common.Rotation
strong

Enumeration for rotation.

Values of this enumeration should be used alone.

Enumerator
e_Rotation0 

No rotation.

e_Rotation90 

Rotate 90 degrees in clockwise direction.

e_Rotation180 

Rotate 180 degrees in clockwise direction.

e_Rotation270 

Rotate 270 degrees in clockwise direction.

e_RotationUnknown 

Unknown rotation.