Grid.GetNextItem

OverviewExamples

table Grid.GetNextItem (

string ObjectName,

number Row,

number Column,

number SearchType,

number SearchDirection )

Description

Searches for a cell that has the specified properties and that bears the specified relationship to a given item.

Parameters

ObjectName

(string) The name of the grid object.

Row

(number) The (zero-based) index of the row to start searching at.

Column

(number) The (zero-based) index of the column to start searching at.

SearchType

(number) The search type. Choose from:

CONSTANT	VALUE	DESCRIPTION
GVNI_FOCUSED	1	Search for focus cell.
GVNI_SELECTED	2	Search for selected cell.
GVNI_DROPHILITED	4	Search for drop hilighted cells.
GVNI_READONLY	8	Search for read-only cells.
GVNI_FIXED	16	Search for fixed cells.
GVNI_MODIFIED	32	Search for modified cells.

SearchDirection

(number) The direction of the search relative to the specified row and column. Choose from:

CONSTANT	VALUE	DESCRIPTION
GVNI_ABOVE	256	Search above initial cell.
GVNI_BELOW	512	Search all cells below initial cell.
GVNI_TOLEFT	1024	Search all cells to the left of the initial cell.
GVNI_TORIGHT	2048	Search all cells to the right of the initial cell.
GVNI_ALL	3584	Search all cells in the grid starting from the initial cell.
GVNI_AREA	2560	Search all cells below and to the right of the initial cell.

Returns

(table) A table is indexed by "Row" and "Column" to specify the found cell's location. If an error occurs, nil will be returned. You can use Application.GetLastError to determine whether this action failed, and why.

ResultVariable

When adding an action with the script editor, you can use this field to specify a variable that the return value will be stored in.