Merge pull request #64 from deadlydog/Add-Search-Pattern-examples

Changelog.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## v1.11.7 - August 26, 2021
+
+Fixes:
+
+- Update Search Pattern tooltip to mention the `*` is a wildcard character.
+
 ## v1.11.2 - February 21, 2021
 
 Fixes:

ReadMe.md

@@ -21,6 +21,19 @@ The `PathLengthChecker.exe` is the command-line alternative to the GUI. Simply r
 
 `PathLengthCheckerGUI.exe` also supports the same command-line parameter syntax. Additionally, specifying the target directory alone as the only argument is supported and will begin a search on the supplied path using defaults. This is useful for launching the GUI application from other programs, such as a Windows Explorer context menu action.
 
+## Search Pattern
+
+The `Search Pattern` is used to match against specific file/directory names.
+It is not case sensitive, and it supports wildcards (`*`).
+
+Examples:
+
+- `test.txt` matches only files named `test.txt`.
+- `test` matches any directory named `test`, as well as any files named `test` that do not have an extension.
+- `test*` matches any file or directory whose name begins with `test`.
+- `*txt` matches any files with a `.txt` extension, as well as any directory whose name ends in `txt`.
+- `*test*` matches any file or directory that contains `test` anywhere in the name or extension.
+
 ## Running via PowerShell
 
 If you are looking for a PowerShell equivalent of this tool, you can use [this PowerShell script](tools/GetPathLengths.ps1) that offers similar functionality.

src/PathLengthCheckerGUI/MainWindow.xaml

@@ -135,8 +135,8 @@
 				</Grid>
 
 				<DockPanel Grid.Row="5">
-					<TextBlock Text="Search Pattern:" Margin="0,0,5,0" ToolTip="Only files/directories that match the given pattern will be returned." />
-					<TextBox Name="txtSearchPattern" Text="{local:ApplicationSettingsBinding Path=SearchOption_SearchPattern, UpdateSourceTrigger=PropertyChanged}" HorizontalAlignment="Stretch" ToolTip="Only files/directories that match the given pattern will be returned. The * is a wildcard." />
+					<TextBlock Text="Search Pattern:" Margin="0,0,5,0" ToolTip="Only file/directory names that match the given pattern will be returned. The * is a wildcard." />
+					<TextBox Name="txtSearchPattern" Text="{local:ApplicationSettingsBinding Path=SearchOption_SearchPattern, UpdateSourceTrigger=PropertyChanged}" HorizontalAlignment="Stretch" ToolTip="Only file/directory names that match the given pattern will be returned. The * is a wildcard." />
 				</DockPanel>
 			</Grid>
 		</GroupBox>