An NDoc Documented Class Library

FileSearchEngine Members

Public Instance Constructors

FileSearchEngine Constructor Instantiates an instance of a FileSearchEngine object

Public Instance Properties

Asynchronous Indicates whether or not the search will be done asynchronously. If set to true, Search will return immediately when called and events will be fired from a worker thread. This is important to know when displaying the results in a Windows Forms control. For more Information on this see Invoke
Container (inherited from Component) Gets the IContainer that contains the Component.
Expression The search text. This can be any valid string, and if the Recursive property is set to true, it can be any valid regular expression according to the grammar for RegEx
MatchCase Indicates whether or not to do a case sensitive search
Recursive Indicates whether or not the search will recurse subdirectories during its execution
Site (inherited from Component) Gets or sets the ISite of the Component.
StartDirectory The directory where the search starts
State Returns a SearchState value indicating the current state of the search
UseRegEx If set to true, the Expression property can be any valid regular expression. For details on expression grammar see RegEx
WholeWord Indicates whether or not only complete word matches are found
WildCard Only files whose names match this filter string will be searched. The format of the string is the same as the one that is used with the GetFiles method of DirectoryInfo

Public Instance Methods

CreateObjRef (inherited from MarshalByRefObject)Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
Dispose (inherited from Component) Releases all resources used by the Component.
Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
GetHashCode (inherited from Object)Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetLifetimeService (inherited from MarshalByRefObject)Retrieves the current lifetime service object that controls the lifetime policy for this instance.
GetType (inherited from Object)Gets the Type of the current instance.
InitializeLifetimeService (inherited from MarshalByRefObject) Obtains a lifetime service object to control the lifetime policy for this instance.
SearchOverloaded.
Stop
ToString (inherited from Component)

Public Instance Events

Disposed (inherited from Component)Adds an event handler to listen to the Disposed event on the component.
EndFile EndFile is fired after the engine has finished searching an individual file
EndProcessing EndProcessing is fired when the entire search has completed
SearchException SearchException is fired when an exception occurs during the course of a search
SearchHit SearchHit is fired when a matching line is found in a file during a search
StartFile StartFile is fired when the engine begins to search an individual file
StartProcessing StartProcessing is the first event fired for a search and indicates that the search has started

Protected Instance Properties

DesignMode (inherited from Component) Gets a value that indicates whether the Component is currently in design mode.
Events (inherited from Component)Gets the list of event handlers that are attached to this Component.

Protected Instance Methods

Dispose (inherited from Component)Releases the unmanaged resources used by the Component and optionally releases the managed resources.
Finalize (inherited from Component)
GetService (inherited from Component) Returns an object that represents a service provided by the Component or by its Container.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.
SearchDirectory
SearchWorker

See Also

FileSearchEngine Class | Genghis Namespace