Subroutines > Detailed Descriptions > XTREE > XTREE Parameters
xtrctl

This is a collection of extended parameters and options. If omitted, suitable defaults will be supplied. For those parameters which are essentially Boolean options, 0=false and 1=true. Most of the fields in xtrctl are input only, but a few, such as xtr'columnactive, are updated as well; these are indicated with "[in/out]" in the table below. It is recommended that you include xtree.map in your programs to define the xtrctl map structure, and xtree.def to define the symbols.

Symbol

Type

I/O

Description

xtr'closedended

B,1

in

Set size of last column to "open ended" or fixed.

xtr'colorder (31)

B,1

in/out

Provides rearranging of the display order of the first (up to) 31 columns

xtr'columnactive

B,1

in/out

Col # with focus (for kbd search)

xtr'columnsort (3)

B,1

in/out

First, second, third sort columns

xtr'ctlid

B,1

out

Returns standard control ID of XTREE control (allowing access by AUI_CONTROL)

xtr'ctlno

B,1

in/out

Specifies which XTREE control to use.

xtr'delctlid

B,4

in

Ctl to delete.

xtr'expandlevel

B,1

in

0=collapse, #=expand through level # (9 max)

xtr'flyby

B,1

in

Fly-by highlighting? (0=no)

xtr'gridstyle

B,1

in

0=vert solid, 1=horz solid, 2=both, 3=vert dotted, 4=horz dotted, 5=both

xtr’headerstyle

B,1

in

Column header style flags

xtr'hideheader

B,1

in

Hide headers? (0=no)

xtr'itemlines

B,1

in

Display lines per item.

xtr'kbdstr

S,10

in

Click code.

xtr'leftpanecols

B,1

in

Number of columns in left pane.

xtr'leftpanewidth

B,1

in

Width of left pane.

xtr’miscflags

B,1

in

Misc flags (overlays xtr’truncated, which is now deprecated)

xtr’nfselstyle

B,1

in

Determines how selected item(s) are displayed when the tree is inactive.

xtr'opcode

B,1

in

Opcode.

xtr'parentid

B,2

in

ID of parent of control (e.g. a dialog). To specify parent by its alphanumeric control name, set xtr'parentid to zero and add the ParentID=<name> clause to any column; see Advanced Coldef Options.

xtr'rowhdrstyle

B,1

in

Options related to row headers.  (Also see xtr’showrowhdr)

xtr’showrowhdr

B,1

in

Determines whether row headers are displayed.

xtr'scrolltips

B,1

in

Show scroll tips (0=no)

xtr’searchmode

B,1

 

 

xtr'selectarea

B,1

in

Clickable area and style.

xtr'show3d

B,1

in

Use 3D style? (0=no) See sample screen below.

xtr'showbuttons

B,1

in

Show expand/collapse buttons for level 0. These "buttons” are in addition to the standard clickable +/- indicators.

xtr'showbuttons0

B,1

 

No longer used. See xtr'showbuttons.

xtr'showgrid

B,1

in

Show grid lines (0=no, 1=yes)

xtr'skey

S,10

in

Search key.

xtr'sortorder (3)

B,1

in/out

0=ascending, 1=descending

xtr'targetcol

B,1

in/out

Column of "target" cell; see xtr'target...

xtr'targetrow

B,4

in/out

Row of "target" cell; see xtr'target...

xtr'timeout

B,4

in

Timeout (ms)

xtr'topindex

B,4

in/out

Force the initial display vertical scroll position.

xtr'treelinestyle

B,1

 

Style of lines linking child lines to parent: 0=none, 1=solid, 2=dotted

xtr'truncated

B,1

in

Show dots if text truncated? (deprecated, replaced by xtr’miscflags)

xtr'usecolorder

B,1

in

Use COLORDER() to reorder?

xtr'usethemes

B,1

in

Use Windows themes? (0=no)

xtr’usrcfg

B,1

 

Used for Saving User Adjustments.

xtr'xcol

B,1

in/out

Column of last cell to have the focus.  (see xtr'xrow and xtr'targetcol)

xtr'xnavcod

B,1

in/out

Used in cell editing

xtr'xnavmask

B,1

in/out

  "    "     "    "

xtr'xrow

B,4

in/out

Row of last cell to have the focus. See xtr'target...

xtr'xvalidate

B,1

out