Please enable JavaScript to view this site.

ESL Documentation

The following table lists the built-in functions that provide information about table objects.

 

Built-in

Description

ancestry of

Return the ancestry of a table.

background of

Return the background color of a table.

bottom

Return the number of the last row that contains data.

cell column of row cell

Return the contents of a cell.

column delimiter of

Return the column delimiter string; for example, "," or "\t".

(column grid is)

Return true if column grid lines are on.

(column is

readonly)

Test whether the readonly attribute of the column is set.

This may be overridden if the whole table is readonly.

(column is

resizeable)

Test whether the resizeable attribute of the column is set.

This may be overridden if the whole table is set to not allow column resizing.

column

modifiability of

This returns true if it is possible to modify an active column

in a table (with insert, clear, change position, or remove). This returns false if the parent of the table is permanent or visible and there is more than 64 kilobytes of data in the table. In the case of inserting columns, you should also test that the insertion worked by checking the resulting number of columns (in case the insert would cause the data to exceed 64 kilobytes).

edit key of

Return the integer representing the keystroke used to start edit mode, as defined in ACCEL.INC.

edit mode of

Return true if a cell in the table is being edited.

exists

Test if a table exists.

foreground of

Return the foreground color of a table.

format of column

Return the format string for a column.

handle of

Return the window handle of the table object.

heading of column

Return the column heading text. The value returned depends on the type of column headings. The appropriate string is returned for letters and numbers settings. If the setting is text, then the application-specified string is returned. If the setting is blank or hide, then a null string is returned.

helpid of

Return the helpid value for a table.

(is enabled)

Test if a table is enabled. This is identical to selectability of.

(is readonly)

Test if a table is readonly.

(is resizeable)

Return true only if the TABLE allows column resizing by the user.

(is selected)

Test whether a row or column is selected.

(is visible)

Test whether a row or column is visible.

left of

Return the first column number; this is always equal to one.

name of column

Return the name of a column, or a null string if the column does not have a name.

parameter of

Return the parameter value for a table or column.

position of column

Return the position number of a column.

right of

Return the last column number.

row delimiter of

Return the row delimiter string. For example, "\n".

(row grid is visible)

Returns true if row grid lines are on.

row size of

Return the height of each row in the table, including horizontal grid line and empty space. This depends, in part, on the font used in the table.

selectability of

Test if a table is enabled.

selected columns of

Return the number of columns that are selected, or 0 if none.

selected rows of

Return the number of rows that are selected, or 0 if none.

text size of column

Return the maximum number of characters allowed for data in a string column.

textual row of

Return the value of all the cells in the row as strings, separated by the column delimiter.

top

Return the number of the first row.

type of column

Return the column data  type ("integer", "float", "string", or "boolean").

visibility of

Test whether a table or column has the visible attribute set.

width of column

Return the width of a column in dialog units.

window xposition

Return the column position of the first displayed column in a table.

window xsize

Return the number of fully displayed columns shown in a table. This includes any invisible columns that are between those that are displayed.

window yposition

Return the row position of the first displayed row in a table.

window ysize

Return the number of fully displayed rows shown in a table.

xcursor

Return the column position of the cursor.

xposition

Return the leftmost position of the table in its parent, measured in dialog units.

xsize

Return the width of the whole table in dialog units.

ycursor

Return the row position of the cursor.

yposition

Return the bottom position of a table in its parent, measured in dialog units.

ysize

Return the height of the whole table in dialog units.