IndexOf

From Xojo Documentation

Revision as of 18:53, 19 November 2009 by WikiSysop (talk) (1 revision)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
You are currently browsing the old Xojo documentation site. Please visit the new Xojo documentation site!


Description

Used to search for a value in an array. Returns the index of the array element that contains the matching value. Arrays are zero-based.


Syntax

result=array.IndexOf(TargetValue[,StartingIndex])

Part Type Description
result Integer Index of the array element that contains the value TargetValue.

If no match is found, result is set to -1.

array Any valid data type The array that you want to search.
TargetValue Same type as array The value in the array that you want to find. It must be of the same data type as the array. The IndexOf function is not case-sensitive, but it is encoding-sensitive.
StartingIndex Integer Optional. Array element to begin the search.

If omitted, the search starts at the first array element. If you specify an array element outside the range of elements in array, an OutOfBoundsException is raised.


Notes

IndexOf is not case-sensitive, but it is encoding-sensitive.


Examples

This example uses a ComboBox that has five items in its pop-up menu that have the names of the workdays of the week. The selected day is in its Text property. This example returns the index of the array element that matches the menu selection.

Dim days() as String
days() = Array("Monday","Tuesday","Wednesday","Thursday","Friday")
Dim dayNumber as Integer
dayNumber = days.IndexOf(ComboBox1.Text)
If dayNumber >= 0 then
MsgBox "You entered day number " + Str(dayNumber)
else
MsgBox "You didn't enter the name of any weekday."
end if


See Also

Dim statement; Array, Join, Split, Ubound functions; Append, Array, Insert, Pop, Redim, Remove, Shuffle, Sort, Sortwith methods; ParamArray keyword.