Skip to content

FindColumnValue - cCJGridDataSource

Attempts to find a value in your datasource array

Type: Function
Return Data Type: Integer

Parameters

Parameter Type Description
iColumn Integer The column number to perform the search in
sValue String The value to search for
bFindGE Boolean If True, search GE, if False search EQ
iStartRow Integer The row to start the search in
bSearchUp Boolean Direction to perform search. Set True if grid is sorted in reverse order.

Syntax

Function FindColumnValue Integer iColumn String sValue Boolean bFindGE Integer iStartRow Boolean bSearchUp Returns Integer

Call Example

Get FindColumnValue iColumn sValue bFindGE iStartRow bSearchUp to IntegerVariable

Description

FindColumnValue is used to search for data in a column. It is called by the cCJGrid object's RequestFindColumnValue method, which is the method you should use to search for data. FindColumnValue is considered to be more low level.

If you are searching for a GE value (bFindGE is True), the datasource should be sorted by the column. If the grid is sorted in reverse order (pbReverseOrdering is True), you must pass bSearchUp as True, so the grid will be searched from the bottom up.

If iStartRow is 0, the grid search starts at the top or bottom of the datasource, depending on the value of bSearchUp. If iStartRow is non-zero and bSearchUp is False, the search is performed from iStartRow to the end of the datasource array. If iStartRow is non-zero and bSearchUp is True, the search is performed from iStartRow to the top of the data source array.

This only searches for data in the cache and does not search for non-cached data.

Again, you probably do not want to send this message. Use the cCJGrid object's RequestFindColumnValue message instead.

Return Value

The row index of the first match. -1 if no match is found.