SearchDataSourcesBox

Assembly: ExtCtrls;

Description

The SearchDataSourcesBox class implements the SearchDataSourcesBox development environment component.

Class object properties inherited from ISearchDataSourcesBox

  Property name Brief description
IsAllDataLoaded The IsAllDataLoaded property returns the checkbox that specifies whether all elements with search results are loaded to component area.
Items The Items property returns the collection of elements with search results.
TotalCount The TotalCount property returns the total number of found matches.

Class object properties inherited from IControl

  Property name Brief description
Align The Align property determines component alignment within its parent component.
AllowDrag The AllowDrag property determines whether an object can be dragged from a component.
AllowDrop The AllowDrop property determines whether the component can accept a dragged object.
Anchors The Anchors property returns settings determining % of the resize for the current component when the parent component is resized.
Brush The Brush property determines the brush that is used to fill the component area.
ClientHeight The ClientHeight property determines the height of the client component area.
ClientWidth The ClientWidth property determines the width of the client component area.
Color The Color property determines color of the component background.
Cursor The Cursor property determines how the cursor looks like when is it hovered over a component during form execution.
Enabled The Enabled property determines whether a 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 parameters of the font that is used to display text in the component.
Height The Height property determines component height in pixels.
HelpContext The HelpContext property determines a unique index for a section of a context help for this component.
Hint The Hint property determines a tooltip text displayed on hovering over the component.
HintTimeout The HintTimeout property determines for how long a tooltip is displayed.
Left The Left property determines a coordinate of the component left edge in pixels.
Parent The Parent property determines a parent component.
ParentColor The ParentColor property determines whether a component inherits the color of the parent component.
ParentFont The ParentFont property determines whether a component uses the font of the parent component.
ParentShowHint The ParentShowHint property determines when a tooltip is displayed.
PopupMenu The PopupMenu property determines the context menu displayed when the component is clicked with the right mouse button.
Scrolls The Scrolls property returns parameters of component's scrollbars.
ShowHint The ShowHint property determines whether a tooltip is displayed when the component is hovered.
TabOrder The TabOrder property determines a component position in a tab order.
TabStop The TabStop property determines whether the component must be focused when the Tab button is pressed.
Text The Text property determines a row identifying a component for the user.
Top The Top property determines a coordinate of the component top edge in pixels.
Visible The Visible property determines whether the component is displayed when a form is executed.
Width The Width property sets component width in pixels.

Class object properties inherited from IComponent

  Property name Brief description
ComponentCount The ComponentCount property returns the number of child components located on the parent component.
Components The Components property returns a child component, which index is passed via the input parameter.
Data The Data property is used to store any custom data.
Name The Name property determines the component name.
Tag The Tag property is not used by the compiler. The user can change the value of this property and use it at his discretion.

Class object methods inherited from ISearchDataSourcesBox

  Method name Brief description
CancelSearch The CancelSearch method aborts BI search.
LoadNextPage The LoadNextPage method loads the next set of elements with search results to the component area.
StartSearch The StartSearch method starts BI search.

Class object methods inherited from IControl

  Method name Brief description
The ClientToScreen method converts point coordinates specified relative to the component's coordinate system into screen coordinates.
The DoDragDrop method enables the user to start dragging operation.
The GetImage method returns a graphic presentation of a component together with all child components.
The ScreenToClient method converts point's screen coordinates into coordinates specified relative to the component's coordinate system.
The SetFocus method sets focus to this component.

Class object events

   Event name Brief description
OnAfterSelectionChange The OnAfterSelectionChange event occurs after selecting element with search result in the component area.
OnBeforeSelectionChange The OnBeforeSelectionChange event occurs before selecting element with search result in the component area.
OnCancelSearch The OnCancelSearch event occurs at the moment of force cancel of BI search.
OnFinishSearch The OnFinishSearch event occurs at the moment of BI search finish.
OnStartSearch The OnStartSearch event occurs at the moment of BI search start.

Events inherited from IControl

   Event name Brief description
The OnBeginDrag event occurs for the component when the user starts to drag an object from the component.
The OnClick event occurs if the user clicks the component area.
The OnControlMove event occurs when the component is moved.
The OnControlResize event occurs when the component is resized.
The OnDblClick event occurs if the user double-clicks the component area.
The OnDragDrop event occurs for the component if the user drops a dragged object over it.
The OnDragEnter event occurs when a dragged object enters the component area.
The OnDragLeave event occurs when a dragged object leaves component borders.
The OnDragOver event occurs for the component when the user drags an object over it.
The OnEnter event occurs when the component receives focus.
The OnExit event occurs when the component loses focus.
The OnHScroll event occurs when horizontal scrollbar slider changes its position.
The OnKeyDown event occurs if the component is focused and a keyboard key is pressed.
The OnKeyPress event occurs if the component is focused when the user presses a character key.
The OnKeyPreview event occurs prior to each event related to key pressing.
The OnKeyUp event occurs if the component is focused and the user releases any button previously pressed.
The OnMouseDown event occurs if the pointer is in the component area and a mouse key is pressed.
The OnMouseEnter event occurs when mouse cursor enters the component area.
The OnMouseHover event occurs when mouse cursor is held in the component area.
The OnMouseLeave event occurs when mouse cursor leaves the component area.
The OnMouseMove event occurs when the cursor is moved over the component.
The OnMouseUp event occurs when the mouse button is released and the cursor is in the component area.
The OnMouseWheel event occurs if the component is focused when the user rotates a mouse wheel.
The OnVScroll event occurs when vertical scrollbar slider changes its position.

See also:

ExtCtrls Assembly Classes