TreeCombo.OnBeginFilter

Fore Syntax

Sub OnBeginFilter(Sender: Object; Args: ITreeSearchEventArgs);

Begin

//set of operators;

End Sub OnBeginFilter;

Fore.NET Syntax

Sub OnBeginFilter(pSender: System.Object; pArgs: Prognoz.Platform.Interop.Forms.TreeSearchEventArgs);

Begin

//set of operators;

End Sub OnBeginFilter;

Parameters

Sender. Parameter that returns the component that generated the event.

Args. Parameter that enables the user to determine event parameters.

Description

The OnBeginFilter event occurs at the start of filtering of component elements list.

Comments

If the component is focused, but its drop-down list is collapsed, on entering a combination of characters the list of elements is searched and filtered. The filtered list contains only the elements, which themselves and their child elements contain the entered combination of characters. After filtering the obtained list is displayed to select elements.

The OnBeginFilter event occurs after ending of character entering at the start of filtering. The text, by which elements are filtered, can be obtained by means of the SearchText property of event argument.

Example

The example of use is given in description of the OnFilter event.

See also:

TreeCombo