.. highlightlang:: us

.. _tablemergecells:

TableMergeCells
===============

.. index:: TableMergeCells

.. us.tag  TableMergeCells table.set New400 Changed530

:ref:`TableMergeCells` specifies which neighbouring cells are merged.

.. function::  bool = TableMergeCells(hTable, rvMerge)
    bool = TableMergeCells(hTable, rmMerge)

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

   *rvMerge* is a vector with four elements, which specify a range of 
   cells to be merged:

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

      * - Element
        - Description
      * - rvMerge[1]
        - left cell
      * - rvMerge[2]
        - top cell
      * - rvMerge[3]
        - right cell
      * - rvMerge[4]
        - bottom cell

   The row and column numbering starts with 1. 

.. uparam:: rmMerge

   *rmMerge* is a matrix with four columns. Each row specifies a range of 
   cells to be merged:

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

      * - Element
        - Description
      * - rmMerge[;1]
        - left cell
      * - rmMerge[;2]
        - top cell
      * - rmMerge[;3]
        - right cell
      * - rmMerge[;4]
        - bottom cell

   The row and column numbering starts with 1. 

.. us.history

**History**

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

   * - Version
     - Description
   * - 5.3.0
     - A matrix can be specified.

.. seealso::
   :ref:`overview-table`,
   :ref:`TableGetSelection`,
   :ref:`TableIsCellMerged`,
   :ref:`TableUnMergeCell`,
   :ref:`TableGetMergedCells`

:sub:`id-760935`