Hints for STRUCT Types

Struct parameters may utilize the following widget types:

WIDGET_TABLE (36)

The table widget displays a line for each element in a STRUCT_ARRAY. Column headings are specified by the name property of each struct element. Each element of the struct is given a column in the table.

Figure 54 - WIDGET_TABLE hint

A parameter using a WIDGET_TABLE widget may also specify additional configuration parameters in the config object of the parameter.

Properties

Property

Type

Default

Description

w.localselection

Boolean

false

true – edits in the table row do not update backing parameter; changes in the backing parameter do not update the selected row(s).

false – backing parameter and table row changes track with each other.

w.scrollselection

Boolean

true

true – auto scroll to the selected row

false – do not scroll to the selected row

w.reorder

Boolean

false

true – allow drag to reorder values

false –  do not allow drag to reorder values

w.rowstyleparam

String

none

OID of string array parameter providing style information (background, foreground, font, font size, etc.) for each row.

w.selectionparam

String

none

OID of integer parameter that will be populated with the index of a selected row.

w.rowaccessparam

String

none

OID of integer array parameter which determines read-only access for each row.

(0 = read-only, 1 = read-write). If not specified, all rows are read-write.

w.rowheight

Number

automatic

Sets the row height. Specified in pixels

w.colwidth.n

Number

automatic

Sets the width of the nth column. First column index is 0.

w.colminwidth.n

Number

automatic

Sets the minimum width of the nth column. First column index is 0.

w.hscroll

Boolean

false

true – show horizontal scrollbar

false –  do not show horizontal scrollbar

w.alwaysscroll

Boolean

false

true – vertical scrollbar always shown

false –  vertical scrollbar only shown only when required

w.hgrid

Boolean

true

true – display horizontal grid lines

false – do not display horizontal grid lines

w.vgrid

Boolean

true

true – display vertical grid lines

false – do not display vertical grid lines