SearchEdit

Inheritance Hierarchy

          IComponent

          IControl

          ICustomEdit

          IEditBox

          ISearchEdit

          SearchEdit

Description

The SearchEdit component is used to specify the text by which BI search can be performed.

Comments

The component represents text editor analogical to the EditBox component. The button to clear specified text is implemented in the component area. To start the BI search process, call the Search method. The component does not return any search result, indication of time limit in the Timeout property enables the user to trace its timeout. When timeout is achieved, the OnSearch event is generated for the component.

To get results of BI search, use the SearchEdit component together with the SearchDataSourcesBox component

Example

Properties of the SearchEdit Component

  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 the component.
AllowDrop The AllowDrop  property determines whether the component can accept the dragged object.
Anchors The Anchors  property returns settings that determine the percentage of the size change for the current component when the parent component is resized.
AutoSelect The AutoSelect property determines whether the entire component text is selected when the component gets focus.
BorderStyle The BorderStyle property determines component's border style.
Brush The Brush  property specifies the brush used to fill the component area.
CanUndo The CanUndo  property returns  True,  if it is possible to undo text changes in the component.
CharacterCasing The CharacterCasing property determines case of entered component characters.
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 the background color of the component.
ComponentCount The ComponentCount  property returns the number of child components.
Components The Components  property returns a child component.
Cursor The Cursor  property determines how the cursor looks like when you hover over a component during form execution.
Data The Data  property is used to store any custom data.
Enabled The Enabled  property determines whether a component is available for a user.
Focused The Focused  property returns  True,  if the focus is set on this 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 the unique index for a section of a context help for this component.
HideSelection The HideSelection property determines whether the component's selected text remains selected on passing the focus to the other component.
Hint The Hint  property determines the hint text for the component.
Left The Left  property determines the coordinate of the left border of the component.
MaxLength The MaxLength  property determines the maximum length of the entered text.
Modified The Modified  property returns  True,  if component's text is changed.
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 a component should use the font of the parent component.
ParentShowHint The ParentShowHint property determines whether a tooltip is displayed.
PasswordChar The PasswordChar property determines the character that substitutes actual characters entered by the user.
PopupMenu The PopupMenu  property determines the context menu to be displayed on right-click.
Scrolls The Scrolls  property returns parameters of component's scrollbars.
ReadOnly The ReadOnly property determines whether the user can change component's text.
SelLength The SelLength  property determines the number of characters selected in the component text.
SelStart The SelStart  property determines the position of the cursor from where the selection of the component's text starts.
SelText The SelText  property determines text, selected in the component.
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 key is pressed.
Tag The Tag  property is not used by the compiler. A user can change the value of the  Tag  property and use it as he wishes.
Text The Text  property determines the row identifying a component for a user.
Timeout The Timeout property determines available search time.
Top The Top  property determines the coordinate of the top border of the component.
Visible The Visible  property determines the visibility of the component during execution.
Width The Width property determines the component width.

Methods of the SearchEdit Component

  Method name Brief description
BringToFront The BringToFront   method brings a component to front.
Clear The Clear method deletes the entire text contained in the component.
ClearSelection The ClearSelection method deletes the entire text that is selected in the component.
ClearUndo The ClearUndo method is used to fix changes of the Text.
CopyToClipboard The CopyToClipboard method copies selected data into the clipboard.
CutToClipboard The CutToClipboard method cuts selected data into the clipboard.
ClientToScreen The ClientToScreen method converts the coordinates of a point specified relative to the component coordinate system to screen coordinates.
DoDragDrop The DoDragDrop method enables to start dragging operation.
GetImage The GetImage method returns the graphic image of the component with all child components.
PasteFromClipboard The PasteFormClipboard method pastes the data from the clipboard.
SelectAll The SelectAll method selects component's text.
SetFocus The SetFocus method sets focus to this component.
ScreenToClient The ScreenToClient method converts screen coordinates of a point to coordinates specified relative to the component coordinate system.
Search The Start method starts the BI search process.
SendToBack The SendToBack method sends a component to back.
Undo The Undo method cancels the last change of the component's text.

Events of the SearchEdit Component

  Event name Brief description
OnBeginDrag The OnBeginDrag  event occurs for a component when a user starts to drag an object from the component.
OnChange The OnChange event occurs after changes of the Text edit component.
OnClick The OnClick  event occurs if a user clicks a component area using the main mouse button.
OnDblClick The OnDblClick  event occurs if a user double-clicks a component area using the mouse button.
OnDragDrop The OnDragDrop  event occurs for a component if a user drops a 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 receives focus.
OnExit The OnExit  event occurs when a component loses focus.
OnHScroll The OnHScroll  event occurs on changing position of horizontal scrollbar slider.
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 a user presses a character key.
OnKeyPreview The OnKeyPreview  event occurs prior to each event requiring clicking.
OnKeyUp The OnKeyUp  event occurs if a component is focused and a user releases any button previously pressed.
OnMouseDown The OnMouseDown  event occurs if the cursor is in component area and a mouse button is pressed.
OnMouseEnter The OnMouseEnter  event occurs when the mouse cursor crosses the component area.
OnMouseHover The OnMouseHover event occurs when the mouse cursor lingers in component area.
OnMouseLeave The OnMouseLeave event occurs when the mouse cursor leaves the component area.
OnMouseMove The OnMouseMove event occurs when the mouse cursor is moved over the component.
OnMouseUp The OnMouseUp event occurs if user releases mouse button when the cursor is in the component area.
OnMouseWheel The OnMouseWheel event occurs if a component is focused when a user rotates mouse wheel.
OnSearch The OnSearch event occurs after BI search starts at the end of specified search time.
OnVScroll The OnVScroll  event occurs on changing position of vertical scrollbar slider.

See also:

Additional Components