The SearchDataSourcesBox component is used to launch the BI search process and display its results.
BI search is a full-text search of data by key words in the structure of multidimensional repository sources. To use BI search on working with BI server it is necessary to set up repository and to index data source. Setup instructions are in the Configure and Set Up BI Search Service section.
To start the BI search process, call the StartSearch method with specifying required text. The search process can be traced with the OnStartSearch - OnFinishSearch events. When the search is finished, the total amount of found matches will be available in the TotalCount property, and to the Items collection will be loaded first hundred elements with results. To load next elements, use the LoadNextPage method.
| Property name | Brief description | |
Align |
The Align property determines the behavior of the component, when the size of its parent component is changed. | |
AllowDrag |
The AllowDrag property determines whether an object can be dragged from the component. | |
AllowDrop |
The AllowDrop property determines whether the component can accept a dragged object. | |
Anchors |
The Anchors property returns settings determining % of the size change for the current component when the parent component is resized. | |
Brush |
The Brush property determines the brush used to fill the component area. | |
ClientHeight |
The ClientHeight property is used to receive or specify the height of the component’s client space. | |
ClientWidth |
The ClientWidth property receives or specifies the width of the component’s client space. | |
Color |
The Color property determines the background color of a component. | |
ComponentCount |
The ComponentCount property returns number of child components. | |
Components |
The Components property returns a child component. | |
Cursor |
The Cursor property determines the look of the cursor over the component. | |
Data |
The Data property stores any custom data. | |
Enabled |
The Enabled property determines whether the component is available for the user. | |
Focused |
The Focused property returns True if the focus is set to the component. | |
Font |
The Font property determines the set of characteristics, describing the font, used to display text. | |
Height |
The Height property determines the component height. | |
HelpContext |
The HelpContext property determines a unique index for the context help section for this component. | |
Hint |
The Hint property determines the hint text for the component. | |
HintTimeout |
The HintTimeout determines the time for which the tooltip is displayed. | |
IsAllDataLoaded |
The IsAllDataLoaded property returns checkbox indicating whether all elements with search results are loaded in the component area. | |
Items |
The Items property returns collection of elements with search results. | |
Left |
The Left property determines the coordinate of the left border of the component. | |
Name |
The Name property determines the component name. | |
Parent |
The Parent property determines the parent component. | |
ParentColor |
The ParentColor property determines whether a component inherits the color of the parent component. | |
ParentFont |
The ParentFont property determines whether the component should use the font of the parent component. | |
ParentShowHint |
The ParentShowHint property determines when a tooltip is displayed. | |
PopupMenu |
The PopupMenu property determines the context menu to be displayed on right-click. | |
ShowHint |
The ShowHint property enables and disables showing a hint for the component. | |
TabOrder |
The TabOrder property determines the component position in the tab order. | |
TabStop |
The TabStop property determines whether the focus is set to a component when the Tab button is pressed. | |
Tag |
The Tag property is not used by the compiler. User can change the value of the Tag property and use it as required. | |
Text |
The Text property determines the row identifying the component for the user. | |
Top |
The Top property determines the coordinate of the top border of the component. | |
TotalCount |
The TotalCount property returns total number of found matches. | |
Visible |
The Visible property determines the visibility of the component during execution. | |
Width |
The Width property determines the component width. |
| Method name | Brief description | |
BringToFront |
The BringToFront method brings a component to front. | |
CancelSearch |
The CancelSearch method interrupts the BI search process. | |
ClientToScreen |
The ClientToScreen method converts the coordinates of a point specified relative to the component coordinate system to screen coordinates. | |
DoDragDrop |
The DoDragDrop method allows to start dragging operation. | |
GetImage |
The GetImage method returns the image of the component with all the child components. | |
LoadNextPage |
The LoadNextPage method continues the search and loads the next set of elements with search results to the component area. | |
ScreenToClient |
The ScreenToClient method converts screen coordinates of a point to coordinates specified relative to the component coordinate system. | |
SendToBack |
The SendToBack method sends a component to back. | |
SetFocus |
The SetFocus method sets focus on the current component. | |
StartSearch |
The StartSearch method starts the BI search process. |
| Event name | Brief description | |
OnAfterSelectionChange |
The OnAfterSelectionChange event occurs after selection of the element with search result in the component area. | |
OnBeforeSelectionChange |
The OnBeforeSelectionChange event occurs before selection of the element with search results in the component are. | |
OnBeginDrag |
The OnBeginDrag event occurs for the component when the user starts to drag an object from the component. | |
OnCancelSearch |
The OnCancelSearch event occurs at the moment of force cancel of the BI search process. | |
OnClick |
The OnClick event occurs if the user clicks component area using the main mouse button. | |
OnControlMove |
The OnControlMove event occurs when a component is moved | |
OnControlResize |
The OnControlResize event occurs when a component is resized | |
OnDblClick |
The OnDblClick event occurs if the user double-clicks the component area using the mouse button. | |
OnDragDrop |
The OnDragDrop event occurs for the component if the user drops the dragged object over it. | |
OnDragEnter |
The OnDragEnter event occurs when a dragged object crosses the borders of this component. | |
OnDragLeave |
The OnDragLeave event occurs when a dragged object leaves the borders of this component. | |
OnDragOver |
The OnDragOver event occurs for this component when a user drags a dragged object over it. | |
OnEnter |
The OnEnter event occurs when a component gets focused. | |
OnExit |
The OnExit event occurs when the component loses focus. | |
OnFinishSearch |
The OnFinishSearch event occurs at the moment of the BI search process end. | |
OnHScroll |
The OnHScroll event occurs when horizontal scrollbar slider changes its position | |
OnKeyDown |
The OnKeyDown event occurs if a component is focused and a keyboard key is pressed. | |
OnKeyPress |
The OnKeyPress event occurs if a component is focused when the user presses a character key. | |
OnKeyPreview |
The OnKeyPreview event occurs prior to each event related to clicking mouse buttons | |
OnKeyUp |
The OnKeyUp event occurs if the component is focused and the user releases any button previously pressed. | |
OnMouseDown |
The OnMouseDown event occurs if a component is in focus and any of the mouse buttons is pressed. | |
OnMouseEnter |
The OnMouseEnter event occurs when the mouse cursor enters the component area | |
OnMouseHover |
The OnMouseHover event occurs when mouse cursor is held in the component area | |
OnMouseLeave |
The OnMouseLeave event occurs when the mouse cursor leaves the component area | |
OnMouseMove |
The OnMouseMove event occurs when a user moves the cursor over a component. | |
OnMouseUp |
The OnMouseUp event occurs, if a component is in focus, and any of the previously pressed mouse buttons is released. | |
OnMouseWheel |
The OnMouseWheel event occurs if the component is focused on scrolling the mouse wheel. | |
OnStartSearch |
The OnStartSearch event occurs at the moment of the BI search process start. | |
OnVScroll |
The OnVScroll event occurs when vertical scrollbar slider changes its position |
See also: