SearchFieldCollection Class Methods
In this section, the SearchFieldCollection class methods are presented in alphabetical order.
Syntax
Count()
Description
Use this method to return the number of SearchField objects in the SearchField collection as an integer.
Parameters
None.
Returns
An integer.
Syntax
First()
Description
Use this method to return the first SearchField object in the SearchField collection. If the SearchField collection is empty, this method returns Null.
Parameters
None.
Returns
A SearchField object if successful, Null otherwise.
Syntax
Item(index)
Description
Use this method to return the SearchField object at the position in the SearchField collection specified by the index parameter.
Parameters
|
Field or Control |
Definition |
|---|---|
| index |
Specifies the position of the SearchField object in the SearchField collection as an integer. |
Returns
A SearchField object if successful, Null otherwise.
Syntax
ItemByName(name)
Description
Use this method to return the SearchField object specified by the name parameter.
Note: The ItemByName method does not set the index for the SearchField object returned. Therefore, the Next method cannot be used after a call to ItemByName.
Parameters
|
Field or Control |
Definition |
|---|---|
| name |
Specifies the name of the SearchField object as a string. |
Returns
A SearchField object if successful, Null otherwise.
Syntax
Next()
Description
Use this method to return the next SearchField object in the SearchField collection. This method can only be invoked after a successful invocation of the First, Item, or Next methods.
Note: The ItemByName method does not set the index for the SearchField object returned. Therefore, the Next method cannot be used after a call to ItemByName.
Parameters
None.
Returns
A SearchField object if successful, Null otherwise.