Platforms to show: All Mac Windows Linux Cross-Platform

WinFileDialogMBS.AddCheckButton(ControlID as Integer, label as String, Checked as boolean = false)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Navigation MBS Win Plugin 20.1 No Yes No Yes, Windows only No
Function: Adds a check button (check box) to the dialog.
Notes:
ControlID: The ID of the check button to add.
Label: the button text.
Checked: A boolean indicating the current state of the check button. True if checked; false otherwise.

The default state for this control is enabled and visible.

Feedback, Comments & Corrections

WinFileDialogMBS.AddComboBox(ControlID as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Navigation MBS Win Plugin 20.1 No Yes No Yes, Windows only No
Function: Adds a combo box to the dialog.
Notes:
ControlID: The ID of the combo box to add.

The default state for this control is enabled and visible.

Feedback, Comments & Corrections

WinFileDialogMBS.AddControlItem(ControlID as Integer, ItemID as Integer, Label as String)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Navigation MBS Win Plugin 20.1 No Yes No Yes, Windows only No
Function: Adds an item to a container control in the dialog.
Notes:
ControlID: The ID of the container control to which the item is to be added.
ItemID: The ID of the item.
Label: The item's text, which can be either a label or, in the case of a drop-down list, the item itself.

The default state for this item is enabled and visible. Items in control groups cannot be changed after they have been created, with the exception of their enabled and visible states.
Container controls include option button groups, combo boxes, drop-down lists on the Open or Save button, and menus.

Feedback, Comments & Corrections

WinFileDialogMBS.AddEditBox(ControlID as Integer, Text as String = "")
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Navigation MBS Win Plugin 20.1 No Yes No Yes, Windows only No
Function: Adds an edit box control to the dialog.
Notes:
ControlID: The ID of the edit box to add.
Text: The default text displayed in the edit box.

The default state for this control is enabled and visible.
To add a label next to the edit box, place it in a visual group with StartVisualGroup.

Feedback, Comments & Corrections

WinFileDialogMBS.AddMenu(ControlID as Integer, Label as String)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Navigation MBS Win Plugin 20.1 No Yes No Yes, Windows only No
Function: Adds a menu to the dialog.
Notes:
ControlID: The ID of the menu to add.
Label: The menu name.

The default state for this control is enabled and visible.
To add items to this control, use AddControlItem.

Feedback, Comments & Corrections

WinFileDialogMBS.AddPlace(Item as WinShellItemMBS, top as boolean = false)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Navigation MBS Win Plugin 20.1 No Yes No Yes, Windows only No
Function: Adds a folder to the list of places available for the user to open or save items.
Notes:
Item: the folder to be made available to the user. This can only be a folder.
Top: Specifies where the folder is placed within the list. Pass true for top or false for bottom.

Feedback, Comments & Corrections

WinFileDialogMBS.AddPushButton(ControlID as Integer, Label as String)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Navigation MBS Win Plugin 20.1 No Yes No Yes, Windows only No
Function: Adds a button to the dialog.
Notes:
ControlID: The ID of the button to add.
Label: the button text

The default state for this control is enabled and visible..

Feedback, Comments & Corrections

WinFileDialogMBS.AddRadioButtonList(ControlID as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Navigation MBS Win Plugin 20.1 No Yes No Yes, Windows only No
Function: Adds an option button (also known as radio button) group to the dialog.
Notes:
ControlID: The ID of the option button group to add.
The default state for this control is enabled and visible.

Feedback, Comments & Corrections

WinFileDialogMBS.AddSeparator(ControlID as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Navigation MBS Win Plugin 20.1 No Yes No Yes, Windows only No
Function: Adds a separator to the dialog, allowing a visual separation of controls.
Notes:
ControlID: The control ID of the separator.

The default state for this control is enabled and visible.

Feedback, Comments & Corrections

WinFileDialogMBS.AddText(ControlID as Integer, Text as String = "")
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Navigation MBS Win Plugin 20.1 No Yes No Yes, Windows only No
Function: Adds text content to the dialog.
Notes:
ControlID: The ID of the text to add.
Text: The text to show.

The default state for this control is enabled and visible.

Feedback, Comments & Corrections

WinFileDialogMBS.CheckButtonState(ControlID as Integer) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Navigation MBS Win Plugin 20.1 No Yes No Yes, Windows only No
Function: The current state of a check button (check box) in the dialog.
Notes:
ControlID: The ID of the check box.

True means checked; false, unchecked.
(Read and Write computed property)

Feedback, Comments & Corrections

WinFileDialogMBS.ClearClientData
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Navigation MBS Win Plugin 20.1 No Yes No Yes, Windows only No
Function: Instructs the dialog to clear all persisted state information.
Notes: Persisted information can be associated with an application or a GUID. If a GUID was set by using SetClientGuid, that GUID is used to clear persisted information.

Feedback, Comments & Corrections

WinFileDialogMBS.Close(cancel as boolean = false)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Navigation MBS Win Plugin 20.1 No Yes No Yes, Windows only No
Function: Closes the dialog.
Notes:
Pass or false/true for cancel parameter to have that being returned by Show method.

An application can call this method from an event while the dialog is open. The dialog will close and the Show method will return with the result given by cancel parameter.

If this method is called, there is no result available for the Result or Results methods, and they will fail if called.

Feedback, Comments & Corrections

WinFileDialogMBS.Constructor
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Navigation MBS Win Plugin 20.1 No Yes No Yes, Windows only No
Function: The private constructor.

Feedback, Comments & Corrections

WinFileDialogMBS.ControlItemState(ControlID as Integer, ItemID as Integer) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Navigation MBS Win Plugin 20.1 No Yes No Yes, Windows only No
Function: The current state of an item in a container control found in the dialog.
Notes:
ControlID: The ID of the container control.
ItemID: The ID of the item.

See kControlState* flags.
(Read and Write computed property)

Feedback, Comments & Corrections

WinFileDialogMBS.ControlItemText(ControlID as Integer, ItemID as Integer) as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Navigation MBS Win Plugin 20.1 No Yes No Yes, Windows only No
Function: The text of a control item.
Notes:
For example, the text that accompanies a radio button or an item in a menu.

ControlID: The ID of the container control.
ItemID: The ID of the item.

The default state of a control item is enabled and visible. Items in control groups cannot be changed after they have been created, with the exception of their enabled and visible states.
Container controls include option button groups, combo boxes, drop-down lists on the Open or Save button, and menus.
(Read and Write computed property)

Feedback, Comments & Corrections

WinFileDialogMBS.ControlLabel(ControlID as Integer) as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Navigation MBS Win Plugin 20.1 No Yes No Yes, Windows only No
Function: The text associated with a control, such as button text or an edit box label.
Notes:
ControlID: The ID of the control whose text is to be changed.

Control labels can be changed at any time, including when the dialog is visible.
(Read and Write computed property)

Feedback, Comments & Corrections

WinFileDialogMBS.ControlState(ControlID as Integer) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Navigation MBS Win Plugin 20.1 No Yes No Yes, Windows only No
Function: Gets the current visibility and enabled states of a given control.
Notes:
ControlID: The ID of the control in question.

See kControlState* flags.
(Read and Write computed property)

Feedback, Comments & Corrections

WinFileDialogMBS.EditBoxText(ControlID as Integer) as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Navigation MBS Win Plugin 20.1 No Yes No Yes, Windows only No
Function: The current text in an edit box control.
Notes:
ControlID: The ID of the edit box.
(Read and Write computed property)

Feedback, Comments & Corrections

WinFileDialogMBS.EnableOpenDropDown(ControlID as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Navigation MBS Win Plugin 20.1 No Yes No Yes, Windows only No
Function: Enables a drop-down list on the Open or Save button in the dialog.
Notes:
ControlID: The ID of the drop-down list.

The Open or Save button label takes on the text of the first item in the drop-down. This overrides any label set by OkButtonLabel.
Use AddControlItem to add items to the drop-down.

Feedback, Comments & Corrections

WinFileDialogMBS.EndVisualGroup
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Navigation MBS Win Plugin 20.1 No Yes No Yes, Windows only No
Function: Stops the addition of elements to a visual group in the dialog.

Feedback, Comments & Corrections

WinFileDialogMBS.RemoveAllControlItems(ControlID as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Navigation MBS Win Plugin 20.1 No Yes No Yes, Windows only No
Function: Removes all items from a container control in the dialog.
Notes:
ControlID: The ID of the container control from which to remove the items.

Container controls include option button groups, combo boxes, drop-down lists on the Open or Save button, and menus.

Feedback, Comments & Corrections

WinFileDialogMBS.RemoveControlItem(ControlID as Integer, ItemID as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Navigation MBS Win Plugin 20.1 No Yes No Yes, Windows only No
Function: Removes an item from a container control in the dialog.
Notes:
ControlID: The ID of the container control from which the item is to be removed.
ItemId: The ID of the item.

Container controls include option button groups, combo boxes, drop-down lists on the Open or Save button, and menus.

Feedback, Comments & Corrections

WinFileDialogMBS.SelectedControlItem(ControlID as Integer) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Navigation MBS Win Plugin 20.1 No Yes No Yes, Windows only No
Function: Item index from specified container controls in the dialog.
Notes:
ControlID: The ID of the container control.

Value is the ID of the item that the user selected in the control.

To determine the user's final choice, this method can be called on option button groups, combo boxes, and drop-down lists on the Open or Save button after the dialog has closed. This method cannot be called on menus.
For option button groups and combo boxes, this method can also be called while the dialog is showing, to determine the current choice.

When you query, the plugin does not raise error for failure, but returns 0.
(Read and Write computed property)

Feedback, Comments & Corrections

WinFileDialogMBS.SetFileTypes(FileTypes() as WinFileTypeMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Navigation MBS Win Plugin 20.1 No Yes No Yes, Windows only No
Function: The file types that the dialog can open or save.
Example:
Dim d As WinFileOpenDialogMBS // your dialog
Dim FileTypes() As WinFileTypeMBS

FileTypes.Append New WinFileTypeMBS("JPEG image", "*.jpg")
FileTypes.Append New WinFileTypeMBS("PNG image", "*.png")
FileTypes.Append New WinFileTypeMBS("Tiff image", "*.tif;*.tiff")

d.SetFileTypes FileTypes
Notes:
When using the Open dialog, the file types declared there are used to filter the view. When using the Save dialog, these values determine which file name extension is appended to the file name.
This method must be called before the dialog is shown and can only be called once for each dialog instance. File types cannot be modified once the Common Item dialog box is displayed.

Feedback, Comments & Corrections

WinFileDialogMBS.Show as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Navigation MBS Win Plugin 20.1 No Yes No Yes, Windows only No
Function: Launches the modal window.
Notes: Returns true on success or false on failure.

See also:

Feedback, Comments & Corrections

WinFileDialogMBS.Show(parent as window) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Navigation MBS Win Plugin 20.1 No Yes No No No
Function: Launches the modal window.
Notes:
parent: The handle of the owner window. This value can be nil.
Returns true on success or false on failure.

See also:

Feedback, Comments & Corrections

WinFileDialogMBS.StartVisualGroup(ControlID as Integer, label as String)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Navigation MBS Win Plugin 20.1 No Yes No Yes, Windows only No
Function: Declares a visual group in the dialog. Subsequent calls to any "add" method add those elements to this group.
Example:
Dim d As WinFileOpenDialogMBS // your dialog

d.StartVisualGroup 1, "Metadata"
d.AddText 2, "Author:"
d.AddEditBox 3, CustomValue.Text
d.AddText 4, "Subject:"
d.AddEditBox 5, "Hello World"
d.EndVisualGroup
Notes:
ControlID: The ID of the visual group.
Label: text that appears next to the visual group.

Controls will continue to be added to this visual group until you call EndVisualGroup.
A visual group can be hidden and disabled like any other control, except that doing so affects all of the controls within it. Individual members of the visual group can also be hidden and disabled singly.

Feedback, Comments & Corrections

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

The biggest plugin in space...




Links
MBS Xojo Chart Plugins