Preflight APIs¶

Preflight¶

Version (Key)	Save-Prefs	Security	Product
9.0	No	No	Acrobat Pro only

This object represents the Preflight tool.

Preflight methods¶

createComplianceProfile¶

Version (Key)	Save-Prefs	Security	Product
9.0	No	No	Acrobat Pro only

Creates a compliance profile for a given PDF standard for the document.

Parameters

Parameter	Description
`cStandardKey`	The PDF Standard version to verify.
`oThermometer`	(optional) Show the status window and the progress bar that indicates to the user that a lengthy operation is in progress. To acquire a Thermometer object, use `app.thermometer`. If `oThermometer` is not specified, no progress is shown.

Valid standard version keys:

PDF/X-1a:2001
PDF/X-1a:2003
PDF/X-3:2002
PDF/X-3:2003
PDF/X-4:2008
PDF/X-4p:2008
PDF/X-5g:2008
PDF/X-5n:2008
PDF/X-5pg:2008
PDF/A-1a:2005
PDF/A-1b:2005
PDF/E-1:2008

Returns

A PreflightProfile object. Undefined is returned otherwise.

Example: Check the current PDF document to PDF/A-1b:2005 compliance.

var oProfile = Preflight.createComplianceProfile("PDF/A-1b:2005")
if( oProfile != undefined )
{
   var oThermometer = app.thermometer;
   var myPreflightResult = this.preflight( oProfile, true, oThermometer);
   if( myPreflightResult.numErrors > 0 ) {
       console.println( "PDF document is NOT PDF/A-1b:2005 compliant.");
   } else {
   console.println( "PDF document is PDF/A-1b:2005 compliant.");
   }
}

getNthProfile¶

Version (Key)	Save-Prefs	Security	Product
9.0	No	No	Acrobat Pro only

Retrieves the Nth Preflight profile from the list of installed Preflight profiles.

Parameters

Parameter	Description
`nIndex`	The zero-based index of the profile that should be obtained.
`oThermometer`	(optional) Shows the status window and the progress bar that indicates to the user that a lengthy operation is in progress. To acquire a Thermometer object, use `app.thermometer`. If `oThermometer` is not specified, no progress is shown.

Returns

A PreflightProfile object containing the profile that corresponds to nIndex. Undefined is returned otherwise.

Example: Enumerate through all of the profiles in Preflight.

var num = Preflight.getNumProfiles(app.thermometer);
for( i= 0; i< num; ++i)
{
   var oProfile = Preflight.getNthProfile(i);
   console.println("-----------------------------------------");
   console.println("Name: " + oProfile.name);
   console.println("Comment: " + oProfile.description);
   console.println("HasFixups: " + oProfile.hasFixups);
   console.println("HasChecks: " + oProfile.hasChecks);
   console.println("-----------------------------------------");
}

getNumProfiles¶

Version (Key)	Save-Prefs	Security	Product
9.0	No	No	Acrobat Pro only

Retrieves the number of installed Preflight profiles.

Parameters

Parameter	Description
`oThermometer`	(optional) Shows the status window and the progress bar that indicates to the user that a lengthy operation is in progress. To acquire a Thermometer object, use `app.thermometer`. If `oThermometer` is not specified, no progress is shown.

Returns

The number of installed Preflight profiles.

getProfileByName¶

Version (Key)	Save-Prefs	Security	Product
9.0	No	No	Acrobat Pro only

Retrieves the Preflight profile with a specific name from the list of installed Preflight profiles.

Parameters

Parameter	Description
`cName`	The name of the profile to be obtained.
`oThermometer`	(optional) Shows the status window and the progress bar that indicates to the user that a lengthy operation is in progress. To acquire a Thermometer object, use `app.thermometer`. If `oThermometer` is not specified, no progress is shown.

Returns

A PreflightProfile object if a profile with the specified name exists. Undefined is returned otherwise.

Example: Get a profile with the name “Magazine Ads”.

var oProfile = Preflight.getProfileByName("Magazine Ads");
if( oProfile != undefined) {
   console.println("-----------------------------------------");
   console.println("Name: " + oProfile.name);
   console.println("Comment: " + oProfile.description);
   console.println("HasFixups: " + oProfile.hasFixups);
   console.println("HasChecks: " + oProfile.hasChecks);
   console.println("-----------------------------------------");
}

getProfileByFingerPrint¶

Version (Key)	Save-Prefs	Security	Product
9.0	No	No	Acrobat Pro only

Retrieves the Preflight profile with a specific fingerprint of the audit trail. The fingerprint can be acquired from the doc.getPreflightAuditTrail method.

Parameters

Parameter	Description
`cFingerPrint`	The fingerprint of the profile to be obtained.
`oThermometer`	(optional) Shows the status window and the progress bar that indicates to the user that a lengthy operation is in progress. To acquire a Thermometer object, use `app.thermometer`. If `oThermometer` is not specified, no progress is shown.

Returns

A PreflightProfile object if a profile with the specified fingerprint exists. Undefined is returned otherwise.

Example: Get a profile from the audit trail.

var oAuditTrail = this.getPreflightAuditTrail();
var oProfile = Preflight.getProfileByFingerPrint(oAuditTrail.profile_fingerprint);
if( oProfile != undefined) {
   console.println("-----------------------------------------");
   console.println("Name: " + oProfile.name);
   console.println("Comment: " + oProfile.description);
   console.println("HasFixups: " + oProfile.hasFixups);
   console.println("HasChecks: " + oProfile.hasChecks);
   console.println("-----------------------------------------");
}

PreflightAuditTrail¶

Version (Key)	Save-Prefs	Security	Product
9.0	No	No	Acrobat Pro only

A PreflightAuditTrail represents information about a Preflight check that has been carried out for the PDF, and contains information about the Preflight profile used as well as what the outcome of the Preflight check was.

PreflightAuditTrail properties¶

preflight_executed_date¶

Version (Key)	Save-Prefs	Security	Product	Type	Access
9.0	No	No	Acrobat Pro only	String	R

The date and time when the profile was executed.

preflight_results¶

Version (Key)	Save-Prefs	Security	Product	Type	Access
9.0	No	No	Acrobat Pro only	String	R

The result of executing the profile, with four possible values:

“Errors “
“Warnings “
“Info “
“Success “

preflight_results_description¶

Version (Key)	Save-Prefs	Security	Product	Type	Access
9.0	No	No	Acrobat Pro only	String	R

The descriptive text about the errors.

profile_creator¶

Version (Key)	Save-Prefs	Security	Product	Type	Access
9.0	No	No	Acrobat Pro only	String	R

The software by which the profile was created.

profile_creator_version¶

Version (Key)	Save-Prefs	Security	Product	Type	Access
9.0	No	No	Acrobat Pro only	String	R

The version number of the software used for creating the profile.

profile_fingerprint¶

Version (Key)	Save-Prefs	Security	Product	Type	Access
9.0	No	No	Acrobat Pro only	String	R

The fingerprint for the profile that was used to carry out the Preflight check.

profile_format_version¶

Version (Key)	Save-Prefs	Security	Product	Type	Access
9.0	No	No	Acrobat Pro only	String	R

The version number of the format in which the profile was stored.

profile_name¶

Version (Key)	Save-Prefs	Security	Product	Type	Access
9.0	No	No	Acrobat Pro only	String	R

The name of the Preflight profile used.

Example: Display the properties from the audit trail.

var oAuditTrail = this.getPreflightAuditTrail();
if( oAuditTrail != undefined) {
   var oProfile = Preflight.getProfileByFingerPrint(oAuditTrail.profile_fingerprint);
   if( oProfile != undefined) {
       console.println("-----------------------------------------");
       console.println("Name: " + oAuditTrail.profile_name);
       console.println("Creator: " + oAuditTrail.profile_creator);
       console.println("Creator Version: " + oAuditTrail.profile_creator_version);
       console.println("Format Version: " + oAuditTrail.profile_format_version);
       console.println("Results: " + oAuditTrail.preflight_results);
       console.println("Description: " + oAuditTrail.preflight_results_description);
       console.println("Executed Date: " + oAuditTrail.preflight_executed_date);
       console.println("Fingerprint: " + oAuditTrail.profile_fingerprint);
       console.println("-----------------------------------------");
   } else {
       this.removePreflightAuditTrail();
   }
}

PreflightProfile¶

Version (Key)	Save-Prefs	Security	Product
9.0	No	No	Acrobat Pro only

A PreflightProfile represents a particular Preflight profile; that is a Preflight profile that is installed in the Preflight tool. The PreflightProfile object can be acquired from Preflight.getNthProfile, Preflight.getProfileByName, Preflight.createComplianceProfile or Preflight.getProfileByFingerPrint.

PreflightProfile properties¶

name¶

Version (Key)	Save-Prefs	Security	Product	Type	Access
9.0	No	No	Acrobat Pro only	String	R

The name of the Preflight profile.

description¶

Version (Key)	Save-Prefs	Security	Product	Type	Access
9.0	No	No	Acrobat Pro only	String	R

The description of the Preflight profile.

hasFixups¶

Version (Key)	Save-Prefs	Security	Product	Type	Access
9.0	No	No	Acrobat Pro only	Boolean	R

true if the Preflight profile has fixups, false otherwise.

hasChecks¶

Version (Key)	Save-Prefs	Security	Product	Type	Access
9.0	No	No	Acrobat Pro only	Boolean	R

true if the Preflight profile has checks, false otherwise.

PreflightProfile methods¶

hasConversion¶

Version (Key)	Save-Prefs	Security	Product
9.0	No	No	Acrobat Pro only

Checks whether the preflight profile contains a conversion to a specific PDF standard.

Parameters

cVersion

The PDF standard, represented as a string.

Valid standard keys:

PDF/X-1a:2001
PDF/X-1a:2003
PDF/X-3:2002
PDF/X-3:2003
PDF/X-4:2008
PDF/X-4p:2008
PDF/X-5g:2008
PDF/X-5n:2008
PDF/X-5pg:2008
PDF/A-1a:2005
PDF/A-1b:2005
PDF/E-1:2008

Returns

true if the specified conversion is configured in the profile, false otherwise.

PreflightResult¶

Version (Key)	Save-Prefs	Security	Product
9.0	No	No	Acrobat Pro only

A PreflightResult represents a particular Preflight result; it is a data structure created by the Preflight tool. The PreflightResult object can be acquired from the doc.preflight method.

PreflightResult properties¶

numErrors¶

Version (Key)	Save-Prefs	Security	Product	Type	Access
9.0	No	No	Acrobat Pro only	Integer	R

Indicates the number of errors found in the PDF document.

numWarnings¶

Version (Key)	Save-Prefs	Security	Product	Type	Access
9.0	No	No	Acrobat Pro only	Integer	R

Indicates the number of warnings found in the PDF document.

numInfos¶

Version (Key)	Save-Prefs	Security	Product	Type	Access
9.0	No	No	Acrobat Pro only	Integer	R

Indicates the number of pieces of information found in the PDF document.

numFixed¶

Version (Key)	Save-Prefs	Security	Product	Type	Access
9.0	No	No	Acrobat Pro only	Integer	R

Indicates the number of successfully applied fixups.

numNotFixed¶

Version (Key)	Save-Prefs	Security	Product	Type	Access
9.0	No	No	Acrobat Pro only	Integer	R

Indicates the number of unsuccessfully applied fixups.

PreflightResult methods¶

report¶

Version (Key)	Save-Prefs	Security	Product
9.0	No	No	Acrobat Pro only

Creates a Preflight XML report.

Parameters

Parameter	Description
`oThermometer`	(optional) Shows the status window and the progress bar that indicates to the user that a lengthy operation is in progress. To acquire a Thermometer object, use `app.thermometer`. If `oThermometer` is not specified, no progress is shown.

Returns

A string containing the XML report. This string can be used with XMLData.parse method to create an XFA object that represents either a tree headed by a single node or a tree started by a list of nodes (a tree list).

Example: Create and parse a Preflight XML report.

var oProfile = Preflight.getProfileByName("Magazine Ads")
if( oProfile != undefined )
{
   var oThermometer = app.thermometer;
   var myPreflightResult = this.preflight( oProfile, false, oThermometer);
   if( myPreflightResult.numErrors > 0 ) {
   var cXMLData = myPreflightResult.report(oThermometer);
   var oXMLData = XMLData.parse(sXMLData, false);
   // .
  .. do something with XMLData object ...
}