.. highlightlang:: us

.. index:: ImageGetProps

.. _imagegetprops:

ImageGetProps
==============

.. us.tag  ImageGetProps ENGLISH ImageGet New5800

:ref:`ImageGetProps` gets the image properties.

.. function::  o = ImageGetProps(hImage)

.. us.return

**Return Value**

*o*

**image**

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

   * - Name
     - Type
     - Default Value
     - Comment
   * - type
     - string
     - image
     - 
   * - name
     - string
     - 
     - 
   * - @atts_xy_width_height
     - 
     - 
     - 
   * - external-filename
     - string
     - 
     - 
   * - link-type
     - int
     - 1
     - Embedded:1 linked:2 both:3
   * - frame
     - bool
     - 0
     - 
   * - frame-width
     - double
     - 1
     - 
   * - frame-color
     - @color
     - black
     - 

**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
     - 

.. us.params

**Parameters**

.. uparam:: hLB

   Identifies the line block.

.. us.history

**History**

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

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

.. seealso::
   :ref:`overview-pictures`,
   :ref:`ImageCreate`,
   :ref:`ImageSetProps`,
   :ref:`ObjSetProps`

:sub:`id-1282893`