Skip to content

Commit aabed41

Browse files
2 parents 428b06d + c8c302a commit aabed41

File tree

1 file changed

+21
-11
lines changed

1 file changed

+21
-11
lines changed

README.md

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,13 @@
1-
# Excel-VBA-Directory-Manager
2-
Uses a single Class to parse all the files and folders in a specified directory without using FileSystemObject or setting special references. Perfect for integrating into projects you can distribute to the lay person without worrying if they have set their references correctly in the VBA editor.
1+
# Excel VBA Directory Manager
2+
Parse all the files and folders in a specified directory without using FileSystemObject or setting special references. Perfect for integrating into projects you will distribute to the lay person without worrying if they have set their references correctly in the VBA editor.
33

44
## Requirements
55
- Microsoft Office 2007 or newer (Not tested for earlier versions)
66
- A macro enabled file
7-
- Knowledge of how to [add a Class module](https://analystcave.com/vba-vba-class-tutorial/) to your project
87

98
## Getting Started
109
A single Class file contains all functionality. To use it in your project, use one of the following methods to add them in the IDE:
1110

12-
To use it in your project, then use one of the following methods to add them in the IDE.
13-
1411
- Save the [source code module](/DirectoryManager.cls) to your machine, then import it into the Project using the IDE
1512

1613
Or,
@@ -33,10 +30,15 @@ Or,
3330

3431
# Example Use
3532

36-
The below examples are also located in the [example workbook](/ExampleWorkbook.xlsm).
33+
DirectoryManager is simple and fast to set up. The below examples will walk you through common use. They are also located in the [example workbook](/ExampleWorkbook.xlsm).
3734

3835
## Initial Setup, Printing All Files/Folders
3936

37+
The first step is to declare the variable and initialize it with a path. The path can be to either a folder or a file.
38+
39+
If set to a folder, DirectoryManager then parses all the files, folders, and subfolders in that location. These are stored and accessed in Collections.
40+
41+
4042
```VBA
4143
Sub CreateNewDirectoryManager()
4244
@@ -78,6 +80,8 @@ End Sub
7880
## Use Omitted Characters to Exclude Files or Folders
7981
Setting the `OmittedPrefix` property to a non-empty string will cause the DirectoryManager to exclude any file or folder that starts with that string.
8082

83+
This is useful if you want to use DirectoryManager to exclude specific folders or files from your project.
84+
8185
```VBA
8286
Sub SetOmmitedPrefix()
8387
@@ -114,11 +118,11 @@ Sub SetOmmitedPrefix()
114118
115119
End Sub
116120
```
117-
Changing `OmittedPrefix` will cause the DirectoryManager to re-parse the file or folder set at the current `Path`.
121+
Changing `OmittedPrefix` at any time will cause the DirectoryManager to re-parse the file or folder set at the current `Path`.
118122

119123
## Check if a File or Folder Exists
120124

121-
The DirectoryManager can easily tell you if a file or folder at the specified `Path` exists.
125+
The DirectoryManager can tell you if a file or folder at the specified `Path` exists.
122126

123127
```VBA
124128
Sub CheckIfFileOrFolderExists()
@@ -145,10 +149,16 @@ Sub CheckIfFileOrFolderExists()
145149
End Sub
146150
```
147151

152+
# Contributing and Outlook
148153

149-
# License
150-
Distributed under the MIT License. See [LICENSE](./LICENSE) for more information.
154+
I am not actively pursuing additional development. This Class resource has all intended functionality in version 1.0. I consider it feature complete, but will continue to provide bug support.
155+
156+
That said, I will in no way turn away additional contributions or expansions if beneficial or needed in the future.
151157

158+
All are welcome to open an issue or feature request.
159+
160+
# License
161+
Distributed under the [MIT License](./LICENSE), copyright 2022.
152162

153163
# Contact
154-
Reach me on [LinkedIn](https://www.linkedin.com/in/mscottlassiter/) or [Twitter](https://twitter.com/MScottLassiter).
164+
Reach me on [LinkedIn](https://www.linkedin.com/in/mscottlassiter/) or [Twitter](https://twitter.com/MScottLassiter).

0 commit comments

Comments
 (0)