Please enable JavaScript to view this site.

Navigation: Advanced topics > Programming topics > Search API > Methods

Search API: getSearchOption

Scroll Prev Next More

 

Returns the search option. This code should go to AfterTableInit or BeforeDisplay events of List or Print pages.

Syntax

getSearchOption($field);

Arguments

$field

the name of the field.

Return value

Returns the search option, which is one of the following constants:

•CONTAINS

•EQUALS

•STARTS_WITH

•MORE_THAN

•LESS_THAN

•BETWEEN

•EMPTY_SEARCH

•NOT_CONTAINS

•NOT_EQUALS

•NOT_STARTS_WITH

•NOT_MORE_THAN

•NOT_LESS_THAN

•NOT_BETWEEN

•NOT_EMPTY

Examples

 

Print the the search option of Horsepower field on the screen.

 

 

$srchObj = SearchClause::getSearchObject("Cars");
echo $srchObj->getSearchOption("Horsepower");

 

 

See also:

•Search API: setSearchOption()

•Choose fields screen: Search and Filter settings

•About Search API

 

Created with Help+Manual 7 and styled with Premium Pack Version 3 © by EC Software