.. highlightlang:: us

.. _tablesetalign:

TableSetAlign
=============

.. index:: TableSetAlign

.. us.tag  TableSetAlign table.set New400

:ref:`TableSetAlign` sets the text alignment for all cells or a range of cells.

.. function::  bool = TableSetAlign(hTable, rmAlign)
    bool = TableSetAlign(hTable, rmAlign, rvSel)

.. us.return

**Return Value**

If the function succeeds, the return value *bool* is TRUE (1); otherwise
it is FALSE (0).

.. us.params

**Parameters**

.. uparam:: hTable

   Identifies the table object.

.. uparam:: rmAlign

   *rmAlign* is matrix of alignment 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

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

.. us.example

**Example**

::

   ]]
   [[

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

:sub:`id-425530`