bbbfly. SearchBox class control

Parameters

Name Type Description
def bbbfly.SearchBox.Definition optional Descendant definition
ref object optional Reference owner
parent object | string optional Parent DIV element or it's ID

Properties

Name Type Default Description
MaxResultItems integer 5
ResultNameProperty integer 'name'
MoreItemsText_part1 resource 'bbbfly_searchbox_more_part1' More items item text first part resource name
MoreItemsText_part2 resource 'bbbfly_searchbox_more_part2' More items item text second part resource name

Extends

In Packages

Methods

See:

inherited abstract DoSearch (text){boolean}

Use this method to implement searching process.
Parameters:
Name Type Description
text string Searched text
See:
Returns:
Type Description
boolean If text was valid
Parameters:
Name Type Description
buttonId string Required button's ButtonId
Returns:
Type Description
bbbfly.Edit.Button | null - Button with passes ButtonId
Search for passed text or text filled in edit.
Parameters:
Name Type Description
text string optional Edit text will be used if undefined
See:
Returns:
Type Description
boolean If text was valid
Focus edit with caret at the text end.
See:

inherited SetFocusBefore ()

Focus edit with caret at the text begining.
See:

inherited SetSearchResults (results){boolean}

Parameters:
Name Type Description
results bbbfly.SearchEdit.searchResults
See:
Returns:
Type Description
boolean If results were valid

Events

inherited OnInvalidChanged ()

inherited OnNoSearchResults ()

Called when nothing was found.
See:

inherited OnSearch (text){boolean}

Parameters:
Name Type Description
text string
See:
Returns:
Type Description
boolean If continue to search

inherited OnSearchResults (results)

Called when any anything was found.
Parameters:
Name Type Description
results bbbfly.SearchEdit.searchResults
See: