.. highlightlang:: us

.. index:: RBGetProps

.. _rbgetprops:

RBGetProps
============

.. us.tag  RBGetProps ENGLISH RBGet New5800

:ref:`RBGetProps` gets the rect box properties.

.. function::  o = RBGetProps(hRB)

.. us.return

**Return Value**

*o*

**rect**

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

   * - Name
     - Type
     - Default Value
     - Comment
   * - type
     - string
     - rect
     - 
   * - name
     - string  
     -        
     -  Object name
   * - @atts_xy_width_height
     - 
     - 
     - 
   * - @atts_pen
     - 
     - 
     - 
   * - flags
     - @flags
     - 
     - 
   * - @atts_background
     - 
     - 
     - 
   * - millimeter-lines
     - bool
     - 0
     - 

**atts_xy_width_height**

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

   * - Name
     - Type
     - Default Value
     - Comment
   * -  x               
     - double
     - 1.0
     -  x position in cm or diagram coordinates
   * -  y               
     - double
     - -1.0
     -  
   * -  width           
     - double
     - 1.0
     -  
   * -  height          
     - double
     - 1.0
     - 

**atts_pen**

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

   * - Name
     - Type
     - Default Value
     - Comment
   * - stroke-type
     - int
     - 0
     - 
   * - stroke-width
     - int
     - 1
     - 
   * - stroke-color
     - @color
     - black
     - 

**atts_background**

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

   * - Name
     - Type
     - Default Value
     - Comment
   * - bkmode
     - @bkmode
     - transparent
     -  opaque:0  transparent:1
   * - gradient
     - bool
     - 0
     - 
   * - gradient-colors
     - @color
     - white grey
     - 
   * - fill-color
     - @color
     - black
     - 

.. us.params

**Parameters**

.. uparam:: hRB

   Identifies the rect.

.. us.history

**History**

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

   * - Version
     - Description
   * - R2016.0
     - New.

.. seealso::
   :ref:`overview-rectangles`,
   :ref:`RBCreate`,
   :ref:`RBSetProps`,
   :ref:`ObjSetProps`

:sub:`id-846861`