Close

Relief for ODA Team in Ukraine

Learn more
ODA BimRv SDK
Export to .pdf File Parameters and Flags

The export process can be managed with a set of parameters and flags that determine how the export should be executed.

PDF export parameters are listed in the table below.

Export parameter name Description Get-method Set-method
Database for export A pointer to a database to be exported into a .pdf file. database() setDatabase()
Output stream for writing to .pdf file A reference to an OdStreamBuff pointer, representing the output stream object to be used for writing data into a .pdf file. output() setOutput()
Version Version of the output .pdf file. version() setVersion()
Color policy Color policy to be used for creating export output. colorPolicy() setColorPolicy()
Vectorizing resolution Resolution used for vectorizing the output .pdf file (in dots per inch, DPI). Standard values are: 72, 150, 200, 300, 400, 600, 720, 1200, 2400 and 4800 DPI. Default value is 600 DPI. getGeomDPI() setGeomDPI()
Resolution for monochrome images Resolution for monochrome images created during hatch export (in dots per inch, DPI). bwImagesDPI() setBWImagesDPI()
Image cropping Parameter determines how clipped images are exported. An image can be clipped by a clipping boundary (for example, by a boundary of a page in a .pdf file or by a viewport boundary). If the parameter value is equal to false, the image is exported as the full image; in the other case only the visible part of the image is exported. imageCropping() setImageCropping()
Image DCT compression Parameter determines whether the DCT compression algorithm is used for exporting images. The DCT compression algorithm is used if the parameter value is equal to true. Using DCT compression significantly reduces of the output .pdf file size. dctCompression() setDCTCompression()
Image DCT compression quality Determines the quality of the image DCT compression. This parameter is applied only if the Image DCT parameter is equal to true. dctQuality() setDCTQuality()
Output document's title Title of the output .pdf file. title() setTitle()
Output document's author Name of the person who created the output .pdf file. author() setAuthor()
Output document's subject Subject of the output .pdf file. subject() setSubject()
Output document's keywords Keywords associated with the output .pdf file. keywords() setKeywords()
Output document's creator Name of the application (for example, Adobe FrameMaker) that has created the original .rvt/.rfa files from which it was converted to the output PDF document. creator() setCreator()
Output document's producer Name of the application (for example, Adobe Acrobat Distiller) that has converted the original .rvt/.rfa file to the output .pdf file. producer() setProducer()
Export with searchable text Determines whether the text from an original .rvt/.rfa file can be searched in the output .pdf file. Parameter is used only if text, that is displayed with an associated font type (SHX or TTF), is exported as geometry. Parameter can accept one of these values:
  • kNoSearch - Default value: no searchable text in the output.
  • kTTF - Text displayed with TTF fonts will be searchable if TTF text as geometry flag is switched on.
searchableTextType() setSearchableTextType()

The PDF export flags are stored in the PDFExportParams::PDFExportFlags enumerator, which is a member of the PDFExportParams class. PDF export options are determined by the parameters' values and combination of parameter flags.

Default combination of export flags is kTTFTextAsGeometry|kFlateCompression|kZoomToExtentsMode, i.e.:

  • TTF text as geometry flag is switched on.
  • Data compression flag is switched on.
  • Zoom to extents mode is switched on.
  • Other flags are switched off.

Full list of the PDF export flags is represented in the following table.

Export parameter Parameter name Description
Use embedded TTF kEmbededTTF Enable embedding of the True Type font files in the .pdf file.
TTF text as geometry kTTFTextAsGeometry Enable True Type font text to geometry conversion.
Use geometry optimization kSimpleGeomOptimization Determines whether simple geometry optimization is enabled during the export process (separated segments combined to one polyline, Bezier curve control points).
Embedded TTF optimization kEmbededOptimizedTTF Enables reducing of the True Type font file size which is embedded in the output .pdf file.
Data compression kFlateCompression Determines whether a data compression algorithm is applied when writing .rvt/.rfa file data in the internal PDF stream.
Hexadecimal encoding kASCIIHexEncoding Determines whether data is written in the internal PDF stream as hexadecimal format.
Exporting hyper links support kExportHyperlinks Enable exporting hyperlinks to the output .pdf file.
Zoom to extents mode kZoomToExtentsMode Determines whether the exported .rvt/.rfa file is in the Zoom to Extents mode.
Create a linearized .pdf file kLinearized Determines whether the export process creates a linearized .pdf file from the exported .rvt/.rfa file.
Merge crossing lines colors kMergeLines Determines whether the colors of crossing lines are merged.

Special values of flags can also be used:

  • kZeroFlag (0) means that all flags are disabled.
  • kDefault stores the default value of the flag combination (currently it is the only provided method to export to PDF).

To get the current combination of export flags, use the exportFlags() method of the PDFExportParams class. To set a new combination of export flags as the current one, use the setExportFlags() method of the PDFExportParams class.

See Also

Export to .pdf File

Copyright © 2002 – 2022. Open Design Alliance. All rights reserved.