PDFXConvertParams Class Documentation

classPDFXConvertParams

Namespace:datalogics_interface

Detailed Description

These parameters control how a Document is converted to the PDF/X standard.

PDF/X is a subset of the PDF ISO standard. The purpose of PDF/X is to facilitate graphics exchange, and it therefore has a series of printing related requirements. For example, in PDF/X-1a all fonts need to be embedded and all images need to be CMYK or spot colors. PDF/X-3 accepts calibrated RGB and CIELAB colors, while retaining most of the other restrictions of PDF/X-1a.

Constructor & Destructor Documentation

PDFXConvertParams

PDFXConvertParams()

Defaults: RemoveAllAnnotations = false, AbortIfXFAIsPresent = false.

~PDFXConvertParams

~PDFXConvertParams()

Member Function Documentation

get_abort_if_xfa_is_present

boolget_abort_if_xfa_is_present()

Returns:

bool

Presence of XFA can result in some loss of data in output PDF/X file as the Library does not support XFA. However client can choose to abort the conversion in case XFA is present by setting this parameter to true.

By default we will not abort if XFA is present.

If false we will convert even if we detect the XFA form entry in PDDoc. If true we will abort the process.

get_profile_description

std::stringget_profile_description()

Returns:

std::string

The Output Intent of a PDF/X document may be any valid CMYK Profile For PDF/X-1a or any valid CMYK or RGB Profile for PDF/X-3. This parameter allows the user to specify a particular profile for this conversion by description. When this parameter is not present, the profile "U.S. Web
Coated (SWOP) v2" will be used for both.

If this description is present, and specifies a profile of the wrong color family, or specifies a profile which cannot be located in resources, an exception will be raised.

get_remove_all_annotations

boolget_remove_all_annotations()

Returns:

bool

Some of the standards like PDF/X prohibit the presence of some types of Annotations and Actions in order to comply with those standards.

By default we will filter all illegal Annotations and Actions.

If false we will filter out all illegal Annotations and Actions (according to the standard being used) while retaining the legal ones. If true this will remove all the Annotations and Actions from the output PDF/X compliant file.

set_abort_if_xfa_is_present

voidset_abort_if_xfa_is_present(boolvalue)

Parameters

value: bool

whether conversion is aborted when XFA forms are present

Returns:

void

Presence of XFA can result in some loss of data in output PDF/X file as the Library does not support XFA. However client can choose to abort the conversion in case XFA is present by setting this parameter to true.

By default we will not abort if XFA is present.

If false we will convert even if we detect the XFA form entry in PDDoc. If true we will abort the process.

set_profile_description

voidset_profile_description(const std::string &profile)

Parameters

profile: const std::string &

the Output Intent profile description for the PDF/X conversion

Returns:

void

The Output Intent of a PDF/X document may be any valid CMYK Profile For PDF/X-1a or any valid CMYK or RGB Profile for PDF/X-3. This parameter allows the user to specify a particular profile for this conversion by description. When this parameter is not present, the profile "U.S. Web
Coated (SWOP) v2" will be used for both.

If this description is present, and specifies a profile of the wrong color family, or specifies a profile which cannot be located in resources, an exception will be raised.

set_remove_all_annotations

voidset_remove_all_annotations(boolvalue)

Parameters

value: bool

whether all annotations and actions are removed during conversion

Returns:

void

Some of the standards like PDF/X prohibit the presence of some types of Annotations and Actions in order to comply with those standards.

By default we will filter all illegal Annotations and Actions.

If false we will filter out all illegal Annotations and Actions (according to the standard being used) while retaining the legal ones. If true this will remove all the Annotations and Actions from the output PDF/X compliant file.