MBS Plugin Documentation

Search:

Statistics   -   FAQ   -   Plugin Parts (All, Dependencies)   -   Class hierarchie

New in Version 7.0 7.1 7.2 7.3 7.4 7.5 7.6 7.7 7.8 8.0 8.1 8.2 8.3 8.4 8.5 8.6 8.7 9.0

The list of the   themes,   classes,   controls,   modules,   global methods by category,   global methods by name,   screenshots,   licenses   and   examples.

Platforms to show: All Mac Windows Linux Cross-Platform

OpenDialogMBS.ActionButtonLabel as String
property, Navigation, MBS Util Plugin (OpenDialog), class OpenDialogMBS, Plugin version: 4.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The label of the action button.
Notes:
Used only on Mac OS.
For RB 4.5 and earlier you need to make sure the encoding is set correctly.
Can be set to "" to use the default value.
(Read and Write property)
OpenDialogMBS.AddType(t as OpenDialogFileTypeMBS)
method, Navigation, MBS Util Plugin (OpenDialog), class OpenDialogMBS, Plugin version: 4.2, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Adds a file type to the list.
OpenDialogMBS.AllowFolderSelection as Boolean
property, Navigation, MBS Util Plugin (OpenDialog), class OpenDialogMBS, Plugin version: 7.5, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Whether folders can be selected.
Example: 
dim o as OpenDialogMBS
dim i,c as integer
dim f as FolderItem

o=new OpenDialogMBS
o.ShowHiddenFiles=true
o.PromptText="Select one or more files/folders:"
o.MultipleSelection=true
o.ActionButtonLabel="Open files/folders"
o.CancelButtonLabel="no, thanks."
o.WindowTitle="This is a window title."
o.ClientName="Client Name?"
o.AllowFolderSelection=true
o.ShowDialog

c=o.FileCount
if c>0 then
  for i=0 to c-1
    f=o.Files(i)
    
    FileList.List.AddRow f.AbsolutePath
  next
end if
Notes:
Default is false.
Setting this to true on Windows or Linux has no effect there.
(Read and Write property)
OpenDialogMBS.CancelButtonLabel as String
property, Navigation, MBS Util Plugin (OpenDialog), class OpenDialogMBS, Plugin version: 4.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The text for the cancel button.
Notes:
Used only on Mac OS.
For RB 4.5 and earlier you need to make sure the encoding is set correctly.
Can be set to "" to use the default value.
(Read and Write property)
class OpenDialogMBS
class, Navigation, MBS Util Plugin (OpenDialog), class OpenDialogMBS, Plugin version: 4.2, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: A class for a multiple selection open dialog.
Example: 
dim o as OpenDialogMBS
dim i,c as integer
dim f as FolderItem

o=new OpenDialogMBS
o.ShowHiddenFiles=true
o.PromptText="Select one or more files:"
o.MultipleSelection=true
o.ActionButtonLabel="Open files"
o.CancelButtonLabel="no, thanks."
o.WindowTitle="This is a window title."
o.ClientName="Client Name?"
o.ShowDialog

c=o.FileCount
if c>0 then
  for i=0 to c-1
    f=o.Files(i)
    
    FileList.List.AddRow f.AbsolutePath
  next
  
else
  // MsgBox "no file was selected."
  quit
end if
OpenDialogMBS.ClearTypes
method, Navigation, MBS Util Plugin (OpenDialog), class OpenDialogMBS, Plugin version: 4.2, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Clears the file type list.
OpenDialogMBS.ClientName as String
property, Navigation, MBS Util Plugin (OpenDialog), class OpenDialogMBS, Plugin version: 4.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The name of the client.
Notes:
Used only on Mac OS.
For RB 4.5 and earlier you need to make sure the encoding is set correctly.
Can be set to "" to use the default value.
(Read and Write property)
OpenDialogMBS.CountTypes as integer
method, Navigation, MBS Util Plugin (OpenDialog), class OpenDialogMBS, Plugin version: 4.2, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Returns the number of file types in the file type list.
OpenDialogMBS.Creator as String
property, Navigation, MBS Util Plugin (OpenDialog), class OpenDialogMBS, Plugin version: 4.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The creator code of your application.
Notes:
This property is only used Mac OS if you specify one or more file types.
(Read and Write property)
OpenDialogMBS.File as Folderitem
property, Navigation, MBS Util Plugin (OpenDialog), class OpenDialogMBS, Plugin version: 4.2, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: The first file selected.
Notes:
file = files(0)
Just for the cases where you only need the first file.
(Read only property)
OpenDialogMBS.FileCount as Integer
property, Navigation, MBS Util Plugin (OpenDialog), class OpenDialogMBS, Plugin version: 4.2, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: The number of files selected.
Notes: (Read only property)
OpenDialogMBS.Files(index as integer) as folderitem
method, Navigation, MBS Util Plugin (OpenDialog), class OpenDialogMBS, Plugin version: 4.2, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: The array with the selected files.
Notes: Index goes from 0 to filecount-1.
OpenDialogMBS.FilterItem(file as folderitem, filterMode as integer) as boolean
event, Navigation, MBS Util Plugin (OpenDialog), class OpenDialogMBS, Plugin version: 4.2, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: An event where you can filter the file list.
Notes:
Return true to disable the file.
The result of the event is ignored by Windows. But on Mac OS it works.
So use the event on Mac and the filetype objects on Windows.
OpenDialogMBS.GetType(index as integer) as OpenDialogFileTypeMBS
method, Navigation, MBS Util Plugin (OpenDialog), class OpenDialogMBS, Plugin version: 4.2, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Returns the file type with the given index.
Notes: Returns nil on any error.
OpenDialogMBS.InitialDirectory as Folderitem
property, Navigation, MBS Util Plugin (OpenDialog), class OpenDialogMBS, Plugin version: 4.2, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The initial directory.
Notes:
Set to nil to get the last directory used.
(Read and Write property)
OpenDialogMBS.Lasterror as Integer
property, Navigation, MBS Util Plugin (OpenDialog), class OpenDialogMBS, Plugin version: 4.2, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: The last error code reported.
Notes: (Read and Write property)
OpenDialogMBS.Left as Integer
property, Navigation, MBS Util Plugin (OpenDialog), class OpenDialogMBS, Plugin version: 4.2, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: The horizontal position of the dialog.
Notes:
-1 is for the default position.
Used only on the Mac side.
(Read and Write property)
OpenDialogMBS.MultipleSelection as Boolean
property, Navigation, MBS Util Plugin (OpenDialog), class OpenDialogMBS, Plugin version: 4.2, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Whether you want to allow multiple file selection.
Notes: (Read and Write property)
OpenDialogMBS.ParentWindow as Window
property, Navigation, MBS Util Plugin (OpenDialog), class OpenDialogMBS, Plugin version: 6.3, Mac OS X: Does nothing, Windows: Works, Linux x86: Works, Feedback.

Function: The parent window of the dialog.
Notes:
Only implemented for Windows and Linux.
(Read and Write property)
OpenDialogMBS.PromptText as String
property, Navigation, MBS Util Plugin (OpenDialog), class OpenDialogMBS, Plugin version: 4.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The prompt text.
Notes:
For RB 4.5 and earlier you need to make sure the encoding is set correctly.
Can be set to "" to use the default value.
(Read and Write property)
OpenDialogMBS.ShowDialog
method, Navigation, MBS Util Plugin (OpenDialog), class OpenDialogMBS, Plugin version: 4.2, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Shows the dialog.
Notes: Check the FileCount property to see whether something was selected.
OpenDialogMBS.ShowHiddenFiles as Boolean
property, Navigation, MBS Util Plugin (OpenDialog), class OpenDialogMBS, Plugin version: 4.2, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Whether hidden files should be showed.
Notes:
Default is false.
(Read and Write property)
OpenDialogMBS.Top as Integer
property, Navigation, MBS Util Plugin (OpenDialog), class OpenDialogMBS, Plugin version: 4.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The vertical position of the dialog.
Notes:
-1 is for the default position.
Used only on the Mac side.
(Read and Write property)
OpenDialogMBS.WindowTitle as String
property, Navigation, MBS Util Plugin (OpenDialog), class OpenDialogMBS, Plugin version: 4.2, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: The window title to use.
Notes:
For RB 4.5 and earlier you need to make sure the encoding is set correctly.
Can be set to "" to use the default value.
(Read and Write property)

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