Click or drag to resize

ShellSearchEdit Class

A SearchEdit is a search box similar to the Windows Search in the upper right corner of the Windows Explorer and provides a search for files and folders.
Inheritance Hierarchy

Namespace:  Jam.Shell
Assembly:  ShellBrowser.Winforms (in ShellBrowser.Winforms.dll) Version: 6.3.1
Syntax
Copy
public class ShellSearchEdit : TextBox, 
	IShellControl, IShellControlConnectorTarget, ISupportInitialize, ISupportInitializeNotification

The ShellSearchEdit type exposes the following members.

Constructors
  NameDescription
Public methodShellSearchEdit
Default constructor of the SearchEdit class.
Top
Properties
  NameDescription
Public propertyCurrentFolder
Gets the current folder where the search takes place.
Public propertyIsInitialized
Gets a value indicating whether the component is initialized.
Public propertyQuickSearch
Gets or sets the usage of the quick search mode.
Public propertyQuickSearchDelay
Amount of time in milliseconds to delay the search in the quick search mode. After this delay has expired the search is started.
Public propertySearchFolder
Gets the virtual "search folder" where the search results are displayed.
Public propertyShellControlConnector
Connects this control to a ShellControlConnector component, which allows to synchronize several shell controls.
Public propertyVersion
The current version of the ShellBrowser components.
Top
Methods
  NameDescription
Public methodBeginInit
Signals the object that initialization is starting.
Public methodClear
Clears the search query.
Public methodEndInit
Signals the object that initialization is complete.
Public methodFolderChanged
Changes the displayed folder in all connected controls.
Public methodFullRefresh
Triggers a full refresh for all connected controls.
Protected methodGetMagnifyingGlassSymbol
Gets the magnifier icon.
Protected methodGetRevealSymbol
Gets the reveal icon.
Public methodGoUp
Move in all connected controls from the current to the parent folder.
Protected methodOnFontChanged
Raises the System.Windows.Forms.FontChanged event.
(Overrides TextBoxOnFontChanged(EventArgs).)
Protected methodOnHandleCreated
This event is triggered after the handle of the control was created.
(Overrides TextBoxOnHandleCreated(EventArgs).)
Protected methodOnKeyUp
Raises the System.Windows.Forms.KeyUp event.
(Overrides ControlOnKeyUp(KeyEventArgs).)
Protected methodOnTextChanged
Raises the System.Windows.Forms.TextChanged event.
(Overrides TextBoxBaseOnTextChanged(EventArgs).)
Public methodRefresh(RefreshLevel)
This method indicates that the control should perform a refresh of its contents.
Public methodRefresh(RefreshLevel, ItemIdList)
This method indicates that the control should perform a refresh of its contents.
Public methodSearch
Starts the search in the current folder.
Public methodSelectedFileChange
Changes the displayed file in all connected controls.
Public methodSmartRefresh
Triggers a smart refresh for all connected controls.
Top
Events
  NameDescription
Public eventInitialized
Occurs when initialization of the component is completed.
Public eventSearchFolderCreated
Occurs when the search folder has been created.
Public eventSearchFolderDestroyed
Occurs after the search folder has been destroyed.
Top
Extension Methods
  NameDescription
Public Extension MethodHandleNeeded
A Control extension method that ensures that the handle for a control is created.
(Defined by ExtensionMethods.)
Public Extension MethodScaledPixels
An extension method for controls: It scales the passed pixels according to the current dpi the control is displayed with.
(Defined by ExtensionMethods.)
Public Extension MethodScaleFont
A Control extension method that scales font according to the passed factor.
(Defined by ExtensionMethods.)
Top
Remarks
The search itself is done by Windows and supports the Advanced Query Syntax. The matching results are mapped to a virtual folder called "search folder". The property SearchFolder contains an ItemIdList to this folder when the search has finished. If the property ShellControlConnector is assigned this ShellControlConnector will be informed automatically when the search has finished. The QuickSearch mode is used per default to provide an automatically search start after the search expression has changed. Please note that a SearchEdit is only compatible with Windows 7 and later. The search indexing service must not be disabled.
See Also