Class: cWebBaseSelectionForm
Properties | Events | Methods | Index of Classes
Base class for selection controls that show suggestions while typing
Hierarchy
cObject > cWebBaseObject > cWebObject > cWebBaseUIObject > cWebBaseDEOServer > cWebBaseControl > cWebBaseDEO > cWebBaseForm > cWebForm > cWebBaseSelectionForm
Show full hierarchy and direct subclasses
Library: Web Application Class Library
Package: cWebBaseSelectionForm.pkg
Description
cWebBaseSelectionForm is the base class for selection controls that show suggestions while typing, such as cWebSelectionForm and cWebTagsForm.
Selection forms can load suggestions from a cSelectionSource object or by augmenting OnFindSuggestions. Each suggestion is represented by a tSelectionItem value.
Selection loading modes
When a cSelectionSource is configured, exactly one loading mode must be enabled:
pbAllData: loads the complete set to the client and filters locally.pbPaged: loads server-side pages and adds a show-more action when another page is available.pbSuggestions: sends each filter to the server and replaces the suggestions with the returned matches; it does not add a show-more action.
The three mode properties are mutually exclusive. Use pbSuggestions for large, dynamically filtered sources and pbAllData only for data sets small enough to load completely.
Suggestion Action Rows
Selection forms can also show action rows together with normal suggestions. Action rows are useful for commands such as showing more suggestions, opening an advanced search prompt or adding application-specific actions to the suggestion popup.
Use OnAddCustomActionButtons to add custom action rows. From this event, call AddCustomActionButton to append a row to the suggestion list.
Procedure OnAddCustomActionButtons tSelectionItem[] ByRef aItems Boolean bLast String sFilter
Forward Send OnAddCustomActionButtons (&aItems) bLast sFilter
If (sFilter <> "") Begin
Send AddCustomActionButton (&aItems) "openDetails" "Open Details"
End
End_Procedure
If the selection form has a prompt object or navigation path, it can show an advanced search action row. Set psAdvancedSearchText to change the text shown for that action.