.. _ScriptUIImage:

================================================
ScriptUIImage
================================================


Description
-----------

Encapsulates a set of images that can be drawn into a control.

Different images can reflect the current state, such as a dimmed version for a disabled control. Create with the?newImage()?method. Passed as an argument to?drawImage().


Properties
^^^^^^^^^^

+--------------------------------------------------+--------------------------------------------------------------------------------+
| :ref:`format<ScriptUIImage.format>` readonly     | The image format. One of: resource, JPEG, GIF, TIFF, PNG, or PICT (Macintosh). |
+--------------------------------------------------+--------------------------------------------------------------------------------+
| :ref:`name<ScriptUIImage.name>` readonly         | The image name. Either the file name, or the resource name.                    |
+--------------------------------------------------+--------------------------------------------------------------------------------+
| :ref:`pathname<ScriptUIImage.pathname>` readonly | The full path to the file that contains the image.                             |
+--------------------------------------------------+--------------------------------------------------------------------------------+
| :ref:`size<ScriptUIImage.size>` readonly         | The image size in pixels.                                                      |
+--------------------------------------------------+--------------------------------------------------------------------------------+














.. container:: hide

   .. toctree::
      :hidden:
      :maxdepth: 1

      ScriptUIImage/format.rst
      ScriptUIImage/name.rst
      ScriptUIImage/pathname.rst
      ScriptUIImage/size.rst