PDFXConvertParams Class Documentation

class PDFXConvertParams : SystemIDisposable

Namespace:Datalogics::PDFL

Inherits from:
SystemIDisposable

Detailed Description

Parameters for converting a document to PDF/X compliance.

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

Referenced by

Constructor & Destructor Documentation

PDFXConvertParams

PDFXConvertParams()

Construct PDF/X conversion parameters with defaults.

Defaults: RemoveAllAnnotations = false, AbortIfXFAIsPresent = false.

PDFXConvertParams

PDFXConvertParams(bool RemoveAllAnnotations, bool AbortIfXFAIsPresent)

Parameters

RemoveAllAnnotations: bool

Remove all annotations whether legal or illegal.

AbortIfXFAIsPresent: bool

Abort when XFA is present.

Parameters for converting to PDF/X.

Property Documentation

AbortIfXFAIsPresent

bool AbortIfXFAIsPresent[get, set]

Gets whether conversion is aborted when XFA forms are present.

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.

ProfileDesc

string ProfileDesc[get, set]

Gets the Output Intent profile description for the PDF/X conversion.

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.

RemoveAllAnnotations

bool RemoveAllAnnotations[get, set]

Gets whether all annotations and actions are removed during conversion.

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.

Member Function Documentation

Dispose

void Dispose()

Returns:

void