.. highlightlang:: us

.. index:: PenDialog

.. _pendialog:

PenDialog
=========

.. us.tag  PenDialog ENGLISH DialogBoxes

:ref:`PenDialog` displays a dialog box to configure a pen object.

.. function::  hNewPen = PenDialog()
    hNewPen = PenDialog(hPen)
    hNewPen = PenDialog(nStyle, nWidth, rvColorRGB)

.. us.return

**Return Value**

*hNewPen* is the pen handle. If the pen cannot be created, *hPen* is 0. If
the Cancel button was selected, -1 is returned.

.. us.params

**Parameters**

.. uparam:: nStyle

   *nStyle* is one of the following values:

   .. list-table::
      :header-rows: 1

      * - Value
        - Meaning
      * - PS_SOLID
        - solid line pen
      * - PS_DASH
        - dash pen
      * - PS_DOT
        - dot pen
      * - PS_DASHDOT
        - dash dot pen
      * - PS_DASHDOTDOT
        - dash dot dot pen
      * - PS_NULL
        - invisible pen

.. uparam:: nWidth

   *nWidth* is the width of the pen in 0.1 mm.

.. uparam:: rvColorRGB

   *rvColorRGB* is a vector with 3 elements that sets pen color:

   .. list-table::
      :header-rows: 1

      * - Value
        - Meaning
      * - rvColorRGB[1]
        - Red (0 to 255)
      * - rvColorRGB[2]
        - Green (0 to 255)
      * - rvColorRGB[3]
        - Blue (0 to 255)

.. seealso::
   :ref:`overview-pens`,
   :ref:`PenCreate`,
   :ref:`PenDestroy`

:sub:`id-1334085`