File Search Library
SearchParms Class Members
Properties  Methods  Events


KellermanSoftware.FileSearchLibrary Namespace : SearchParms Class

The following tables list the members exposed by SearchParms.

Public Constructors
 NameDescription
Public Constructor Default constructor  
Top
Public Properties
 NameDescription
Public Property If true, a case sensitive search will be performed. The default is false.  
Public Property A list of patterns to exclude directories. There are several directories excluded by default.  
Public Property A list of paths for directories to search. This is required.  
Public Property The search type to use when excluding directories. The default is wildcard.  
Public Property The time it took for the search or null if the search is not yet complete  
Public Property The search type to use when excluding files. The default is Wildcard.  
Public Property The search type to use when including files. The default is Wildcard  
Public Property A list of patterns to exclude files. There are some default files excluded.  
Public Property A list of patterns that determines which files to include. If empty, all files will be searched that match any extension listed in the ValidExtensions  
Public Property The maximum number of edits for a Levenshtein fuzzy match. The default is 3 so educate will match with educated, educating and education  
Public Property If true commented lines will be ignored in the search. The default is false.  
Public Property If true, subfolders will be searched. The default is true.  
Public Property When building an index, specify a full path for the index. If the directory does not exist, it will be created.  
Public Property Set to true to abort an asynchronous search  
Public Property A file must be this KB or less to be included in the search. The default is no maximum Kilobytes  
Public Property A file must be modified on or before this datetime to be included in the search. The default is no maximum Last Write Date  
Public Property The maximum number of search results. The default is 200  
Public Property A file must be this KB or more to be included in the search. The default is no minimum Kilobytes  
Public Property A file must be modified on or after this datetime to be included in the search. The default is no minimum Last Write Date  
Public Property How often to raise progress events. The default is 500 milliseconds  
Public Property The time when the search ended  
Public Property The search expression type to use. The default is PlainText  
Public Property The time when the search began  
Public Property The string to search for inside a file. SearchString is required except when the SearchExpressionType is FilesOnly or DirectoriesOnly  
Public PropertyFile extensions that are valid to be searched. There is a default internal list based on Ack''s file types: https://beyondgrep.com/documentation/. Clearing this list will search for all extensions.  
Top
Public Methods
 NameDescription
Public Method Clear the default DirectoriesToExclude, ValidExtensions, and FilesToExclude  
Public Method Create an index hash name based on the search parameters. This can be used for creating a directory name for the index  
Public Method Get validation errors  
Top
Public Events
 NameDescription
Public Event The search or indexing is complete  
Public Event An exception has been thrown  
Public Event Occurs when a file is found that matches  
Public Event Progress  
Top
See Also

Reference

SearchParms Class
KellermanSoftware.FileSearchLibrary Namespace