.. oe:namespace:: OEDepict


.. meta::
   :keywords: OEReportOptions, ReportOptions


.. _OEDepict_OEReportOptions:

.. oe:class:: OEReportOptions

   .. oe:api::

      class OEReportOptions

   This class represents the :ref:`OEReportOptions <OEDepict_OEReportOptions>` class
   that encapsulates properties that determine the layout of a
   :ref:`OEReport <OEDepict_OEReport>` object.

   See :ref:`Figure: Schematic representation of documents that can be created using the OEReport class<figure_OEReportOptions>`.

   .. _figure_OEReportOptions:

   .. figure:: ../images/OEReportLayout.*
      :align:  center

      **Schematic representation of documents that can be created using the OEReport class**

   The :ref:`OEReportOptions <OEDepict_OEReportOptions>` class stores the following properties:

      .. list-table::
         :widths: 40 40 80 100
         :header-rows: 1

         * - Property
           - Get method
           - Set method
           - Corresponding namespace / class / type

         * - rows per page
           - :oe:meth:`NumRowsPerPage<OEDepict::OEReportOptions::NumRowsPerPage>`
           - set upon construction
           - integer greater than 0

         * - columns per page
           - :oe:meth:`NumColsPerPage<OEDepict::OEReportOptions::NumColsPerPage>`
           - set upon construction
           - integer greater than 0

         * - page width
           - :oe:meth:`GetPageWidth<OEDepict::OEReportOptions::GetPageWidth>`
           - :oe:meth:`SetPageWidth<OEDepict::OEReportOptions::SetPageWidth>` / :oe:meth:`SetPageSize<OEDepict::OEReportOptions::SetPageSize>` / :oe:meth:`SetPageOrientation<OEDepict::OEReportOptions::SetPageOrientation>`
           - floating point number / :oe:constns:`OEDepict::OEPageSize` / :oe:constns:`OEDepict::OEPageOrientation`

         * - page height
           - :oe:meth:`GetPageHeight<OEDepict::OEReportOptions::GetPageHeight>`
           - :oe:meth:`SetPageHeight<OEDepict::OEReportOptions::SetPageHeight>` / :oe:meth:`SetPageSize<OEDepict::OEReportOptions::SetPageSize>` / :oe:meth:`SetPageOrientation<OEDepict::OEReportOptions::SetPageOrientation>`
           - floating point number / :oe:constns:`OEDepict::OEPageSize` / :oe:constns:`OEDepict::OEPageOrientation`

         * - page margins
           - :oe:meth:`GetPageMargin<OEDepict::OEReportOptions::GetPageMargin>`
           - :oe:meth:`SetPageMargin<OEDepict::OEReportOptions::SetPageMargins>` / :oe:meth:`SetPageMargins<OEDepict::OEReportOptions::SetPageMargins>`
           - :oe:constns:`OEDepict::OEMargin`

         * - cell gap
           - :oe:meth:`GetCellGap<OEDepict::OEReportOptions::GetCellGap>`
           - :oe:meth:`SetCellGap<OEDepict::OEReportOptions::SetCellGap>`
           - floating point number

         * - header height
           - :oe:meth:`GetHeaderHeight<OEDepict::OEReportOptions::GetHeaderHeight>`
           - :oe:meth:`SetHeaderHeight<OEDepict::OEReportOptions::SetHeaderHeight>`
           - floating point number

         * - header width
           - :oe:meth:`GetHeaderWidth<OEDepict::OEReportOptions::GetHeaderWidth>`
           -  N/A
           - floating point number

         * - footer height
           - :oe:meth:`GetFooterHeight<OEDepict::OEReportOptions::GetFooterHeight>`
           - :oe:meth:`SetFooterHeight<OEDepict::OEReportOptions::SetFooterHeight>`
           - floating point number

         * - footer width
           - :oe:meth:`GetFooterWidth<OEDepict::OEReportOptions::GetFooterWidth>`
           -  N/A
           - floating point number


   .. seealso::

      * :ref:`OEReport <OEDepict_OEReport>` class


   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEReportOptions(unsigned int rowsperpage = 3u,
                            unsigned int colsperpage = 2u)

      .. oe:language:: python

         .. oe:api:: python

            OEReportOptions(rowsperpage: int = 3, colsperpage: int = 2) -> OEReportOptions

      *rowsperpage*
         The number of rows on each *grid* page of the report.

      *colsperpage*
         The number of columns on each *grid* page of the report.

      .. note::

        Both the number of rows and columns per page have to be greater than 0.

      .. list-table::  **Default parameters of OEReportOptions**
         :widths: 120 600
         :header-rows: 1

         * - Property
           - Default value

         * - rows per page
           - 3

         * - columns per page
           - 2

         * - page width
           - :oe:func:`OEDepict::OEGetPageWidth` ( :oe:const:`OEDepict::OEPageSize::US_Letter` )

         * - page height
           - :oe:func:`OEDepict::OEGetPageHeight` ( :oe:const:`OEDepict::OEPageSize::US_Letter` )

         * - margins
           - 20.0 (for each margins: :oe:const:`top<OEDepict::OEMargin::Top>`, :oe:const:`bottom<OEDepict::OEMargin::Bottom>`, :oe:const:`left<OEDepict::OEMargin::Left>` and :oe:const:`right<OEDepict::OEMargin::Right>`)

         * - cell gap
           - 5.0

         * - header height
           - 0.0 (no header is generated by default)

         * - footer height
           - 0.0 (no footer is generated by default)

      Example (:ref:`Figure: Example of report generation with default options<figure_OEReportOptions_Default>`)

      .. oe:source:: OEReportOptions_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-DEFAULT

      .. oe:source:: OEReportOptions_SetProps.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-DEFAULT

      .. oe:source:: OEReportOptions_SetProps.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-DEFAULT

      .. oe:source:: OEReportOptions_SetProps.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-DEFAULT


      .. _figure_OEReportOptions_Default:

      .. list-table:: **Example of report generation with default options** (The scale of the shown pages is 1:4)
         :widths: 150 150

         * - .. image:: ../images/OEReportOptions_Default-1.*
           - .. image:: ../images/OEReportOptions_Default-2.*

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEReportOptions(const OEReportOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEReportOptions(rhs: OEReportOptions) -> OEReportOptions

      Copy constructor.


   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEReportOptions &operator=(const OEReportOptions &rhs)

      Assignment operator.


   .. oe:method:: GetCellGap

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetCellGap() const

      .. oe:language:: python

         .. oe:api:: python

            GetCellGap() -> float

      Returns the space between the cells of the report.

      .. seealso::

         * :oe:meth:`OEDepict::OEReportOptions::SetCellGap` method

   .. oe:method:: GetCellHeight

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetCellHeight() const

      .. oe:language:: python

         .. oe:api:: python

            GetCellHeight() -> float

      Returns the height of the cells on the *grid* pages of the report.

      .. note::

         The height of the cells depends on the number of rows per page,
         the top and bottom margins, header and footer heights, and
         the gap between the cells


   .. oe:method:: GetCellWidth

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetCellWidth() const

      .. oe:language:: python

         .. oe:api:: python

            GetCellWidth() -> float

      Returns the width of the cells on the *grid* pages of the report.

      .. note::

         The width of the cells depends on the number of columns per page,
         the left and right margins, and the gap between the cells.


   .. oe:method:: GetFooterHeight

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetFooterHeight() const

      .. oe:language:: python

         .. oe:api:: python

            GetFooterHeight() -> float

      Returns the height of the footer at the bottom of each page.

      .. seealso::

         * :oe:meth:`OEDepict::OEReportOptions::SetFooterHeight` method


   .. oe:method:: GetFooterWidth

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetFooterWidth() const

      .. oe:language:: python

         .. oe:api:: python

            GetFooterWidth() -> float

      Returns the width of the footer at the bottom of each page.


   .. oe:method:: GetHeaderHeight

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetHeaderHeight() const

      .. oe:language:: python

         .. oe:api:: python

            GetHeaderHeight() -> float

      Returns the height of the header at the top of each page.

      .. seealso::

         * :oe:meth:`OEDepict::OEReportOptions::SetHeaderHeight` method


   .. oe:method:: GetHeaderWidth

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetHeaderWidth() const

      .. oe:language:: python

         .. oe:api:: python

            GetHeaderWidth() -> float

      Returns the width of the header at the top of each page.

   .. oe:method:: GetPageHeight

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetPageHeight() const

      .. oe:language:: python

         .. oe:api:: python

            GetPageHeight() -> float

      Returns the height of the page of the report.

      .. seealso::

         * :oe:meth:`OEDepict::OEReportOptions::SetPageHeight` method


   .. oe:method:: GetPageMargin

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetPageMargin(unsigned int margin) const

      .. oe:language:: python

         .. oe:api:: python

            GetPageMargin(margin: int) -> float

      Returns the size of a specific page margin of the report.

      *margin*
         This value has to be from the :oe:constns:`OEDepict::OEMargin`
         namespace.

      .. seealso::

         * :oe:meth:`OEDepict::OEReportOptions::SetPageMargin` method
         * :oe:meth:`OEDepict::OEReportOptions::SetPageMargins` method


   .. oe:method:: GetPageWidth

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetPageWidth() const

      .. oe:language:: python

         .. oe:api:: python

            GetPageWidth() -> float

      Returns the width of the page of the report.

      .. seealso::

         * :oe:meth:`OEDepict::OEReportOptions::SetPageWidth` method


   .. oe:method:: NumColsPerPage

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumColsPerPage() const

      .. oe:language:: python

         .. oe:api:: python

            NumColsPerPage() -> int

      Returns the number of columns on each *grid* page of the
      report.

      .. seealso::

         * :oe:meth:`OEDepict::OEReportOptions::NumRowsPerPage` method


   .. oe:method:: NumRowsPerPage

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumRowsPerPage() const

      .. oe:language:: python

         .. oe:api:: python

            NumRowsPerPage() -> int

      Returns the number of rows on each *grid* page of the
      report.

      .. seealso::

         * :oe:meth:`OEDepict::OEReportOptions::NumColsPerPage` method


   .. oe:method:: SetCellGap

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetCellGap(double size)

      .. oe:language:: python

         .. oe:api:: python

            SetCellGap(size: float) -> None

      Sets the space between the cells of the report.

      *size*
         This value has to be a non-negative number.

      Example (:ref:`Figure: Example of using the SetCellGap method<figure_OEReportOptions_SetCellGap>`)

      .. oe:source:: OEReportOptions_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETCELLGAP

      .. oe:source:: OEReportOptions_SetProps.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETCELLGAP

      .. oe:source:: OEReportOptions_SetProps.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETCELLGAP

      .. oe:source:: OEReportOptions_SetProps.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETCELLGAP


      .. _figure_OEReportOptions_SetCellGap:

      .. list-table:: **Example of using the SetCellGap method** (The scale of the shown pages is 1:4)
         :widths: 150 150

         * - .. image:: ../images/OEReportOptions_SetCellGap-1.*
           - .. image:: ../images/OEReportOptions_SetCellGap-2.*

      .. seealso::

         * :oe:meth:`OEDepict::OEReportOptions::GetCellGap` method


   .. oe:method:: SetFooterHeight

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetFooterHeight(double height)

      .. oe:language:: python

         .. oe:api:: python

            SetFooterHeight(height: float) -> None

      Sets the height of the footer at the bottom of each page.

      *height*
         This value has to be a non-negative number.

      .. note::

         `0.0` means that a footer is **not** going to be created
         on the pages.

      Example (:ref:`Figure: Example of using the SetFooterHeight method<figure_OEReportOptions_SetFooterHeight>`)

      .. oe:source:: OEReportOptions_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETFOOTERHEIGHT

      .. oe:source:: OEReportOptions_SetProps.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETFOOTERHEIGHT

      .. oe:source:: OEReportOptions_SetProps.java
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETFOOTERHEIGHT

      .. oe:source:: OEReportOptions_SetProps.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETFOOTERHEIGHT


      .. _figure_OEReportOptions_SetFooterHeight:

      .. list-table:: **Example of using the SetFooterHeight method** (The scale of the shown pages is 1:4)
         :widths: 150 150

         * - .. image:: ../images/OEReportOptions_SetFooterHeight-1.*
           - .. image:: ../images/OEReportOptions_SetFooterHeight-2.*

      .. seealso::

         * :oe:meth:`OEDepict::OEReportOptions::GetFooterHeight` method


   .. oe:method:: SetHeaderHeight

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetHeaderHeight(double height)

      .. oe:language:: python

         .. oe:api:: python

            SetHeaderHeight(height: float) -> None

      Sets the height of the header at the top of each page.

      *height*
         This value has to be a non-negative number.

      .. note::

         `0.0` means that a header is **not** going to be created
         on the pages.

      Example (:ref:`Figure: Example of using the SetHeaderHeight method<figure_OEReportOptions_SetHeaderHeight>`)

      .. oe:source:: OEReportOptions_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETHEADERHEIGHT

      .. oe:source:: OEReportOptions_SetProps.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETHEADERHEIGHT

      .. oe:source:: OEReportOptions_SetProps.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETHEADERHEIGHT

      .. oe:source:: OEReportOptions_SetProps.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETHEADERHEIGHT

      .. _figure_OEReportOptions_SetHeaderHeight:

      .. list-table:: **Example of using the SetHeaderHeight method** (The scale of the shown pages is 1:4)
         :widths: 150 150

         * - .. image:: ../images/OEReportOptions_SetHeaderHeight-1.*
           - .. image:: ../images/OEReportOptions_SetHeaderHeight-2.*

      .. seealso::

         * :oe:meth:`OEDepict::OEReportOptions::GetHeaderHeight` method


   .. oe:method:: SetPageHeight

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetPageHeight(double height)

      .. oe:language:: python

         .. oe:api:: python

            SetPageHeight(height: float) -> None

      Sets the height of the pages of the report.

      *height*
         This number has to be greater than 0.0.

      Example (:ref:`Figure: Example of using the SetPageHeight method<figure_OEReportOptions_SetPageHeight>`)

      .. oe:source:: OEReportOptions_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETPAGEHEIGHT

      .. oe:source:: OEReportOptions_SetProps.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETPAGEHEIGHT

      .. oe:source:: OEReportOptions_SetProps.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETPAGEHEIGHT

      .. oe:source:: OEReportOptions_SetProps.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETPAGEHEIGHT


      .. _figure_OEReportOptions_SetPageHeight:

      .. list-table:: **Example of using the SetPageHeight method** (The scale of the shown pages is 1:4)
         :widths: 150 150

         * - .. image:: ../images/OEReportOptions_SetPageHeight-1.*
           - .. image:: ../images/OEReportOptions_SetPageHeight-2.*

      .. seealso::

         * :oe:meth:`OEDepict::OEReportOptions::SetPageOrientation` method
         * :oe:meth:`OEDepict::OEReportOptions::SetPageSize` method
         * :oe:meth:`OEDepict::OEReportOptions::GetPageWidth` method


   .. oe:method:: SetPageMargin

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetPageMargin(unsigned int margin, double size)

      .. oe:language:: python

         .. oe:api:: python

            SetPageMargin(margin: int, size: float) -> None

      Sets the size of a specific page margin of the report.

      *margin*
         This value has to be from the :oe:constns:`OEDepict::OEMargin`
         namespace.

      *size*
         This value has to be a non-negative number.

      Example (:ref:`Figure: Example of using the SetPageMargin method<figure_OEReportOptions_SetPageMargin>`)

      .. oe:source:: OEReportOptions_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETPAGEMARGIN

      .. oe:source:: OEReportOptions_SetProps.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETPAGEMARGIN

      .. oe:source:: OEReportOptions_SetProps.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETPAGEMARGIN

      .. oe:source:: OEReportOptions_SetProps.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETPAGEMARGIN


      .. _figure_OEReportOptions_SetPageMargin:

      .. list-table:: **Example of using the SetPageMargin method** (The scale of the shown pages is 1:4)
         :widths: 150 150

         * - .. image:: ../images/OEReportOptions_SetPageMargin-1.*
           - .. image:: ../images/OEReportOptions_SetPageMargin-2.*

      .. seealso::

         * :oe:meth:`OEDepict::OEReportOptions::GetPageMargin` method
         * :oe:meth:`OEDepict::OEReportOptions::SetPageMargins` method


   .. oe:method:: SetPageMargins

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetPageMargins(double size)

      .. oe:language:: python

         .. oe:api:: python

            SetPageMargins(size: float) -> None

      Sets the size of all the margins of the report.

      *size*
         This value has to be a non-negative number.

      Example (:ref:`Figure: Example of using the SetPageMargins method<figure_OEReportOptions_SetPageMargins>`)

      .. oe:source:: OEReportOptions_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETPAGEMARGINS

      .. oe:source:: OEReportOptions_SetProps.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETPAGEMARGINS

      .. oe:source:: OEReportOptions_SetProps.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETPAGEMARGINS

      .. oe:source:: OEReportOptions_SetProps.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETPAGEMARGINS


      .. _figure_OEReportOptions_SetPageMargins:

      .. list-table:: **Example of using the SetPageMargins method** (The scale of the shown pages is 1:4)
         :widths: 150 150

         * - .. image:: ../images/OEReportOptions_SetPageMargins-1.*
           - .. image:: ../images/OEReportOptions_SetPageMargins-2.*

      .. seealso::

         * :oe:meth:`OEDepict::OEReportOptions::GetPageMargin` method
         * :oe:meth:`OEDepict::OEReportOptions::SetPageMargin` method


   .. oe:method:: SetPageOrientation

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetPageOrientation(unsigned int orientation)

      .. oe:language:: python

         .. oe:api:: python

            SetPageOrientation(orientation: int) -> None

      Sets the orientation of the pages of the report.

      *orientation*
         This value has to be from the
         :oe:constns:`OEDepict::OEPageOrientation` namespace.


      Example (:ref:`Figure: Example of using the SetPageOrientation method<figure_OEReportOptions_SetPageOrientation>`)

      .. oe:source:: OEReportOptions_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETPAGEORIENTATION

      .. oe:source:: OEReportOptions_SetProps.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETPAGEORIENTATION

      .. oe:source:: OEReportOptions_SetProps.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETPAGEORIENTATION

      .. oe:source:: OEReportOptions_SetProps.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETPAGEORIENTATION


      .. _figure_OEReportOptions_SetPageOrientation:

      .. list-table:: **Example of using the SetPageOrientation method** (The scale of the shown pages is 1:4)
         :widths: 150 150

         * - .. image:: ../images/OEReportOptions_SetPageOrientation-1.*
           - .. image:: ../images/OEReportOptions_SetPageOrientation-2.*

      .. seealso::

         * :oe:meth:`OEDepict::OEReportOptions::SetPageHeight` method
         * :oe:meth:`OEDepict::OEReportOptions::SetPageSize` method
         * :oe:meth:`OEDepict::OEReportOptions::SetPageWidth` method

   .. oe:method:: SetPageSize

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetPageSize(unsigned int pagesize)

      .. oe:language:: python

         .. oe:api:: python

            SetPageSize(pagesize: int) -> None

      Sets the width and height of the pages of the report.

      *pagesize*
         This value has to be from the :oe:constns:`OEDepict::OEPageSize`
         namespace.

      Example (:ref:`Figure: Example of using the SetPageSize method<figure_OEReportOptions_SetPageSize>`)

      .. oe:source:: OEReportOptions_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETPAGESIZE

      .. oe:source:: OEReportOptions_SetProps.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETPAGESIZE

      .. oe:source:: OEReportOptions_SetProps.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETPAGESIZE

      .. oe:source:: OEReportOptions_SetProps.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETPAGESIZE


      .. _figure_OEReportOptions_SetPageSize:

      .. list-table:: **Example of using the SetPageSize method** (The scale of the shown pages is 1:4)
         :widths: 150 150

         * - .. image:: ../images/OEReportOptions_SetPageSize-1.*
           - .. image:: ../images/OEReportOptions_SetPageSize-2.*

      .. seealso::

         * :oe:meth:`OEDepict::OEReportOptions::SetPageOrientation` method
         * :oe:meth:`OEDepict::OEReportOptions::SetPageHeight` method
         * :oe:meth:`OEDepict::OEReportOptions::SetPageWidth` method


   .. oe:method:: SetPageWidth

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetPageWidth(double width)

      .. oe:language:: python

         .. oe:api:: python

            SetPageWidth(width: float) -> None

      Sets the width of the pages of the report.

      *width*
         This number has to be greater than 0.0.

      Example (:ref:`Figure: Example of using the SetPageWidth method<figure_OEReportOptions_SetPageWidth>`)

      .. oe:source:: OEReportOptions_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETPAGEWIDTH

      .. oe:source:: OEReportOptions_SetProps.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETPAGEWIDTH

      .. oe:source:: OEReportOptions_SetProps.java
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETPAGEWIDTH

      .. oe:source:: OEReportOptions_SetProps.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETPAGEWIDTH


      .. _figure_OEReportOptions_SetPageWidth:

      .. list-table:: **Example of using the SetPageWidth method** (The scale of the shown pages is 1:4)
         :widths: 150 150

         * - .. image:: ../images/OEReportOptions_SetPageWidth-1.*
           - .. image:: ../images/OEReportOptions_SetPageWidth-2.*

      .. seealso::

         * :oe:meth:`OEDepict::OEReportOptions::SetPageOrientation` method
         * :oe:meth:`OEDepict::OEReportOptions::SetPageHeight` method
         * :oe:meth:`OEDepict::OEReportOptions::SetPageSize` method
