.. highlightlang:: us

.. _tablegetedgedistance:

TableGetEdgeDistance
====================

.. index:: TableGetEdgeDistance

.. us.tag  TableGetEdgeDistance table.get New400

:ref:`TableGetEdgeDistance` returns the distance
between the text and the left cell edge.

.. function::  rmDistance = TableGetEdgeDistance(hTable, nDir)
    rmDistance = TableGetEdgeDistance(hTable, nDir, rvSel)

.. us.return

**Return Value**

*rmDistance* is the distance in centimeters.

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

   .. 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:: 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:`TableSetEdgeDistance`

:sub:`id-184475`