.. highlightlang:: us

.. index:: ObjGetProps

.. _ObjGetProps:

ObjGetProps
===========

.. us.tag  ObjGetProps ENGLISH New5800

:ref:`ObjGetProps` returns the properties of a document page, diagram or 
drawing object.

.. function::  oProps = ObjGetProps(hObj)

.. us.return

**Return Value**

*oProps*.

.. us.params

**Parameters**

.. uparam:: hObj

   *hObj* is the handle of a layer or drawing object.

.. us.comment

**Comment**

.. note::

   This function is a beta version. The release version will be available
   in one of the next updates.

**Hilfsfunktionen**

.. index:: props_flat

.. _props_flat:

props_flat
----------

.. us.tag  props_flat NOTREADYGERMAN New5800 props

:ref:`props_flat` converts an object with nested objects into an object 
with only one level. With :ref:`props_unflat` this conversion can be undone.

.. function:: r = props_flat(o)

::

   * a
   [.
       b = [.
           c = 1
           d = [.
               a = 1
           ]
       ]
       c = "Hello"
   ]
   * props_flat(a)
   [.
       b.c = 1
       b.d.a = 1
       c = "Hello"
   ]

.. ------------------------------------------------------------------------------

.. index:: props_unflat

.. _props_unflat:

props_unflat
------------

.. us.tag  props_unflat NOTREADYGERMAN New5800 props

:ref:`props_unflat` see :ref:`props_flat`.

.. function:: r = props_unflat(o)

::

   * b
   [.
       b.c = 1
       b.d.a = 1
       c = "Hello"
   ]
   * props_unflat(b)
   [.
       b = [.
           c = 1
           d = [.
               a = 1
           ]
       ]
       c = "Hello"
   ]

.. ------------------------------------------------------------------------------

.. index:: props_get

.. _props_get:

props_get
---------

.. us.tag  props_get NOTREADYGERMAN New5800 props

:ref:`props_get` returns a object with the given keys.

.. function:: r = props_get(o, keys)

::

   * props_get([. a = 1, b = 2, c = 3], "a c")
   [.
       a = 1
       c = 3
   ]

.. ------------------------------------------------------------------------------

.. index:: props_remove

.. _props_remove:

props_remove
------------

.. us.tag  props_remove NOTREADYGERMAN New5800 props

:ref:`props_remove` removes elements from a given object.

.. function:: r = props_remove(o, keys)

::

   * props_remove([. a = 1, b = 2], "a")
   [.
       b = 2
   ]
   * props_remove([. a = 1, b = 2], "a b")
   [.
   ]

.. ------------------------------------------------------------------------------

.. index:: props_fromstring

.. _props_fromstring:

props_fromstring
----------------

.. us.tag  props_fromstring NOTREADYGERMAN New5800 props

:ref:`props_fromstring` converts a string with "Key=Value" pairs into an object.

.. function:: o = props_fromstring(s)

::

   * props_fromstring("a = 12.34 b = Hello")
   [.
       a = 12.34
       b = "Hello"
   ]

.. ------------------------------------------------------------------------------

.. index:: props_tostring

.. _props_tostring:

props_tostring
--------------

.. us.tag  props_tostring NOTREADYGERMAN New5800 props

:ref:`props_tostring` converts an object into a string or string matrix with
2 columns.

.. function:: s = props_tostring(o)
              s = props_tostring(o, options)

The second optional parameter is an object with the following default value:
``[. tomatrix = 1, nodefault = 1]``.

::

   * o = ObjGetProps(39)
   * o
   [.
       arrow-lenght = 5
       ...
       x1 = 4.7
   ]
   * props_tostring(o)
   x1     4.7
   arrow-lenght   5

   * props_tostring(o, [.tomatrix=0])
   x1='4.7' arrow-lenght='5'

.. ------------------------------------------------------------------------------

.. index:: props_dialog

.. _props_dialog:

props_dialog
--------------

.. us.tag  props_dialog NOTREADYGERMAN New5800 props

:ref:`props_dialog` displays a simple dialog box to select properties.
The result is a string with the property names.

.. function:: s = props_dialog(o)

.. ------------------------------------------------------------------------------

.. index:: props_diff

.. _props_diff:

props_diff
--------------

.. us.tag  props_diff NOTREADYGERMAN New5800 props

:ref:`props_diff` returns an object with properties which are not 
identical in *o1* and *o2*. The property values of  *o1* are returned.

.. function:: r = props_diff(o1, o2)

::

   * props_diff([. a = 1, b = 1], [. a = 1, b = 2, c = 3])
   [.
       b = 1
       c = 3
   ]

.. ------------------------------------------------------------------------------

.. us.history

**History**

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

   * - Version
     - Description
   * - R2016
     - New.

.. seealso::
   :ref:`overview-objects`,
   :ref:`ObjSetProps`,
   :ref:`ObjGetXML`,
   :ref:`ObjCreateXML`,
   :ref:`LayerGetProps`,
   :ref:`TBGetProps`,
   :ref:`EBGetProps`,
   :ref:`LBGetProps`,
   :ref:`RBGetProps`,
   :ref:`TableGetProps`,
   :ref:`ImageGetProps`

:sub:`id-1611894`