Platforms to show: All Mac Windows Linux Cross-Platform

Back to WinFileDialogMBS class.

WinFileDialogMBS.ClientGuid as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Navigation MBS WinFrameworks Plugin 20.1 ❌ No ✅ Yes ❌ No ❌ No Desktop only
The client GUID.

A dialog's state can include factors such as the last visited folder and the position and size of the dialog.
Typically, this state is persisted based on the name of the executable file. By specifying a GUID, an application can have different persisted states for different versions of the dialog within the same application (for example, an import dialog and an open dialog).

SetClientGuid should be called immediately after creation of the dialog object.

Enables a calling application to associate a GUID with a dialog's persisted state.
(Read and Write property)

WinFileDialogMBS.CurrentSelection as WinShellItemMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Navigation MBS WinFrameworks Plugin 20.1 ❌ No ✅ Yes ❌ No ❌ No Desktop only
The user's current selection in the dialog.

The item currently selected in the dialog. This item can be a file or folder selected in the view window, or something that the user has entered into the dialog's edit box. The latter case may require a parsing operation (cancelable by the user) that blocks the current thread.

If not result exists, the plugin returns nil and raises no failed exceptions.
(Read only property)

WinFileDialogMBS.DefaultExtension as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Navigation MBS WinFrameworks Plugin 20.1 ❌ No ✅ Yes ❌ No ❌ No Desktop only
The default extension to be added to file names.
Example
Var d As WinFileOpenDialogMBS // your dialog
d.DefaultExtension = "jpg"

The extension text. This string should not include a leading period. For example, "jpg" is correct, while ".jpg" is not.

If this method is called before showing the dialog, the dialog will update the default extension automatically when the user chooses a new file type (see SetFileTypes).
(Read and Write property)

Some examples using this property:

WinFileDialogMBS.DefaultFolder as WinShellItemMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Navigation MBS WinFrameworks Plugin 20.1 ❌ No ✅ Yes ❌ No ❌ No Desktop only
The folder used as a default if there is not a recently used folder value available.
Example
Var d As WinFileOpenDialogMBS // your dialog
d.DefaultFolder = New WinShellItemMBS(SpecialFolder.Desktop)

(Read and Write property)

Some examples using this property:

WinFileDialogMBS.FileName as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Navigation MBS WinFrameworks Plugin 20.1 ❌ No ✅ Yes ❌ No ❌ No Desktop only
The text currently entered in the dialog's File name edit box.
Example
Var d As WinFileOpenDialogMBS // your dialog
d.FileName = "New Document"

The text in the File name edit box does not necessarily reflect the item the user chose. To get the item the user chose, use Result property.

If not result exists, the plugin returns "" and raises no failed exceptions.
(Read and Write property)

WinFileDialogMBS.FileNameLabel as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Navigation MBS WinFrameworks Plugin 20.1 ❌ No ✅ Yes ❌ No ❌ No Desktop only
The text of the label next to the file name edit box.

(Read and Write property)

Some examples using this property:

WinFileDialogMBS.FileTypeIndex as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Navigation MBS WinFrameworks Plugin 20.1 ❌ No ✅ Yes ❌ No ❌ No Desktop only
The currently selected file type.

The index of the selected file type in the file type array passed to SetFileTypes.

This is a one-based index rather than zero-based.
FileTypeIndex can be called either while the dialog is open or after it has closed.
(Read and Write property)

Some examples using this property:

WinFileDialogMBS.Folder as WinShellItemMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Navigation MBS WinFrameworks Plugin 20.1 ❌ No ✅ Yes ❌ No ❌ No Desktop only
A folder that is always selected when the dialog is opened, regardless of previous user action.

Gets either the folder currently selected in the dialog, or, if the dialog is not currently displayed, the folder that is to be selected when the dialog is opened.

This folder overrides any "most recently used" folder. If this method is called while the dialog is displayed, it causes the dialog to navigate to the specified folder.
In general, we do not recommended the use of this method. If you call SetFolder before you display the dialog box, the most recent location that the user saved to or opened from is not shown. Unless there is a very specific reason for this behavior, it is not a good or expected user experience and should therefore be avoided. In almost all instances, SetDefaultFolder is the better method.

As of Windows 7, if the path of the folder specified through psi is the default path of a known folder, the known folder's current path is used in the dialog. That path might not be the same as the path specified in psi; for instance, if the known folder has been redirected. If the known folder is a library (virtual folders Documents, Music, Pictures, and Videos), the library's path is used in the dialog. If the specified library is hidden (as they are by default as of Windows 8.1), the library's default save location is used in the dialog, such as the Microsoft OneDrive Documents folder for the Documents library. Because of these mappings, the folder location used in the dialog might not be exactly as you specified when you called this method.
(Read and Write property)

WinFileDialogMBS.Handle as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Navigation MBS WinFrameworks Plugin 20.1 ❌ No ✅ Yes ❌ No ❌ No Desktop only
The internal object reference.

(Read and Write property)

WinFileDialogMBS.ProminentControlID as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Navigation MBS WinFrameworks Plugin 20.1 ❌ No ✅ Yes ❌ No ❌ No Desktop only
Places a control in the dialog so that it stands out compared to other added controls.

Setting this property causes the control to be placed near the Open or Save button instead of being grouped with the rest of the custom controls.
Only check buttons (check boxes), push buttons, combo boxes, and menus—or a visual group that contains only a single item of one of those types—can be made prominent.
Only one control can be marked in this way. If a dialog has only one added control, that control is marked as prominent by default.
(Read and Write property)

WinFileDialogMBS.Result as WinShellItemMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Navigation MBS WinFrameworks Plugin 20.1 ❌ No ✅ Yes ❌ No ❌ No Desktop only
The choice that the user made in the dialog.

Result can be called after the dialog has closed or during the handling of an OnFileOk event. Calling this method at any other time will fail. If multiple items were chosen, this method will fail. In the case of multiple items, call Results method.
Show must return a success code for a result to be available to Result.

If not result exists, the plugin returns nil and raises no failed exceptions.
(Read only property)

WinFileDialogMBS.Title as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Navigation MBS WinFrameworks Plugin 20.1 ❌ No ✅ Yes ❌ No ❌ No Desktop only
The title of the dialog.
Example
Var d As WinFileOpenDialogMBS // your dialog
d.title = "Export database"

(Read and Write property)

WinFileDialogMBS.WindowHandle as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Navigation MBS WinFrameworks Plugin 20.1 ❌ No ✅ Yes ❌ No ❌ No Desktop only
Queries window handle.

Value is a HWND and may be used in declares.
(Read only property)

The items on this page are in the following plugins: MBS WinFrameworks Plugin.


The biggest plugin in space...