.. highlightlang:: us

.. _tablegetalign:

TableGetAlign
=============

.. index:: TableGetAlign

.. us.tag  TableGetAlign table.get New400

:ref:`TableGetAlign` retrieves the text alignment for all cells or a range of cells. 

.. function::  rmAlign = TableGetAlign(hTable)
    rmAlign = TableGetAlign(hTable, rvSel)

.. us.return

**Return Value**

*rmAlign* is a matrix with text align values. Each element can be one
of the following combinations:

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

      * - Value
        - Meaning
      * - LEFT | TOP
        - Left top
      * - LEFT | MIDDLE
        - Left center
      * - LEFT | BOTTOM
        - Left bottom
      * - CENTER | TOP
        - Center top
      * - CENTER | MIDDLE
        - Center center
      * - CENTER | BOTTOM
        - Center bottom
      * - RIGHT | TOP
        - Right top
      * - RIGHT | MIDDLE
        - Right center
      * - RIGHT | BOTTOM
        - Right bottom

.. us.params

**Parameters**

.. uparam:: hTable

   Identifies the table object.

.. uparam:: rvSel

   *rvSel* is a vector with four elements specifying a range of rows and columns:

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

      * - Element
        - Description
      * - rvSel[1]
        - Left column of selection
      * - rvSel[2]
        - Top row of selection
      * - rvSel[3]
        - Right column of selection
      * - rvSel[4]
        - Bottom row of selection

   The column and row numbering starts with 1. Left is smaller than right and
   top is smaller than bottom.

In the following example the text will be aligned to the upper edge without 
changing the horizontal alignment:

::

   rmAlign = TableGetAlign(hTable);
   rmAlign = rmAlign & ~(G_TOP | G_MIDDLE |G_BOTTOM) | G_TOP;
   TableSetAlign(hTable, rmAlign);

.. seealso::
   :ref:`overview-table`,
   :ref:`TableSetAlign`

:sub:`id-1031124`