.. highlightlang:: us

.. index:: ObjGetProps

.. _ObjGetProps:

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

.. us.tag  ObjGetProps GERMAN New5800

:ref:`ObjGetProps` liefert die Eigenschaften eines Diagramms oder eines
Zeichenobjekts.

.. function::  oProps = ObjGetProps(hObj)

.. us.return

**Returnwert**

*oProps* enthält die Eigenschaften eines Diagramms oder Zeichenobjekts, siehe 
:ref:`LayerGetProps`,
:ref:`TBGetProps`,
:ref:`EBGetProps`,
:ref:`LBGetProps`,
:ref:`RBGetProps`,
:ref:`TableGetProps`,
:ref:`ImageGetProps`.

.. :ref:`FontGetProps`,
.. :ref:`PenGetProps`,
.. :ref:`OLEGetProps`,
.. :ref:`PageGetProps`,
.. :ref:`XYGetProps`,
.. :ref:`XYZGetProps`.

.. us.params

**Parameter**

.. uparam:: hObj

   *hObj* ist die Zugriffsnummer einer Seite, eines Diagramms, eines
   Zeichenobjekts oder eines Datensatzes.

.. us.comment

**Kommentar**

.. note::

   Diese Funktion ist eine Beta-Version. Die Release-Version wird in einem der
   nächsten Updates fertig gestellt.

**Hilfsfunktionen**

.. index:: props_flat

.. _props_flat:

props_flat
--------------

.. us.tag  props_flat NOTREADYGERMAN New5800 props

:ref:`props_flat` wandelt ein Objekt, dass weitere Objekte enthält, in ein Objekt
mit nur noch einer Ebene um. Mit :ref:`props_unflat` kann das Ausgangsobjekt 
wieder erzeugt werden.

.. 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` siehe :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` liefert ein Objekt mit den angegebenen Schlüsseln (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` entfernt Elemente aus einem Objekt.

.. 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` wandelt einen String mit "Key=Value"-Paaren in ein Objekt
um.

.. function:: o = props_fromstring(s)

::

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

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

.. index:: props_tostring

.. _props_tostring:

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

.. us.tag  props_tostring NOTREADYGERMAN New5800 props

:ref:`props_tostring` wandelt das Objekt in einen String oder eine 2-spaltige
Stringmatrix um.

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

Der optionale zweite Parameter ist ein Objekt mit folgendem Defaultwert:
``[. 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` gibt eine einfache Dialogbox aus mit der die Properties 
angezeigt und ausgewählt werden können. Das Ergebnis ist ein String mit den
ausgewählten Eigenschafts-Namen (Keys).

.. function:: s = props_dialog(o)

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

.. index:: props_diff

.. _props_diff:

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

.. us.tag  props_diff NOTREADYGERMAN New5800 props

:ref:`props_diff` liefert alle Properties aus *o1* und *o2* die nicht gleich sind.
Die Property-Werte werden *o1* entnommen, falls vorhanden.

.. 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
     - Beschreibung
   * - R2016
     - Neu.

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

:sub:`id-1611894`