Class ctlSearch
This class represents the global search control for the application.
Inheritance
System.Object
ctlSearch
Namespace: StdPlatBS100
Assembly: StdPlatBS100.dll
Syntax
public class ctlSearch : UserControl
Constructors
ctlSearch()
Initializes a new instance of the ctlSearch class.
Declaration
public ctlSearch()
Methods
Activate()
Activates the form and gives it focus.
Declaration
public void Activate()
CreateSearchElementsFromRibbon(RibbonControl)
Loads the search elements from ribbon.
Declaration
public List<SearchElement> CreateSearchElementsFromRibbon(RibbonControl ribbonControl)
Parameters
Type | Name | Description |
---|---|---|
DevExpress.XtraBars.Ribbon.RibbonControl | ribbonControl | The ribbon control. |
Returns
Type | Description |
---|---|
System.Collections.Generic.List<Primavera.Platform.UserControls.SearchControl.Entities.SearchElement> |
Dispose(Boolean)
Clean up any resources being used.
Declaration
protected override void Dispose(bool disposing)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | disposing | true if managed resources should be disposed; otherwise, false. |
ExecuteSearch(String)
Executes the required search.
Declaration
public void ExecuteSearch(string searchTerm = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | searchTerm |
LoadSearchElements(List<SearchElement>)
Loads the search elements.
Declaration
public void LoadSearchElements(List<SearchElement> searchElements)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.List<Primavera.Platform.UserControls.SearchControl.Entities.SearchElement> | searchElements | The search elements. |
Events
SearchControlItemClick
Declaration
public event ctlSearch.SearchControlItemClickHandler SearchControlItemClick
Event Type
Type | Description |
---|---|
ctlSearch.SearchControlItemClickHandler |