.. highlightlang:: us

.. index:: OBJSetBkMode

.. _objsetbkmode:

OBJSetBkMode
============

.. us.tag  OBJSetBkMode NOTREADYENGLISH draw-set

:ref:`OBJSetBkMode` sets the background mode of a drawing object or diagram.

.. function::  bool = OBJSetBkMode(hobj, nMode)

.. us.return

**Return Value**

If the function succeeds, the return value *bool* is TRUE (1); otherwise
it is FALSE (0).

.. us.params

**Parameters**

.. uparam:: hobj

   *hobj* identifies a line, text, rectangle, ellipse or layer (diagram) object.

.. uparam:: nMode

   *nMode* is the background mode of the object. 0 is OPAQUE and
   1 is TRANSPARENT.

.. us.example

**Example**

::

   hDoc = DocCreate()
   hPage = PageCreate()
   DocAddPage(hDoc, hPage);
   hLayer = LayerCreate()
   PageAddLayer(hPage, hLayer)
   hRb = RBCreate()
   LayerAddObjects(hLayer, hRb)
   OBJSetPosSize(hRb, [3, -8, 3, 3])
   OBJSetBkMode(hRb, 0)    // OPAQUE
   OBJSetSelect(hRb, FALSE)    // Deselect Object
   PageReplot(hPage)

.. seealso::
   :ref:`overview-drawing-objects`,
   :ref:`OBJGetBkMode`

:sub:`id-1392630`