Skip to main content
Version: 9.0.2

gre.get_table_attrs

gre.get_table_attrs(
table_name,
tags
)

Get properties for a table.  Key name is the name of the control or a variable.

Tags can be any of the control tags and any of the following values:

rows The number of rows in the table

cols The number of columns in the table

visible_rows The number of visible rows in the table

visible_cols The number of visible columns in the table

active_row The active cell row

active_col The active cell column

row The row index of the upper left row

col The column index of the upper left column

xoffset The current scroll offset in the x direction

yoffset The current scroll offset in the y direction

scroll_enabled The current state of table content scrolling enablement. The value is 0 if scrolling is not enabled or 1 if it is.

Parameters

ParameterTypeDescription
table_name#stringThe model full path of the table to get information about.
tags#stringOne or more tags as strings

Returns

TypeDescription
#tableA table containing the tags as keys with the associated table value being the Storyboard value associated with that tag.

Example:

function check_if_hidden()
local dk_data = {}
-- Get the active row/column
dk_data = gre.get_table_attrs("my_table", "active_row", "active_col")
print("Active Cell: " .. tostring(dk_data["active_row"] .. "," .. tostring(dk_data["active_col"])))
end