NavigationDialogMBS.Accepted
event, Navigation, MBS MacOSX Plugin (NavigationOSX), class NavigationDialogMBS, Plugin version: 5.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The user clicked on the "OK" button.

NavigationDialogMBS.Cancelled
event, Navigation, MBS MacOSX Plugin (NavigationOSX), class NavigationDialogMBS, Plugin version: 5.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The user clicked on the "Cancel" button.

class NavigationDialogMBS
class, Navigation, MBS MacOSX Plugin (NavigationOSX), class NavigationDialogMBS, Plugin version: 3.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: A class for a Carbon Navigation dialog.
Example:

// A very bad example:

dim n as NavigationDialogMBS

n=new NavigationDialogMBS
n.CreateChooseObjectDialog
n.ShowDialog

MsgBox n.Result.Selection.AbsolutePath

Notes: If you are using this dialog for sheets, keep a reference on the dialog object so it is not destroyed by RB before the dialog closes.

NavigationDialogMBS.close
method, Navigation, MBS MacOSX Plugin (NavigationOSX), class NavigationDialogMBS, Plugin version: 3.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The destructor.
Notes:
There is no need to call this method except you want to free all resources of this object now without waiting for Realbasic to do it for you.
(e.g. some Realbasic versions crash on Windows if there are plugin objects not closed.)

NavigationDialogMBS.Closed
event, Navigation, MBS MacOSX Plugin (NavigationOSX), class NavigationDialogMBS, Plugin version: 5.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The dialog was closed.

NavigationDialogMBS.CreateAskDiscardChangesDialog
method, Navigation, MBS MacOSX Plugin (NavigationOSX), class NavigationDialogMBS, Plugin version: 3.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Creates a dialog box.
Notes: Lasterror is set.

NavigationDialogMBS.CreateAskReviewDocumentsDialog(DocumentCount as integer)
method, Navigation, MBS MacOSX Plugin (NavigationOSX), class NavigationDialogMBS, Plugin version: 3.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Creates a dialog.
Notes:
Lasterror is set.
DocumentCount is the number of documents. The text in the dialog will be adjusted for the given number of documents.

NavigationDialogMBS.CreateAskSaveChangesDialog(QuittingApplication as boolean)
method, Navigation, MBS MacOSX Plugin (NavigationOSX), class NavigationDialogMBS, Plugin version: 3.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Creates a dialog box.
Notes:
Lasterror is set.
Set QuittingApplication to true if the dialog text should be adjusted.

NavigationDialogMBS.CreateChooseFileDialog(typelist as NavigationTypeListMBS)
method, Navigation, MBS MacOSX Plugin (NavigationOSX), class NavigationDialogMBS, Plugin version: 3.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Creates a choose file dialog.
Notes:
Lasterror is set.
Typelist can be used to filter the showed files in the dialog.

NavigationDialogMBS.CreateChooseFolderDialog
method, Navigation, MBS MacOSX Plugin (NavigationOSX), class NavigationDialogMBS, Plugin version: 3.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Creates a choose folder dialog.
Notes: Lasterror is set.

NavigationDialogMBS.CreateChooseObjectDialog
method, Navigation, MBS MacOSX Plugin (NavigationOSX), class NavigationDialogMBS, Plugin version: 3.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Creates a choose object dialog.
Example:

dim n as NavigationDialogMBS

n=new NavigationDialogMBS
n.CreateChooseObjectDialog
n.ShowDialog

MsgBox n.Result.File.AbsolutePath

Notes: Lasterror is set.

NavigationDialogMBS.CreateChooseVolumeDialog
method, Navigation, MBS MacOSX Plugin (NavigationOSX), class NavigationDialogMBS, Plugin version: 3.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Creates a choose volume dialog.
Example:

dim n as NavigationDialogMBS

n=new NavigationDialogMBS
n.CreateChooseVolumeDialog
n.ShowDialog

MsgBox n.Result.File.AbsolutePath

Notes: Lasterror is set.

NavigationDialogMBS.CreateNewFolderDialog
method, Navigation, MBS MacOSX Plugin (NavigationOSX), class NavigationDialogMBS, Plugin version: 3.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Creates a choose new folder dialog.
Notes: Lasterror is set.

NavigationDialogMBS.CreateOpenFileDialog(typelist as NavigationTypeListMBS)
method, Navigation, MBS MacOSX Plugin (NavigationOSX), class NavigationDialogMBS, Plugin version: 3.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Creates an open file dialog box.
Notes:
Lasterror is set.
Typelist can be used to filter the showed files in the dialog.

NavigationDialogMBS.CreateSaveFileDialog(FileType as string, FileCreator as string)
method, Navigation, MBS MacOSX Plugin (NavigationOSX), class NavigationDialogMBS, Plugin version: 3.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Creates an save file dialog box.
Notes:
Lasterror is set.
Typelist can be used to filter the showed files in the dialog.

NavigationDialogMBS.DialogHandle as Integer
property, Navigation, MBS MacOSX Plugin (NavigationOSX), class NavigationDialogMBS, Plugin version: 3.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The internal used handle to the dialog.
Notes: (Read and Write property)

NavigationDialogMBS.FileExtensionHidden as Boolean
property, Navigation, MBS MacOSX Plugin (NavigationOSX), class NavigationDialogMBS, Plugin version: 3.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Whether the file extension is to be hidden.
Notes:
Can only be set after the dialog was created.
Lasterror is set.
(Read and Write property)

NavigationDialogMBS.FileName as String
property, Navigation, MBS MacOSX Plugin (NavigationOSX), class NavigationDialogMBS, Plugin version: 3.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The filename used in a save dialog.
Notes:
Can only be set after the dialog was created.
Lasterror is set.
(Read and Write property)

NavigationDialogMBS.FilterItem(file as folderitem, filterMode as integer) as boolean
event, Navigation, MBS MacOSX Plugin (NavigationOSX), class NavigationDialogMBS, Plugin version: 4.1, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Called whenever a file is about to be displayed and you need to decide whether it should be enabled.
Notes:
Constants for which elements are being filtered for objects:

kNavFilteringBrowserList	0
kNavFilteringFavorites	1
kNavFilteringRecents	2
kNavFilteringShortCutVolumes	3
kNavFilteringLocationPopup	4

NavigationDialogMBS.FormatChanged(Selected as NavigationTypeMBS)
event, Navigation, MBS MacOSX Plugin (NavigationOSX), class NavigationDialogMBS, Plugin version: 4.1, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The selection in the extension popup menu changed.
Notes: (Added selected parameter in v5.3)

NavigationDialogMBS.Lasterror as Integer
property, Navigation, MBS MacOSX Plugin (NavigationOSX), class NavigationDialogMBS, Plugin version: 3.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The last error code reported.
Notes:
0 for success, -1 for parameter error or low memory.
Else a Mac OS error code.
(Read and Write property)

NavigationDialogMBS.Opened
event, Navigation, MBS MacOSX Plugin (NavigationOSX), class NavigationDialogMBS, Plugin version: 5.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The dialog was opened.

NavigationDialogMBS.Options as NavigationDialogOptionsMBS
property, Navigation, MBS MacOSX Plugin (NavigationOSX), class NavigationDialogMBS, Plugin version: 3.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The Options to use in the Create methods.
Notes:
Can only be set before the dialog was created.
(Read and Write property)

NavigationDialogMBS.PopupMenuSelection as NavigationTypeMBS
property, Navigation, MBS MacOSX Plugin (NavigationOSX), class NavigationDialogMBS, Plugin version: 4.1, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The selection from the extension popup menu.
Notes:
Value is nil for default type or points to the selected type.
(Changed from Integer to NavigationTypeMBS in v5.3)
(Read and Write property)

NavigationDialogMBS.Result as NavigationDialogResultMBS
method, Navigation, MBS MacOSX Plugin (NavigationOSX), class NavigationDialogMBS, Plugin version: 3.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The result of the dialog.
Example:

dim n as NavigationDialogMBS

n=new NavigationDialogMBS
n.CreateChooseObjectDialog
n.ShowDialog

MsgBox n.Result.File.AbsolutePath

Notes:
Only available after the user has choosen something.
Lasterror is set.
If you read this property, a new result object is created, so cache it in a local variable if you use it more than once.

NavigationDialogMBS.ShowAskDiscardChangesDialog as integer
method, Navigation, MBS MacOSX Plugin (NavigationOSX), class NavigationDialogMBS, Plugin version: 4.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Creates and shows a dialog box.
Notes:
Lasterror is set.

constants for the result on Mac OS 9:

kNavAskDiscardChanges	= 1
kNavAskDiscardChangesCancel	= 2

On Carbon, use the UserAction property to find the result.

NavigationDialogMBS.ShowAskSaveChangesDialog(QuittingApplication as boolean) as integer
method, Navigation, MBS MacOSX Plugin (NavigationOSX), class NavigationDialogMBS, Plugin version: 4.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Creates and shows a dialog box.
Notes:
Lasterror is set.
Set QuittingApplication to true if the dialog text should be adjusted.

constants for the result on Mac OS 9:

kNavAskSaveChangesSave	= 1
kNavAskSaveChangesCancel	= 2
kNavAskSaveChangesDontSave	= 3

On Carbon, use the UserAction property to find the result.

NavigationDialogMBS.ShowChooseFileDialog(typelist as NavigationTypeListMBS)
method, Navigation, MBS MacOSX Plugin (NavigationOSX), class NavigationDialogMBS, Plugin version: 4.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Creates and shows a choose file dialog.
Notes:
Lasterror is set.
Typelist can be used to filter the showed files in the dialog.

NavigationDialogMBS.ShowChooseFolderDialog
method, Navigation, MBS MacOSX Plugin (NavigationOSX), class NavigationDialogMBS, Plugin version: 4.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Creates and shows a choose folder dialog.
Notes: Lasterror is set.

NavigationDialogMBS.ShowChooseObjectDialog
method, Navigation, MBS MacOSX Plugin (NavigationOSX), class NavigationDialogMBS, Plugin version: 4.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Creates and shows a choose object dialog.
Example:

dim n as NavigationDialogMBS

n=new NavigationDialogMBS
n.CreateChooseObjectDialog
n.ShowDialog

MsgBox n.Result.File.AbsolutePath

Notes: Lasterror is set.

NavigationDialogMBS.ShowChooseVolumeDialog
method, Navigation, MBS MacOSX Plugin (NavigationOSX), class NavigationDialogMBS, Plugin version: 4.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Creates and shows a choose volume dialog.
Example:

dim n as NavigationDialogMBS

n=new NavigationDialogMBS
n.ShowChooseVolumeDialog

MsgBox n.Result.File.AbsolutePath

Notes: Lasterror is set.

NavigationDialogMBS.ShowDialog
method, Navigation, MBS MacOSX Plugin (NavigationOSX), class NavigationDialogMBS, Plugin version: 3.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Shows the dialog.
Example:

dim n as NavigationDialogMBS

n=new NavigationDialogMBS
n.CreateChooseObjectDialog
n.ShowDialog

MsgBox n.Result.File.AbsolutePath

Notes: Lasterror is set.

NavigationDialogMBS.ShowNewFolderDialog
method, Navigation, MBS MacOSX Plugin (NavigationOSX), class NavigationDialogMBS, Plugin version: 4.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Creates and shows a choose new folder dialog.
Notes: Lasterror is set.

NavigationDialogMBS.ShowOpenFileDialog(typelist as NavigationTypeListMBS)
method, Navigation, MBS MacOSX Plugin (NavigationOSX), class NavigationDialogMBS, Plugin version: 4.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Creates and shows an open file dialog box.
Notes:
Lasterror is set.
Typelist can be used to filter the showed files in the dialog.

NavigationDialogMBS.ShowSaveFileDialog(FileType as string, FileCreator as string)
method, Navigation, MBS MacOSX Plugin (NavigationOSX), class NavigationDialogMBS, Plugin version: 4.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Creates and shows an save file dialog box.
Notes:
Lasterror is set.
Typelist can be used to filter the showed files in the dialog.

NavigationDialogMBS.StartLocation as Folderitem
property, Navigation, MBS MacOSX Plugin (NavigationOSX), class NavigationDialogMBS, Plugin version: 4.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The start location for a dialog.
Notes:
Used in the SaveFileDialog, NewFolderDialog, ChooseObjectDialog, ChooseVolumeDialog, ChooseFolderDialog and ChooseFileDialog.
(Read and Write property)

NavigationDialogMBS.UserAction as Integer
property, Navigation, MBS MacOSX Plugin (NavigationOSX), class NavigationDialogMBS, Plugin version: 3.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Return the current user action taken by the user.
Notes:
A user action occurs when the user dismisses the dialog or otherwise does something generating a reply record that the client needs to act upon. If the user has not taken such an action, NavDialogGetUserAction returns kNavUserActionNone. If the dialog is terminated using the NavCustomControl selector kNavCtlTerminate, the final user action is kNavUserActionNone.
For file dialogs, if the final user action is not kNavUserActionCancel, then there is a valid reply record which can be obtained with NavDialogGetReply. Although the user action is sent to the client event proc as a kNavCBUserAction event, this function is provided as a convenience for clients of modal dialogs who may find it easier to get the user action immediately after NavDialogRun returns.
(Read only property)

NavigationDialogMBS.WindowHandle as Integer
property, Navigation, MBS MacOSX Plugin (NavigationOSX), class NavigationDialogMBS, Plugin version: 3.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The internal used handle to the dialog's window.
Notes:
Returns 0 on any error.
(Read only property)