.. highlightlang:: us

.. _tablesetedgedistance:

TableSetEdgeDistance
====================

.. index:: TableSetEdgeDistance

.. us.tag  TableSetEdgeDistance table.set New400

:ref:`TableSetEdgeDistance` sets the distance
between the text and the cell edge.

.. function::  bool = TableSetEdgeDistance(hTable, nDir, rmDist)
    bool = TableSetEdgeDistance(hTable, nDir, rmDist, 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

   The handle of a table object created with :ref:`TableCreate`.

.. uparam:: nDir

   *nDir* specifies if the distance to the left or top edge is set:

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

      * - Element
        - Value
        - Description
      * - TABLE_DISTANCE_HORZ
        - 1
        - Distance to the left edge
      * - TABLE_DISTANCE_VERT
        - 2
        - Distance to the top edge

.. uparam:: rmDist

   *rmDist* is a Matrix with the distance in centimeters.

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

.. seealso::
   :ref:`overview-table`,
   :ref:`TableCreate`,
   :ref:`TableGetEdgeDistance`

:sub:`id-1065323`