Grid

Note: property, method and event names should be referred to in lowercase in case-sensitive scripting languages.

Properties

This class supports the Common Properties plus the following:

Property	Access (R/RW)	Value	Description
ActiveColumn	RW	Numeric	Currently selected column
ActiveRow	RW	Numeric	Currently selected row
AlternatingRowColors	RW	Boolean	Whether rows have alternating background colors
ColumnCount	RW	Numeric	Number of columns
GridLineColor	RW	Numeric	Color of grid lines
GridLines	RW	Boolean	Whether grid lines are displayed
HeaderHeight	RW	Numeric	Column header height in pixels
Picture	RW	Character	Filename of background image
Readonly	RW	Boolean	Whether grid is readonly
Recno	R	Numeric	Current record number
RecordMark	RW	Numeric	Whether record number column is displayed: 0 (False), 1 (True)
RecordSource	RW	Character	Source of data to which the grid is bound
RecordSourceType	RW	Numeric	Data source type: 0 = table, 1 = alias, 4 = SQL statement
RelativeColumn	R	Numeric	Currently selected column relative to the grid display
RelativeRow	R	Numeric	Currently selected row relative to the grid display
RowColChange	RW	Numeric	Type of cell movement made: 0 = no change, 1 = row change, 2 = column change, 3 = row and column change
RowCount	RW	Numeric	Number of rows
RowHeight	RW	Numeric	Row height in pixels
Rowid	R	Numeric	Current record number
RowSource	RW	Character	Source of data to which the grid is bound
RowSourceType	RW	Numeric	Data source type: 0 = table, 1 = alias, 4 = SQL statement
Scrollbars	RW	Numeric	Scrollbars displayed: 0 = none, 1 = horizontal, 2 = vertical
ViewMode	RW	Boolean	View mode for split grids: 0 = grid view, 1 = form view, 2 = split view
WordWrap	RW	Boolean	Whether text is word-wrapped

Methods

This class supports the Common Methods plus the following:

Method	Args	Description
ActivateCell	row as Numeric, column as Numeric	Select the cell at the specified row and column position
AddColumn	column as Numeric	Add a column at the specified column position
AddItem	data as Character	Add an item
AddItems	selectstatement as Character | commalist as Character | pipelist as Character | items as Array [,headers as Array[, headerwidths as Array]]	Add items based on an SQL SELECT query, a comma-separated list, a pipe-separated list or an array, optionally specifying a second array with column header text and a third with column header widths
AddObject	existing as Object | newobject as Character, class as Character	Add an existing object or a new object, in which case the object's class must also be specified and optionally its caption
Autofit	None	Resize the columns to fit the grid
Clear	None	Clear the grid
Columns	column as Numeric	Return an object reference to the specified column
DoScroll	scroll as Numeric	Scroll: 0 = up, 1 = down, 2 = page up, 3 = page down, 4 = left, 5 = right, 6 = page left, 7 = page right, 8 = top, 9 = bottom
Goto	recordnumber as Numeric	Go to the specified record number
Item	row as Numeric, column as Numeric	Return the item text from the specified cell
RemoveColumn	column as Numeric	Remove a column at the specified column position
RemoveObject	existing as Object	Remove the specified object
Search	searchstring as Character	Search for searchstring in the currently selected column
Sort	column as Numeric, direction as Numeric	Sort data on the specified column. Data is sorted in descending order if direction < 0

Events

This class supports the Common Events plus the following:

Event	Args	Description
afterRowChange	column as Numeric	Occurs after the when event on moving row
beforeRowChange	None	Occurs after data has changed and before the valid event
dragDrop	source as Object, x as Numeric, y as Numeric, state as Numeric	Occurs when an object is dropped into the grid
dragOver	source as Object, x as Numeric, y as Numeric, state as Numeric	Occurs when an object is dragged over the grid