Name | Description | |
---|---|---|
SearchParms Constructor | Default constructor |
The following tables list the members exposed by SearchParms.
Name | Description | |
---|---|---|
SearchParms Constructor | Default constructor |
Name | Description | |
---|---|---|
CaseSensitive | If true, a case sensitive search will be performed. The default is false. | |
DirectoriesToExclude | A list of patterns to exclude directories. There are several directories excluded by default. | |
DirectoriesToSearch | A list of paths for directories to search. This is required. | |
DirectoryExcludeSearchType | The search type to use when excluding directories. The default is wildcard. | |
ElapsedTime | The time it took for the search or null if the search is not yet complete | |
FileExcludeSearchType | The search type to use when excluding files. The default is Wildcard. | |
FileIncludeSearchType | The search type to use when including files. The default is Wildcard | |
FilesToExclude | A list of patterns to exclude files. There are some default files excluded. | |
FilesToInclude | 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 | |
FuzzyEditMax | The maximum number of edits for a Levenshtein fuzzy match. The default is 3 so educate will match with educated, educating and education | |
IgnoreCommentedLines | If true commented lines will be ignored in the search. The default is false. | |
IncludeSubfolders | If true, subfolders will be searched. The default is true. | |
IndexPath | When building an index, specify a full path for the index. If the directory does not exist, it will be created. | |
IsCancelled | Set to true to abort an asynchronous search | |
MaxKB | A file must be this KB or less to be included in the search. The default is no maximum Kilobytes | |
MaxLastWriteDate | A file must be modified on or before this datetime to be included in the search. The default is no maximum Last Write Date | |
MaxSearchResults | The maximum number of search results. The default is 200 | |
MinKB | A file must be this KB or more to be included in the search. The default is no minimum Kilobytes | |
MinLastWriteDate | A file must be modified on or after this datetime to be included in the search. The default is no minimum Last Write Date | |
ProgressUpdateFrequencyInMilliseconds | How often to raise progress events. The default is 500 milliseconds | |
SearchEndTime | The time when the search ended | |
SearchExpressionType | The search expression type to use. The default is PlainText | |
SearchStartTime | The time when the search began | |
SearchString | The string to search for inside a file. SearchString is required except when the SearchExpressionType is FilesOnly or DirectoriesOnly | |
ValidExtensions | File 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. |
Name | Description | |
---|---|---|
ClearDefaults | Clear the default DirectoriesToExclude, ValidExtensions, and FilesToExclude | |
GenerateIndexHashNameBasedOnCriteria | Create an index hash name based on the search parameters. This can be used for creating a directory name for the index | |
GetValidationErrors | Get validation errors |
Name | Description | |
---|---|---|
CompleteEvent | The search or indexing is complete | |
ExceptionEvent | An exception has been thrown | |
FileFoundEvent | Occurs when a file is found that matches | |
ProgressEvent | Progress |