FSDK.Preflight Class Reference

Public Member Functions
	Analyze (preflight_setting_data, progress_callback)
	Analyze a PDF file. More...
	AnalyzeAndFixup (preflight_setting_data, progress_callback)
	Analyze and fixup a PDF file. More...
	CanFixup (item_key)
	Check whether the item key can be fixuped or not. More...
	constructor ()
	Constructor.
	GenerateReport (preflight_report_setting_data, progress_callback)
	Generate report after analyzing or fixing. More...
	GenerateXMLReport (xml_report_file_path, progress_callback)
	Generate an XML report after analyzing or fixing. More...
	GetGroupItemComment (key)
	Get the comment of the group item through the key. More...
	GetGroupItemName (key)
	Get the name of the group item through the key. More...
	GetGroupNamesArray (library_type, operate_type)
	Get all group names array corresponding to the library type and operation type. More...
	GetItemKeysArray (group_name)
	Get item keys array with the specific group name. More...
	IsEmpty ()
	Check whether current object is empty or not. More...
	SetPreflightGroupLocalCallback (callback)
	Set a localized name and comment callback for preflight group items. More...

Detailed Description

This class represents a analyze and fixup funciton matches a specified industry profile, check or fixup.

Member Function Documentation

Analyze()

FSDK.Preflight.Analyze (   preflight_setting_data,   progress_callback  )

inline

Analyze a PDF file.

Parameters

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

Returns

A FSDK.ResultInformation object.

AnalyzeAndFixup()

FSDK.Preflight.AnalyzeAndFixup (   preflight_setting_data,   progress_callback  )

inline

Analyze and fixup a PDF file.

Parameters

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

Returns

A FSDK.ResultInformation object.

CanFixup()

FSDK.Preflight.CanFixup (   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 FSDK.Preflight.GetItemKeysArray.

Returns

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

GenerateReport()

FSDK.Preflight.GenerateReport (   preflight_report_setting_data,   progress_callback  )

inline

Generate report after analyzing or fixing.

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

Parameters

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

Returns

true means success, while false means failure.

GenerateXMLReport()

FSDK.Preflight.GenerateXMLReport (   xml_report_file_path,   progress_callback  )

inline

Generate an XML report after analyzing or fixing.

This should be called after FSDK.Preflight.Analyze or FSDK.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 FSDK.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()

FSDK.Preflight.GetGroupItemComment (   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 FSDK.Preflight.GetGroupNamesArray and FSDK.Preflight.GetItemKeysArray interface.

GetGroupItemName()

FSDK.Preflight.GetGroupItemName (   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 FSDK.Preflight.GetGroupNamesArray and FSDK.Preflight.GetItemKeysArray interface.

GetGroupNamesArray()

FSDK.Preflight.GetGroupNamesArray (   library_type,   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 FSDK.PreflightSettingData.e_LibraryTypeFoxit and this should be one of these values.

Parameters

[in]

operate_type

The operate type. Please refer to values starting from FSDK.PreflightSettingData.e_OperateTypeProfiles and this should be one of these values.

Returns

The group names array.

GetItemKeysArray()

FSDK.Preflight.GetItemKeysArray (   group_name )

inline

Get item keys array with the specific group name.

Parameters

[in]

group_name

The group name which can obtain from the FSDK.Preflight.GetGroupNamesArray interface.

Returns

The item keys array.

IsEmpty()

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

FSDK.Preflight.SetPreflightGroupLocalCallback (   callback )

inline

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

This callback is used by FSDK.Preflight.GetGroupItemName and FSDK.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 FSDK.PreflightGroupLocalCallback callback object that provides localized names and comments.

Returns

None.