.. _DocumentPrintSettings:

================================================
DocumentPrintSettings
================================================


Description
-----------

Print settings for a document.




Properties
^^^^^^^^^^

+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`activePrinter<DocumentPrintSettings.activePrinter>` readonly         | Currently selected printer.                                                                                       |
+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`backgroundColor<DocumentPrintSettings.backgroundColor>` readonly     | Background color of page.                                                                                         |
+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`bleedWidth<DocumentPrintSettings.bleedWidth>` readonly               | Bleed width.                                                                                                      |
+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`caption<DocumentPrintSettings.caption>` readonly                     | Description field from File Info.                                                                                 |
+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`centerCropMarks<DocumentPrintSettings.centerCropMarks>` readonly     | Print center crop marks.                                                                                          |
+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`colorBars<DocumentPrintSettings.colorBars>` readonly                 | Print color calibration bars.                                                                                     |
+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`colorHandling<DocumentPrintSettings.colorHandling>` readonly         | Color handling.                                                                                                   |
+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`copies<DocumentPrintSettings.copies>` readonly                       | Number of copies.                                                                                                 |
+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`cornerCropMarks<DocumentPrintSettings.cornerCropMarks>` readonly     | Print corner crop marks.                                                                                          |
+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`docPosition<DocumentPrintSettings.docPosition>` readonly             | Position of image when printing.                                                                                  |
+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`flip<DocumentPrintSettings.flip>` readonly                           | Flip the image horizontally.                                                                                      |
+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`hardProof<DocumentPrintSettings.hardProof>` readonly                 | Print a hard proof.                                                                                               |
+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`interpolate<DocumentPrintSettings.interpolate>` readonly             |                                                                                                                   |
+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`labels<DocumentPrintSettings.labels>` readonly                       | Prints the document title.                                                                                        |
+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`mapBlack<DocumentPrintSettings.mapBlack>` readonly                   | Map blacks.                                                                                                       |
+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`negative<DocumentPrintSettings.negative>` readonly                   | Invert the image colors.                                                                                          |
+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`parent<DocumentPrintSettings.parent>` readonly                       | The object's container.                                                                                           |
+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`posX<DocumentPrintSettings.posX>` readonly                           | X position of image on page.                                                                                      |
+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`posY<DocumentPrintSettings.posY>` readonly                           | Y position of image on page.                                                                                      |
+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`printBorder<DocumentPrintSettings.printBorder>` readonly             | Width of the print border.                                                                                        |
+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`printSpace<DocumentPrintSettings.printSpace>` readonly               | Color space for printer. Can be nothing (meaning same as source) or a string specifying a specific color profile. |
+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`printerName<DocumentPrintSettings.printerName>` readonly             | Name of printer.                                                                                                  |
+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`printers<DocumentPrintSettings.printers>` readonly                   | List of available printers.                                                                                       |
+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`registrationMarks<DocumentPrintSettings.registrationMarks>` readonly | Print registration marks.                                                                                         |
+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`renderIntent<DocumentPrintSettings.renderIntent>` readonly           | Color conversion intent when print space is different from the source space.                                      |
+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`scale<DocumentPrintSettings.scale>` readonly                         | Scale of image on page.                                                                                           |
+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`typename<DocumentPrintSettings.typename>` readonly                   | The class name of the object.                                                                                     |
+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`vectorData<DocumentPrintSettings.vectorData>` readonly               | Include vector data.                                                                                              |
+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+







Methods
^^^^^^^

+------------------------------------------------------------------------+--------------------------------------------+
| :ref:`setPagePosition<DocumentPrintSettings.setPagePosition>` readonly | Set the position of the image on the page. |
+------------------------------------------------------------------------+--------------------------------------------+






.. container:: hide

   .. toctree::
      :hidden:
      :maxdepth: 1

      DocumentPrintSettings/parent.rst
      DocumentPrintSettings/typename.rst
      DocumentPrintSettings/caption.rst
      DocumentPrintSettings/labels.rst
      DocumentPrintSettings/cornerCropMarks.rst
      DocumentPrintSettings/centerCropMarks.rst
      DocumentPrintSettings/colorBars.rst
      DocumentPrintSettings/registrationMarks.rst
      DocumentPrintSettings/negative.rst
      DocumentPrintSettings/flip.rst
      DocumentPrintSettings/interpolate.rst
      DocumentPrintSettings/vectorData.rst
      DocumentPrintSettings/backgroundColor.rst
      DocumentPrintSettings/renderIntent.rst
      DocumentPrintSettings/hardProof.rst
      DocumentPrintSettings/printSpace.rst
      DocumentPrintSettings/mapBlack.rst
      DocumentPrintSettings/printBorder.rst
      DocumentPrintSettings/bleedWidth.rst
      DocumentPrintSettings/colorHandling.rst
      DocumentPrintSettings/copies.rst
      DocumentPrintSettings/docPosition.rst
      DocumentPrintSettings/posY.rst
      DocumentPrintSettings/posX.rst
      DocumentPrintSettings/printerName.rst
      DocumentPrintSettings/scale.rst
      DocumentPrintSettings/activePrinter.rst
      DocumentPrintSettings/printers.rst
      
      

      DocumentPrintSettings/setPagePosition.rst