Help text for dialogboxes

(view help text of dialogboxes as plain text)

Help for OpenFolderBox class
─────────────────────────────

Present a Browse Folder dialog, and return the selected folder path


COM ProgID: RobvanderWoude.OpenFolderBox


┌──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
│                                                                                                                                              │
│ Properties        (Note that all properties are string or integer, no booleans, objects or arrays)                                           │
│                                                                                                                                              │
╞══════════════════╤════════════════════════════════════════════════════╤═══════════╤═══════════╤══════════════════════════════════════════════╡
│ Property Name    │ Description                                        │ Mandatory │ Read-Only │ Default (Allowed) Values                     │
╞══════════════════╪════════════════════════════════════════════════════╪═══════════╪═══════════╪══════════════════════════════════════════════╡
│ allowmakedir     │ Show "Make New Folder" button    (0=false; 1=true) │ no        │ no        │ 0: don't show                                │
├──────────────────┼────────────────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────┤
│ debuginfo        │ A log of actions for debugging                     │ N/A       │ YES       │                                              │
├──────────────────┼────────────────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────┤
│ description      │ Text above directory tree in dialog                │ no        │ no        │                                              │
├──────────────────┼────────────────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────┤
│ errors           │ List of errors with current settings               │ N/A       │ YES       │                                              │
├──────────────────┼────────────────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────┤
│ rootfolderfolder │ Windows Special Folder that is used as the         │ no        │ no        │ MyComputer (use the "ListSpecialFolders"     │
│                  │ directory tree root                                │           │           │ method to get a list of valid names)         │
├──────────────────┼────────────────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────┤
│ selectedfolder   │ The path of the selected folder                    │ N/A       │ YES       │                                              │
├──────────────────┼────────────────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────┤
│ startfolder      │ The initial folder for the dialog                  │ no        │ no        │ D:\Users\Rob\Documents                       │
└──────────────────┴────────────────────────────────────────────────────┴───────────┴───────────┴──────────────────────────────────────────────┘


┌──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
│                                                                                                                                              │
│ Methods                                                                                                                                      │
│                                                                                                                                              │
╞════════════════════╤════════════════════════════════════════════════════════════════════════════╤════════════════════════════════════════════╡
│ Method Name        │ Description                                                                │ Requirements                               │
╞════════════════════╪════════════════════════════════════════════════════════════════════════════╪════════════════════════════════════════════╡
│ CheckUpdate        │ Check the developer's website for updates                                  │                                            │
├────────────────────┼────────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────┤
│ Credits            │ Shows credits                                                              │                                            │
├────────────────────┼────────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────┤
│ Help               │ Returns this help text as plain text, or if optional parameter equals 1,   │                                            │
│                    │ as html                                                                    │                                            │
├────────────────────┼────────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────┤
│ ListSpecialFolders │ Returns a semicolon-separated list of Windows Special Folders              │                                            │
├────────────────────┼────────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────┤
│ ListProperties     │ Returns a list of this class' properties as key=value pairs (1 per line)   │                                            │
├────────────────────┼────────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────┤
│ SampleCode         │ Returns VBScript sample code for this dialog                               │                                            │
├────────────────────┼────────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────┤
│ Show               │ Presents a Browse Folder dialog based on the current property values, and  │                                            │
│                    │ if "OK"is clicked, saves the selected folder path in the "selectedfolder"  │                                            │
│                    │ property (if "Cancel" is clicked, the startfolder is assumed selected).    │                                            │
└────────────────────┴────────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────┘


VBScript usage example:
───────────────────────

Set objOpenFolderBox = CreateObject( "RobvanderWoude.OpenFolderBox" )

With objOpenFolderBox
	.rootfolder = "MyDocuments"
	.Show
	WScript.Echo "Selected folder: " & .selectedfolder
	WScript.Echo
	WScript.Echo .ListProperties( )
End With

Set objOpenFolderBox = Nothing