.. _GenericPDFOpenOptions:

================================================
GenericPDFOpenOptions
================================================


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

Options that can be specified when opening a generic PDF document.






Static Properties
^^^^^^^^^^^^^^^^^

+----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`antiAlias<GenericPDFOpenOptions.antiAlias>` readonly                       | If true, anti-aliasing is used.                                                                                           |
+----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`bitsPerChannel<GenericPDFOpenOptions.bitsPerChannel>` readonly             | The number of bits per channel.                                                                                           |
+----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`constrainProportions<GenericPDFOpenOptions.constrainProportions>` readonly | DEPRECATED.                                                                                                               |
+----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`cropPage<GenericPDFOpenOptions.cropPage>` readonly                         | The cropping method to use.                                                                                               |
+----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`height<GenericPDFOpenOptions.height>` readonly                             | DEPRECATED.                                                                                                               |
+----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`mode<GenericPDFOpenOptions.mode>` readonly                                 | The document mode.                                                                                                        |
+----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`name<GenericPDFOpenOptions.name>` readonly                                 | The name of the document.                                                                                                 |
+----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`object<GenericPDFOpenOptions.object>` readonly                             | The number of the 3d object to open.                                                                                      |
+----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`page<GenericPDFOpenOptions.page>` readonly                                 | The number of the page or image to open.                                                                                  |
+----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`resolution<GenericPDFOpenOptions.resolution>` readonly                     | The resolution of the document (in pixels per inch)                                                                       |
+----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`suppressWarnings<GenericPDFOpenOptions.suppressWarnings>` readonly         | If true, suppresses any warnings that may occur during opening.                                                           |
+----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`use3DObjectNumber<GenericPDFOpenOptions.use3DObjectNumber>` readonly       | If true, the value specified in the page property refers to a page number. If false, the value specifies an image number. |
+----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`usePageNumber<GenericPDFOpenOptions.usePageNumber>` readonly               | If true, the value specified in the page property refers to a page number. If false, the value specifies an image number. |
+----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`width<GenericPDFOpenOptions.width>` readonly                               | DEPRECATED.                                                                                                               |
+----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+












.. container:: hide

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

      
      GenericPDFOpenOptions/resolution.rst
      GenericPDFOpenOptions/mode.rst
      GenericPDFOpenOptions/antiAlias.rst
      GenericPDFOpenOptions/page.rst
      GenericPDFOpenOptions/object.rst
      GenericPDFOpenOptions/constrainProportions.rst
      GenericPDFOpenOptions/height.rst
      GenericPDFOpenOptions/width.rst
      GenericPDFOpenOptions/bitsPerChannel.rst
      GenericPDFOpenOptions/usePageNumber.rst
      GenericPDFOpenOptions/use3DObjectNumber.rst
      GenericPDFOpenOptions/name.rst
      GenericPDFOpenOptions/cropPage.rst
      GenericPDFOpenOptions/suppressWarnings.rst