.. highlightlang:: us

.. _tablegetbrushlist:

TableGetBrushList
=================

.. index:: TableGetBrushList

.. us.tag  TableGetBrushList table.fonts New400

:ref:`TableGetBrushList` returns a matrix with 3 columns. Each row specifies
a color used in the table.

.. function::  rmColorRGB = TableGetBrushList(hTable)

.. us.return

**Return Value**

*rmColorRGB* is a matrix with 3 columns:

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

      * - Value
        - Description
      * - rmColorRGB[1]
        - Red in the range of 0 to 255
      * - rmColorRGB[2]
        - Green in the range of 0 to 255
      * - rmColorRGB[3]
        - Blue in the range of 0 to 255

The row number is the color index used in :ref:`TableGetBrushIndex`.

To set a cell to transparent set the index to 0.

.. us.params

**Parameters**

.. uparam:: hTable

   Identifies the table object.

.. us.comment

**Comment**

The brush list can contain unused colors. When the document is saved the unused
brushes will be removed.

.. seealso::
   :ref:`overview-table`,
   :ref:`TableGetBrushIndex`,
   :ref:`TableSetBrushIndex`,
   :ref:`TableAddBrush`

:sub:`id-1913359`