InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Facade::IDigitalPublishingVectorExportFacade Class Referenceabstract
Inheritance diagram for Facade::IDigitalPublishingVectorExportFacade:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IDIGITALPUBLISHINGVECTOREXPORTFACADE }
 

Public Member Functions

virtual ErrorCode ExportPageitemsAsPDF (UIDList const &items, UIDList const &pageItemsToSuppress, id_digpub::ObjectPtr const &settings, id_digpub::ObjectPtr *results, IDFile const &out)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Member Function Documentation

virtual ErrorCode Facade::IDigitalPublishingVectorExportFacade::ExportPageitemsAsPDF (UIDList const & items,
UIDList const & pageItemsToSuppress,
id_digpub::ObjectPtr const & settings,
id_digpub::ObjectPtr * results,
IDFile const & out 
)
pure virtual

Exports the given page items to a PDF.

settings is an optional dictionary which may include the following values (case-sensitive):

JPEGQuality: string, one of 'max', 'high', 'med', 'low', 'min'. Default is 'high' ImageResolution: uint, the resolution at which to downsample raster images. Must be between 18 and 600. Default is 72 Note: 'Resolution' is allowed as a fallback key. If both are present, 'ImageResolution' is preferred. Scale: real, amount by which document should be scaled

TileSize: optional PMPoint with desired tiled size, if any. If omitted, output is not tiled

ThumbnailGeneration: optional dictionary for controlling thumbnail generation. If omitted, no thumbnails are generated.

ThumbnailScale: real, specifies scale for thumbnail. A value of 2 would result in a 1/2 size thumbnail. Default is 3 OutputDirectory: file, must be a directory. The directory in which to generate thumbnails. Default is a temporary directory BaseFileName: string, specifies base file name for generated thumbnails. Sequence # and extension will be appended.

results is an optional dictionary. If included, it will be populated with the following values on successful exit (case-sensitive):

Bounds: PMRect, the bounds for the exported PDF. If tiled, this is the union of the tiles' bounds Tiles: array of: Page: uint, the 1-based page index in the PDF for this tile Bounds: PMRect, the bounds for the export tile's page

Tiles array will only be present if tiling is true (i.e., valid TileSize is present in settings)

If thumbnail generation is enabled, generated thumbnails will be included in results. When tiling, information about the thumbnails will be included in each tile's dictionary. Otherwise, information about the single thumbnail will be included in the main results dictionary.

The information includes:

ThumbnailBounds: PMRect, the bounds for the thumbnail in normalized image coordinates ThumbnailFile: file, the location of the thumbnail image

Note: It is the caller's responsibility to delete any generated thumbnail images and to remove the thumbnail directory if necessary.

Parameters
itemsThe page items to export. The page items will be exported to a single page in the PDF
pageItemsToSuppressPage items to be excluded from the export. May be empty.
settingsSettings to use during the export
resultsOptional dictionary to receive results
outThe file to which the PDF is written
Returns
an ErrorCode describing success or failure of the operation