Spargine is a set of open-source assemblies and NuGet packages for .NET 8 and 9 that I have been developing and maintaining since the release of .NET 2. These assemblies are integral to my projects and are actively used in production at my company.

Get Spargine

You can access the source code and NuGet packages here:

• GitHub: Spargine Releases
• NuGet: dotNetDaveNuGet

Since the inception of .NET, the Path type has provided essential functionality for working with file paths. This class offers static methods for manipulating file and directory paths—combining multiple paths into one, retrieving file names or directory names, and extracting file extensions. These methods also handle platform-specific differences in path syntax, including path separators and volume separator characters.

However, as someone who frequently works with file paths, I have found that Path additional helper methods could be even more powerful. To address this, I created PathHelper, part of the DotNetTips.Spargine project and NuGet package—is a must-have. This article introduces PathHelper and showcases its methods with examples to help you manage file paths more effectively.

Why Use PathHelper?

The Path class is a great starting point, but it has limitations, such as a restricted number of path segments that can be passed to Path.Combine(). PathHelper extends its capabilities by providing more flexible methods for common tasks like combining multiple paths, ensuring proper formatting, and detecting invalid characters or wildcards in paths.

Let us dive into each of these methods and see how they can simplify working with file paths.

Available Methods in PathHelper

Below are the methods currently available in PathHelper, along with examples and explanations of how they work.

1. CombinePaths()

The Path.Combine() method in .NET is limited in how many path segments it can accept. PathHelper. CombinePaths() overcomes this limitation by allowing an unrestricted number of path segments. Additionally, it offers an option to create the directory if it does not already exist.

Here are the available overloads for CombinePaths():

• CombinePaths(bool createIfNotExists, params string[] paths)
• CombinePaths(bool createIfNotExists, string path1, string path2)
• CombinePaths(bool createIfNotExists, string path1, string path2, string path3)
• CombinePaths(bool createIfNotExists, string path1, string path2, string path3, string path4)

Example:

var combinedPath = PathHelper.CombinePaths(true, "C:\\Users", "Public", "Documents"); 

Console.WriteLine(combinedPath.FullName);  // Ensures the directory exists and prints the full path.

2. EnsureTrailingSlash()

The EnsureTrailingSlash(string path) method ensures that a path ends with a directory separator (\ for Windows or / for Unix-based systems).

Example:

string path = "C:\\Users\\Public\\Documents"; 

string result = PathHelper.EnsureTrailingSlash(path); 

Console.WriteLine(result);  // Output: C:\Users\Public\Documents\

3. HasInvalidFilterChars()

The HasInvalidFilterChars(string filter) method checks if the specified filter contains any invalid characters (except wildcards). This can be useful when validating file filters in user input.

Example:

bool isValid = PathHelper.HasInvalidFilterChars("test*?.txt"); 

Console.WriteLine(isValid);  // False, because wildcards are allowed.

4. PathContainsWildcard()

The PathContainsWildcard(string path) method determines if a path contains wildcards (* or ?).

Example:

bool containsWildcard = PathHelper.PathContainsWildcard("C:\\Temp\\*.txt"); 

Console.WriteLine(containsWildcard);  // True

5. PathHasInvalidChars()

The PathHasInvalidChars(string path) method checks whether the path contains any invalid characters. This can help prevent runtime errors when working with file paths.

Example:

bool hasInvalidChars = PathHelper.PathHasInvalidChars("C:\\Temp\\<Invalid>.txt"); 

Console.WriteLine(hasInvalidChars);  // True

6. InvalidFilterChars()

The InvalidFilterChars() method returns a list of invalid characters that cannot be used in file filters. For Windows, these characters include:

"\", <, >, \0, \u0001–\u001f, :

7. InvalidPathNameChars()

The InvalidPathNameChars() method returns all invalid characters for path names as an IReadOnlyList<char>. This is especially useful when performing custom path validation.

8. PathSeparators()

The PathSeparators() method returns the platform-specific path separator characters (\ for Windows, / for Unix-based systems).

Summary

When working with file paths in .NET, the PathHelper type from Spargine offers extended functionality that simplifies and enhances path management. Whether you need to combine multiple path segments, ensure proper formatting, or validate path strings, PathHelper provides robust solutions.

If you have feature requests or suggestions for improving PathHelper, feel free to reach out!

Contact me at dotnetdave@live.com.

Together, we can make Spargine an essential tool for the .NET community.

Thank you for your support, and happy coding!

Pick up any books by David McCarter by going to Amazon.com: http://bit.ly/RockYourCodeBooks

If you liked this article, please buy David a cup of Coffee by going here: https://www.buymeacoffee.com/dotnetdave

© The information in this article is copywritten and cannot be reproduced in any way without express permission from David McCarter.