Platforms to show: All Mac Windows Linux Cross-Platform
Back to WinFileDialogMBS class.
WinFileDialogMBS.ButtonClicked(ControlID as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Navigation | MBS WinFrameworks Plugin | 20.1 | ❌ No | ✅ Yes | ❌ No | ❌ No |
ControlID: The ID of the button that the user clicked.
WinFileDialogMBS.CheckButtonToggled(ControlID as Integer, Checked as Boolean)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Navigation | MBS WinFrameworks Plugin | 20.1 | ❌ No | ✅ Yes | ❌ No | ❌ No |
ControlID: The ID of the button that the user clicked.
Checked: A boolean indicating the current state of the check button. true if checked; false otherwise.
Some examples using this event:
WinFileDialogMBS.ControlActivating(ControlID as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Navigation | MBS WinFrameworks Plugin | 20.1 | ❌ No | ✅ Yes | ❌ No | ❌ No |
ControlID: The ID of the list or menu about to display.
In response to this notification, an application can update the contents of the menu or list about to be displayed, based on the current state of the dialog.
Some examples using this event:
WinFileDialogMBS.FileOk as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Navigation | MBS WinFrameworks Plugin | 20.1 | ❌ No | ✅ Yes | ❌ No | ❌ No |
Implementations should return true to accept the current result in the dialog or false to refuse it. In the case of false, the dialog should remain open.
When this method is called, the Result and Results methods can be called.
The application can use this callback method to perform additional validation before the dialog closes, or to prevent the dialog from closing. If the application prevents the dialog from closing, it should display a UI to indicate a cause.
An application can also use this method to perform all of its work surrounding the opening or saving of files.
Some examples using this event:
WinFileDialogMBS.FileTypeChanged
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Navigation | MBS WinFrameworks Plugin | 20.1 | ❌ No | ✅ Yes | ❌ No | ❌ No |
This method is called when the dialog is opened to notify the application of the initially chosen filetype. If the application has code in this event that responds to type changes, it can respond to the type. For example, it could hide certain controls. The application controls the initial file type and could do its own checks, so this method is provided as a convenience.
Some examples using this event:
WinFileDialogMBS.FolderChanged
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Navigation | MBS WinFrameworks Plugin | 20.1 | ❌ No | ✅ Yes | ❌ No | ❌ No |
Some examples using this event:
WinFileDialogMBS.FolderChanging(Folder as WinShellItemMBS) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Navigation | MBS WinFrameworks Plugin | 20.1 | ❌ No | ✅ Yes | ❌ No | ❌ No |
This allows the implementer to stop navigation to a particular location.
Folder: the folder to which the dialog is about to navigate.
Return true to accept or false to decline.
The calling application can set Folder during this callback to redirect navigation to an alternate folder. The actual navigation does not occur until FolderChanging has returned.
If the calling application simply prevents navigation to a particular folder, UI should be displayed with an explanation of the restriction. To obtain a parent HWND for the UI, use WindowHandle property.
Warning: If you implement this, add "return true" to allow folders to change.
Some examples using this event:
WinFileDialogMBS.ItemSelected(ControlID as Integer, ItemID as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Navigation | MBS WinFrameworks Plugin | 20.1 | ❌ No | ✅ Yes | ❌ No | ❌ No |
ControlID: The ID of the control in which the user made a selection.
ItemID: The ID of the selection.
This notification is not sent when the user chooses an item from the drop-down menu attached to the Open button, because the action taken in that case is always the same: close the dialog as if the user had simply clicked the Open button. For that situation, the application can call SelectedControlItem to obtain the item the user chose from that menu.
Some examples using this event:
WinFileDialogMBS.Overwrite(item as WinShellItemMBS) as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Navigation | MBS WinFrameworks Plugin | 20.1 | ❌ No | ✅ Yes | ❌ No | ❌ No |
item: the item that will be overwritten.
Return one of the kResponse* constants.
WinFileDialogMBS.SelectionChange
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Navigation | MBS WinFrameworks Plugin | 20.1 | ❌ No | ✅ Yes | ❌ No | ❌ No |
Some examples using this event:
WinFileDialogMBS.ShareViolation(item as WinShellItemMBS) as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Navigation | MBS WinFrameworks Plugin | 20.1 | ❌ No | ✅ Yes | ❌ No | ❌ No |
item: the item that has the sharing violation.
Return one of the kShareViolation* constants.
The kOptionsShareaware flag must be set through Options before this method is called.
A sharing violation could possibly arise when the application attempts to open a file, because the file could have been locked between the time that the dialog tested it and the application opened it.
Some examples using this event:
The items on this page are in the following plugins: MBS WinFrameworks Plugin.