Foxit PDF SDK
foxit.common.Library Class Reference

Inherits SystemIDisposable.

Static Public Member Functions

static bool EnableJavaScript (bool enable_javascript)
 Enable or disable javascript for PDF.
More...
 
static RenderConfig GetRenderConfig ()
 Get the rendering configuration.
More...
 
static string GetVersion ()
 Get the version of current Foxit PDF SDK library.
More...
 
static bool HasModuleLicenseRight (ModuleName module_name)
 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...
 
static ErrorCode Initialize (string sn, string key)
 Initialize Foxit PDF SDK Library, with valid license information.
More...
 
static bool RegisterSecurityCallback (string filter, SecurityCallback callback)
 Register a foxit.pdf.SecurityCallback object to Foxit PDF SDK for decryption of the PDFs with special encryption filters.
More...
 
static bool RegisterSignatureCallback (string filter, string sub_filter, SignatureCallback signature_callback)
 Register a third-party foxit.pdf.SignatureCallback object to Foxit PDF SDK for signing and verifying signature, along with the filter and sub filter name of the callback.
More...
 
static void RegisterXFAAppProviderCallback (AppProviderCallback callback)
 Register an foxit.addon.xfa.AppProviderCallback object to Foxit PDF SDK.
More...
 
static ErrorCode Reinitialize ()
 Reinitialize Foxit PDF SDK Library.
More...
 
static void Release ()
 Release all resource allocated by Foxit PDF SDK Library.
More...
 
static bool SetActionCallback (ActionCallback action_callback)
 Set a foxit.pdf.actions.ActionCallback object to Foxit PDF SDK, in aid of performing PDF actions.
More...
 
static bool SetAnnotIconProviderCallback (IconProviderCallback annot_icon_provider)
 Set a customized foxit.pdf.annots.IconProviderCallback object to Foxit PDF SDK.
More...
 
static bool SetCacheSize (int size)
 Set the upper limit of PDF library cache size.
More...
 
static void SetDefaultICCProfilesPath (string icc_profile_folder_path)
 Set path of folder which contains default ICC profile files.
More...
 
static bool SetDocEventCallback (DocEventCallback callback)
 Set a DocEventCallback object to Foxit PDF SDK.
More...
 
static bool SetFontMapperCallback (FontMapperCallback callback)
 Set a FontMapperCallback object to Foxit PDF SDK.
More...
 
static void SetLogFile (string log_file_path)
 Set the log file path.
More...
 
static bool SetNotifierCallback (NotifierCallback notifier)
 Set a NotifierCallback object to Foxit PDF SDK.
More...
 
static void SetRenderConfig (RenderConfig render_config)
 Set the rendering configuration.
More...
 
static void SetRenderTextGamma (float gamma)
 Set gamma value for text rendering.
More...
 
static bool UnregisterSecurityCallback (string filter)
 Unregister a foxit.pdf.SecurityCallback object from Foxit PDF SDK.
More...
 

Detailed Description

This class represents the library management. It contains functions to initialize/re-initialize/release Foxit PDF SDK library, and also contains functions for global use.
Any application should load Foxit PDF SDK by function Library.Initialize before calling any other Foxit PDF SDK functions. When there is no need to use Foxit PDF SDK any more, please call function Library.Release . Functions in Foxit PDF SDK may throw exception when some error occurs. User can catch these exceptions and check the error code with values starting from foxit.common.ErrorCode.e_ErrFile to know more about what error occurs.

Member Function Documentation

◆ EnableJavaScript()

static bool foxit.common.Library.EnableJavaScript ( bool  enable_javascript)
inlinestatic

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.

◆ GetRenderConfig()

static RenderConfig foxit.common.Library.GetRenderConfig ( )
inlinestatic

Get the rendering configuration.

Returns
A rendering configuration object which shows current configuration.

◆ GetVersion()

static string foxit.common.Library.GetVersion ( )
inlinestatic

Get the version of current Foxit PDF SDK library.

Returns
Version string.

◆ HasModuleLicenseRight()

static bool foxit.common.Library.HasModuleLicenseRight ( ModuleName  module_name)
inlinestatic

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 foxit.common.ModuleName.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.

◆ Initialize()

static ErrorCode foxit.common.Library.Initialize ( string  sn,
string  key 
)
inlinestatic

Initialize Foxit PDF SDK Library, with valid license information.

This function should be called first before any other functions in Foxit PDF SDK can be called.

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
foxit.common.ErrorCode.e_ErrSuccess means success.
foxit.common.ErrorCode.e_ErrInvalidLicense means input license information is invalid.
foxit.common.ErrorCode.e_ErrParam means parameter sn or key is an empty string.
For more information about error code values, please refer to values starting from foxit.common.ErrorCode.e_ErrSuccess .

◆ RegisterSecurityCallback()

static bool foxit.common.Library.RegisterSecurityCallback ( string  filter,
SecurityCallback  callback 
)
inlinestatic

Register a foxit.pdf.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 pdf.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 Library.UnregisterSecurityCallback .

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 foxit.pdf.CustomSecurityCallback , users could specified their own custom filter string, but need to follow the PDF name conventions.
When users implement security callback of foxit.pdf.CertificateSecurityCallback , the filter value must be set to "Adobe.PubSec".
When users implement security callback of foxit.pdf.DRMSecurityCallback , the filter value must be set to "FoxitDRM", or some error may occur later.
When users implement security callback of foxit.pdf.RMSSecurityCallback , the filter value must be set to "MicrosoftIRMServices" or "FoxitRMS", or some error may occur later.
[in]callbackA foxit.pdf.SecurityCallback object, which is implemented by user and based on callback class foxit.pdf.SecurityCallback . User should not inherit foxit.pdf.SecurityCallback directly, but inherit its derived class, such as foxit.pdf.CustomSecurityCallback , foxit.pdf.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 Library.Initialize , that means user has no right in using RMS related functions and this function will throw exception foxit.common.ErrorCode.e_ErrNoRMSModuleRight .

◆ RegisterSignatureCallback()

static bool foxit.common.Library.RegisterSignatureCallback ( string  filter,
string  sub_filter,
SignatureCallback  signature_callback 
)
inlinestatic

Register a third-party foxit.pdf.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 filter as default ones by this function, the default signature callback in Foxit PDF SDK will not have any effect any more.

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 foxit.pdf.SignatureCallback object, which is implemented by user and based on callback class foxit.pdf.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 Library.Release .
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.

◆ RegisterXFAAppProviderCallback()

static void foxit.common.Library.RegisterXFAAppProviderCallback ( AppProviderCallback  callback)
inlinestatic

Register an foxit.addon.xfa.AppProviderCallback object to Foxit PDF SDK.

This function should be called first before processing XFA document.

Parameters
[in]callbackAn foxit.addon.xfa.AppProviderCallback object, which is implemented by user and based on callback class foxit.addon.xfa.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 Library.Release .
Returns
None.
Note
If module "XFA" is not defined in the license information which is used in function Library.Initialize , that means user has no right in using XFA related functions and this function will throw exception foxit.common.ErrorCode.e_ErrNoXFAModuleRight .

◆ Reinitialize()

static ErrorCode foxit.common.Library.Reinitialize ( )
inlinestatic

Reinitialize Foxit PDF SDK Library.

When user meets out-of-memory error, user can call this function to reinitialize Foxit PDF SDK Library.

Returns
foxit.common.ErrorCode.e_ErrSuccess means success. For more information about error code values, please refer to values starting from foxit.common.ErrorCode.e_ErrSuccess .

◆ Release()

static void foxit.common.Library.Release ( )
inlinestatic

Release all resource allocated by Foxit PDF SDK Library.

User can call this function to release all memory blocks allocated by the library. After this function is called, user should not use Foxit PDF SDK any more until call Library.Initialize again.

Returns
None.

◆ SetActionCallback()

static bool foxit.common.Library.SetActionCallback ( ActionCallback  action_callback)
inlinestatic

Set a foxit.pdf.actions.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 foxit.pdf.actions.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.

◆ SetAnnotIconProviderCallback()

static bool foxit.common.Library.SetAnnotIconProviderCallback ( IconProviderCallback  annot_icon_provider)
inlinestatic

Set a customized foxit.pdf.annots.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 foxit.pdf.annots.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 Library.Release 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 pdf.annots.IconProviderCallback.GetProviderID and pdf.annots.IconProviderCallback.GetProviderVersion .

◆ SetCacheSize()

static bool foxit.common.Library.SetCacheSize ( int  size)
inlinestatic

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.

◆ SetDefaultICCProfilesPath()

static void foxit.common.Library.SetDefaultICCProfilesPath ( string  icc_profile_folder_path)
inlinestatic

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 foxit.common.ErrorCode.e_ErrFilePathNotExist .

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

◆ SetDocEventCallback()

static bool foxit.common.Library.SetDocEventCallback ( DocEventCallback  callback)
inlinestatic

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.

◆ SetFontMapperCallback()

static bool foxit.common.Library.SetFontMapperCallback ( FontMapperCallback  callback)
inlinestatic

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.

◆ SetLogFile()

static void foxit.common.Library.SetLogFile ( string  log_file_path)
inlinestatic

Set the log file path.

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.

◆ SetNotifierCallback()

static bool foxit.common.Library.SetNotifierCallback ( NotifierCallback  notifier)
inlinestatic

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.

◆ SetRenderConfig()

static void foxit.common.Library.SetRenderConfig ( RenderConfig  render_config)
inlinestatic

Set the rendering configuration.

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

◆ SetRenderTextGamma()

static void foxit.common.Library.SetRenderTextGamma ( float  gamma)
inlinestatic

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.

◆ UnregisterSecurityCallback()

static bool foxit.common.Library.UnregisterSecurityCallback ( string  filter)
inlinestatic

Unregister a foxit.pdf.SecurityCallback object from Foxit PDF SDK.

Foxit PDF SDK may release the security callback function by callback function pdf.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 Library.UnregisterSecurityCallback .

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