PDFExportParams Class

Syntax

C++

class PDFExportParams;

Description

This class implements the PDF export parameters.

Class Hierarchy

File: PdfExportParams.h

Namespace: TD_PDF_2D_EXPORT

Module: API Reference

Methods

PDFExportParams	Creates a new set of export parameters with default values.
~PDFExportParams	Destroys the set of export parameters.

Data Members

currentVersion	The current version of the PDF format used for the export operation by default.
m_reserved1	Reserved parameter: bit 1 - ZoomToExtents auxiliary flag - default value 0 [ExactExtents]. For internal use only. It is strongly NOT recommended to use it in your code!

Enumerations

ColorPolicy	Export color policy. Determines how colors form an original drawing are exported to .pdf file.
ExportHatchesType	Hatches export type.
PDFAccessPermissionsFlags	Enumerates access permission flags for a PDF document.
PDFExportFlags	PDF export flags enumeration that can be used for handling the export process.
PDFExportVersions	PDF format versions enumeration, used during the export process.
PDFMeasuringType	Enumerates measuring types for a PDF document.
PDFShadedViewportExportMode	Shaded viewport export policy
PDF_A_mode	PDF/A format mode enumeration.
PRCSupport	PRC export support enumeration.
SearchableTextType	Searchable text type.

Methods

accessPermissionFlags	Retrieves the current value of the access permission flags.
addLayout	Adds the specified layout to the layouts array to export.
addWatermark	Adds a new watermark.
archived	Retrieves the current value of the PDF/A mode.
author	Retrieves the author of the output PDF document.
background	Retrieves the current value of the background color for the output PDF document.
bookmarksEnabled	Retrieves whether the bookmark creation is enabled.
bwImagesDPI	Retrieves the current value of the resolution for monochrome images in the output PDF document (in dots per inch, dpi).
clearMultipleDbSettings	Clears the multiple database settings (array of databases and array of indexes).
clearPrcBackground	Clears the PRC background color.
clearWatermarks	Clears the Watermarks array.
colorImagesDPI	Retrieves the current value of the resolution for color and grayscale images (in dots per inch, dpi).
colorPolicy	Retrieves the color policy.
creator	Retrieves the output PDF document creator.
database	Retrieves the database to be exported.
databases()	This is the overview for the databases method overload.
dctCompression	Retrieves whether the DCT compression option is enabled.
dctQuality	Retrieves the currently used quality of DCT compression.
enableBookmarks	Sets a new value of the bookmark creation flag.
export2XObject	Retrieves whether XObjects are exported.
exportFlags	Retrieves the current PDF export flags.
exportReactor	Retrieves the current export reactor.
forceDisableGsDevice	Retrieves the current value of the disable gs device for shaded views option.
getGeomDPI	Retrieves the currently used vector resolution (in dots per inch, dpi).
getPRCContext()	This is the overview for the getPRCContext method overload.
getPRCMode	Retrieves the PRC mode option.
getPrcBackground	Retrieves the background color for PRC content.
getPrcExportAmbientColorBehavior	Retrieves the current behaviour when exporting ambient color components to PRC in the texture case.
getPrcRenderingMode	Retrieves the current rendering mode for PRC content.
gradientHatchesExportType	Retrieves the type of gradient hatches export.
hasPrcBackground	Retrieves the PRC background option.
hasPrcBrepCompression	Retrieves the current compression level for B-Rep within PRC content.
hasPrcTessellationCompression	Retrieves whether the tessellation compression for PRC content is enabled.
hatchDPI	Retrieves the current value of the resolution for images created as a result of hatch export (in dots per inch, dpi).
imageCropping	Retrieves whether the image cropping option is enabled.
isParallelDisplay	Retrieves the current value of the parallel display flag. Parallel display flag determines whether the multithreaded displaying is used during the export process. If the flag is equal to true multithreaded displaying is enabled; otherwise, the flag is equal to false.
isParallelVectorization	Retrieves the current value of the parallel vectorization flag. Parallel vectorization flag determines whether the multithreaded vectorization is used during the export process. If the flag is equal to true multithreaded vectorization is enabled; otherwise, the flag is equal to false.
isSHXTextAsGeometry	Determines whether SHX fonts are exported as geometry.
isTTFTextAsGeometry	Determines whether TTF fonts are exported as geometry.
isUsePdfBlocks	Retrieves the current value of the pdf blocks usage option.
isXrefsAsPdfBlocks	Retrieves the current value of the Xrefs as pdf blocks usage option.
keywords	Retrieves keywords associated with the output PDF document.
layouts()	This is the overview for the layouts method overload.
measuringType	Retrieves the current value of the measuring type.
otherHatchesExportType	Retrieves the type of other (non-solid) hatches export.
output	Retrieves the output stream that is used for writing the output PDF file.
ownerPassword	Retrieves the current owner password for the output PDF document.
pageParams	Retrieves the array of page parameters to be used during the exporting.
palette	Retrieves the palette to be used during the exporting.
producer	Retrieves the output PDF document producer.
searchableTextAsHiddenText	Determines whether the searchable text is exported as invisible text.
searchableTextInRenderedViews	Determines whether the searchable text is exported from rendered views.
searchableTextType	Retrieves the current value of the searchable text type.
setAccessPermissionFlags	Sets new access permission flags for the output PDF document.
setArchived	Sets a new PDF/A mode value.
setAuthor	Sets a new value of the author of the output PDF document.
setBWImagesDPI	Sets a new value of the resolution for monochrome images in the output PDF document.
setBackground	Sets a new value of the background color for the output PDF document.
setColorImagesDPI	Sets a new value of the resolution for color and grayscale images.
setColorPolicy	Sets a new export color policy value.
setCreator	Sets a new value of the output PDF document creator.
setDCTCompression	Sets the DCT compression option.
setDCTQuality	Sets a new value of the quality of DCT compression.
setDatabase	Sets a database to be exported.
setExport2XObject	Sets a new value of the XObject export flag. XObject export flag determines whether XObjects are exported (if it is equal to true) or not (if it is equal to false).
setExportFlags	Sets a new export flags value.
setExportReactor	Sets a new export reactor object.
setForceDisableGsDevice	Sets a new value of the disable GS device for shaded views option.
setGeomDPI	Sets a new value for vector resolution.
setGradientHatchesExportType	Sets the type of gradient hatches export.
setHatchDPI	Sets a new value of the resolution for images created as a result of hatch export.
setImageCropping	Sets a new value of the image cropping option.
setKeywords	Sets keywords associated with the output PDF document.
setLayouts	Sets an array of drawing layouts to be exported to PDF.
setMeasuringType	Sets a new measuring type for the output PDF document.
setOtherHatchesExportType	Sets the type of other (non-solid) hatches export.
setOutput	Sets a new output stream object for writing the output PDF file.
setOwnerPassword	Sets a new owner password for the output PDF document.
setPRCCompression	Set the PRC objects compression option.
setPRCContext	Sets prc export context
setPRCMode	Sets export to PRC flag value.
setPageParams	Sets a new array of page parameters to be used during the exporting.
setPalette	Sets a new palette to be used during the exporting.
setParallelDisplay	Sets the parallel display flag value. Parallel display flag determines whether the multithreaded displaying is used during the export process. If the flag is equal to true multithreaded displaying is enabled; otherwise, the flag is equal to false.
setParallelVectorization	Sets the parallel vectorization flag value. Parallel vectorization flag determines whether the multithreaded vectorization is used during the export process. If the flag is equal to true multithreaded vectorization is enabled; otherwise, the flag is equal to false.
setPrcBackground	Sets a new PRC background color.
setPrcExportAmbientColorBehavior	Sets prc behaviour when exporting ambient color components to PRC in the texture case
setPrcRenderingMode	Sets prc rendering mode
setProducer	Sets a new value of the output PDF document producer.
setSearchableTextAsHiddenText	Sets a new value of the invisible text flag. The invisible text flag defines whether the searchable text is exported as invisible text (if equals to true).
setSearchableTextInRenderedViews	Sets a new value of the export from rendered views flag. The export from rendered views flag defines whether the searchable text is exported from rendered views (if equals to true) or not (if equals to false).
setSearchableTextType	Sets a new searchable text type value.
setShadedVpExportMode	Sets a new value of the shaded viewports export mode.
setSolidHatchesExportType	Sets the type of solid hatches export.
setSubject	Sets a new value of the output PDF document subject.
setTitle	Sets a new title for the output PDF document.
setTransparentShadedVpBg	Sets a new value of the shaded views transparency option.
setUpscaleImages	Sets the upscaling option.
setUseGsCache	Sets the GsCache usage flag. The GsCache usage flag determines whether the GsCache is used during the export process (if it is equal to true) or not (if it is equal to false).
setUsePdfBlocks	Sets the using pdf blocks option.
setUseViewExtents	Sets the extents calculation mode value.
setUserPassword	Sets a new user password for the output PDF document.
setVersion	Sets a new value for the version parameter of the output PDF file.
setXrefsAsPdfBlocks	Sets the flag for exporting external references as PDF blocks. When the value equals true, external references are exported as PDF blocks.
shadedVpExportMode	Retrieves the current value of the shaded viewports export mode.
solidHatchesExportType	Retrieves the current type of solid hatches export.
subject	Retrieves a value of the output PDF document subject.
title	Retrieves the current title for the output PDF document.
transparentShadedVpBg	Retrieves the transparency for shaded views option value.
upscaleImages	Retrieves whether the upscaling option is enabled.
useGsCache	Retrieves the current value of the GsCache usage flag. The GsCache usage flag determines whether the GsCache is used during the export process (if it is equal to true) or not (if it is equal to false).
useViewExtents	Retrieves whether the extents calculation mode is enabled.
userPassword	Retrieves the current user password for the output PDF document.
version	Retrieves the version of the output PDF file.
watermarks	Retrieves the array of watermarks.

Links

PDFExportParams Enumerations
PDFExportParams Data Members
PDFExportParams Methods

Relief for ODA Team in Ukraine