Inheritance diagram for foxit.addon.compliance.Preflight:

Public Member Functions
	Preflight ()
	Constructor.

	Preflight (Preflight other)
	Constructor, with another preflight object. More...

ResultInformation	Analyze (PreflightSettingData preflight_setting_data, ProgressCallback progress_callback)
	Analyze a PDF file. More...

ResultInformation	AnalyzeAndFixup (PreflightSettingData preflight_setting_data, ProgressCallback progress_callback)
	Analyze and fixup a PDF file. More...

bool	CanFixup (string item_key)
	Check whether the item key can be fixuped or not. More...

bool	GenerateReport (PreflightReportSettingData preflight_report_setting_data, ProgressCallback progress_callback)
	Generate report after analyzing or fixing. More...

bool	GenerateXMLReport (string xml_report_file_path, ProgressCallback progress_callback)
	Generate an XML report after analyzing or fixing. More...

string	GetGroupItemComment (string key)
	Get the comment of the group item through the key. More...

string	GetGroupItemName (string key)
	Get the name of the group item through the key. More...

StringArray	GetGroupNamesArray (PreflightSettingData.LibraryType library_type, PreflightSettingData.OperateType operate_type)
	Get all group names array corresponding to the library type and operation type. More...

StringArray	GetItemKeysArray (string group_name)
	Get item keys array with the specific group name. More...

bool	IsEmpty ()
	Check whether current object is empty or not. More...

void	SetPreflightGroupLocalCallback (PreflightGroupLocalCallback callback)
	Set a localized name and comment callback for preflight group items. More...

Detailed Description

This class represents the analysis and fix-up functions that match a specified industry profile and performs checks or fix-ups.

Constructor & Destructor Documentation

◆ Preflight()

foxit.addon.compliance.Preflight.Preflight ( Preflight other )

inline

Constructor, with another preflight object.

Parameters

[in] other Another preflight object.

Member Function Documentation

◆ Analyze()

ResultInformation foxit.addon.compliance.Preflight.Analyze	(	PreflightSettingData	preflight_setting_data,
		ProgressCallback	progress_callback
	)

inline

Analyze a PDF file.

Parameters

[in]	preflight_setting_data	The preflight setting data.
[in]	progress_callback	A ProgressCallback object which is implemented by user and can be used to get progress data.

Returns: A ResultInformation object.

◆ AnalyzeAndFixup()

ResultInformation foxit.addon.compliance.Preflight.AnalyzeAndFixup	(	PreflightSettingData	preflight_setting_data,
		ProgressCallback	progress_callback
	)

inline

Analyze and fixup a PDF file.

Parameters

[in]	preflight_setting_data	The preflight setting data.
[in]	progress_callback	A ProgressCallback object which is implemented by user and can be used to get progress data.

Returns: A ResultInformation object.

◆ CanFixup()

bool foxit.addon.compliance.Preflight.CanFixup ( string item_key )

inline

Check whether the item key can be fixuped or not.

Parameters

[in] item_key The item key. It can be retrieved by Preflight.GetItemKeysArray .

Returns: true means can be fixuped, while false means can not be fixuped.

◆ GenerateReport()

bool foxit.addon.compliance.Preflight.GenerateReport	(	PreflightReportSettingData	preflight_report_setting_data,
		ProgressCallback	progress_callback
	)

inline

Generate report after analyzing or fixing.

This should be called after Preflight.Analyze or Preflight.AnalyzeAndFixup .

Parameters

[in]	preflight_report_setting_data	The preflight report setting data.
[in]	progress_callback	A ProgressCallback object which is implemented by user and can be used to get progress data.

Returns: true means success, while false means failure.

◆ GenerateXMLReport()

bool foxit.addon.compliance.Preflight.GenerateXMLReport	(	string	xml_report_file_path,
		ProgressCallback	progress_callback
	)

inline

Generate an XML report after analyzing or fixing.

This should be called after Preflight.Analyze or Preflight.AnalyzeAndFixup .

Parameters

[in]	xml_report_file_path	A complete path for saving the XML report file. This should not be an empty string.
[in]	progress_callback	A ProgressCallback object which is implemented by user and can be used to get progress data. This can be null. Default value: null.

Returns: true means success, while false means failure.

◆ GetGroupItemComment()

string foxit.addon.compliance.Preflight.GetGroupItemComment ( string key )

inline

Get the comment of the group item through the key.

Only English is available, and other languages need to reference the translated XML to get it by themselves.

Parameters

[in] key the key of group item.

Returns: The comment of the group item obtained through the Preflight.GetGroupNamesArray and Preflight.GetItemKeysArray interface.

◆ GetGroupItemName()

string foxit.addon.compliance.Preflight.GetGroupItemName ( string key )

inline

Get the name of the group item through the key.

Only English is available, and other languages need to reference the translated XML to get it by themselves.

Parameters

[in] key the key of group item.

Returns: The name of the group item obtained through the Preflight.GetGroupNamesArray and Preflight.GetItemKeysArray interface.

◆ GetGroupNamesArray()

StringArray foxit.addon.compliance.Preflight.GetGroupNamesArray	(	PreflightSettingData.LibraryType	library_type,
		PreflightSettingData.OperateType	operate_type
	)

inline

Get all group names array corresponding to the library type and operation type.

Parameters

[in]	library_type	The library type. Please refer to values starting from foxit.addon.compliance.PreflightSettingData.LibraryType.e_LibraryTypeFoxit and this should be one of these values.
[in]	operate_type	The operate type. Please refer to values starting from foxit.addon.compliance.PreflightSettingData.OperateType.e_OperateTypeProfiles and this should be one of these values.

Returns: The group names array.

◆ GetItemKeysArray()

StringArray foxit.addon.compliance.Preflight.GetItemKeysArray ( string group_name )

inline

Get item keys array with the specific group name.

Parameters

[in] group_name The group name which can obtain from the function Preflight.GetGroupNamesArray .

Returns: The item keys array.

◆ IsEmpty()

bool foxit.addon.compliance.Preflight.IsEmpty ( )

inline

Check whether current object is empty or not.

When the current object is empty, that means current object is useless.

Returns: true means current object is empty, while false means not.

◆ SetPreflightGroupLocalCallback()

void foxit.addon.compliance.Preflight.SetPreflightGroupLocalCallback ( PreflightGroupLocalCallback callback )

inline

Set a localized name and comment callback for preflight group items.

This callback is used by Preflight.GetGroupItemName and Preflight.GetGroupItemComment to provide localized names and comments for group items. When a localized string for a given key is available from the callback, it will be used; otherwise, the default library string will be used.

Parameters

[in] callback A PreflightGroupLocalCallback callback object that provides localized names and comments.

Returns: None.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Preflight()

Member Function Documentation

◆ Analyze()

◆ AnalyzeAndFixup()

◆ CanFixup()

◆ GenerateReport()

◆ GenerateXMLReport()

◆ GetGroupItemComment()

◆ GetGroupItemName()

◆ GetGroupNamesArray()

◆ GetItemKeysArray()

◆ IsEmpty()

◆ SetPreflightGroupLocalCallback()