Platforms to show: All Mac Windows Linux Cross-Platform

NSSavePanelMBS class

Super class: NSPanelMBS

dim n as new NSSavePanelMBS

dim e as integer = n.runModal

if e = n.NSCancelButton then
  // cancelled
  Break
elseif e = n.NSOKButton then
  // got file
  dim file as FolderItem = n.file
  Break
end if

• 8 events
  • event compareFilename(name1 as string, name2 as string, caseSensitive as boolean) as Integer
  • event directoryDidChange(path as string, folder as folderitem)
  • event isValidFilename(path as string, item as folderitem) as boolean
  • event panelSelectionDidChange
  • event savePanelDidEnd(ReturnCode as Integer)
  • event shouldShowFilename(path as string, item as folderitem) as boolean
  • event userEnteredFilename(filename as string, confirmed as boolean) as string
  • event willExpand(expanding as boolean)
• 17 properties
  • property accessoryView as NSViewMBS
  • property allowsOtherFileTypes as boolean
  • property canCreateDirectories as boolean
  • property canSelectHiddenExtension as boolean
  • property Directory as folderitem
  • property directoryURL as string
  • property isExpanded as boolean
  • property isExtensionHidden as boolean
  • property Message as string
  • property NameFieldLabel as string
  • property nameFieldStringValue as string
  • property Prompt as string
  • property requiredFileType as string
  • property showsHiddenFiles as boolean
  • property showsTagField as Boolean
  • property Title as string
  • property treatsFilePackagesAsDirectories as boolean
• 15 methods
  • method allowedFileTypes as string()
  • method beginSheetForDirectory(path as folderitem, name as string, targetWindow as DesktopWindow)
  • method beginSheetForDirectory(path as folderitem, name as string, targetWindow as window)
  • method Cancel
  • method Constructor
  • method File as folderitem
  • method HideNSNavNodePopUpButton
  • method Ok
  • method runModal as Integer
  • method runModalForDirectory(path as folderitem, name as string) as Integer
  • method setAllowedFileTypes(filetype as string)
  • method setAllowedFileTypes(filetypes() as string)
  • method setTagNames(tagNames() as string)
  • method tagNames as string()
  • method validateVisibleColumns
• shared method FileTypeForHFSType(hfstype as string) as string
• 2 constants
  • const NSCancelButton = 0
  • const NSOKButton = 1

Super class NSPanelMBS

• 3 properties
  • property becomesKeyOnlyIfNeeded as boolean
  • property isFloatingPanel as boolean
  • property worksWhenModal as boolean
• method Constructor(x as Double, y as Double, w as Double, h as Double, styleMask as Integer, BackingStoreType as Integer, deferCreation as boolean)
• 12 shared methods
  • shared method RunAlertPanel(title as string, message as string, defaultButton as string, alternateButton as string, otherButton as string) as Integer
  • shared method RunAlertPanelRelativeToWindow(title as string, message as string, defaultButton as string, alternateButton as string, otherButton as string, docWindow as DesktopWindow) as integer
  • shared method RunAlertPanelRelativeToWindow(title as string, message as string, defaultButton as string, alternateButton as string, otherButton as string, docWindow as NSWindowMBS) as Integer
  • shared method RunAlertPanelRelativeToWindow(title as string, message as string, defaultButton as string, alternateButton as string, otherButton as string, docWindow as window) as Integer
  • shared method RunCriticalAlertPanel(title as string, message as string, defaultButton as string, alternateButton as string, otherButton as string) as Integer
  • shared method RunCriticalAlertPanelRelativeToWindow(title as string, message as string, defaultButton as string, alternateButton as string, otherButton as string, docWindow as DesktopWindow) as integer
  • shared method RunCriticalAlertPanelRelativeToWindow(title as string, message as string, defaultButton as string, alternateButton as string, otherButton as string, docWindow as NSWindowMBS) as Integer
  • shared method RunCriticalAlertPanelRelativeToWindow(title as string, message as string, defaultButton as string, alternateButton as string, otherButton as string, docWindow as window) as Integer
  • shared method RunInformationalAlertPanel(title as string, message as string, defaultButton as string, alternateButton as string, otherButton as string) as Integer
  • shared method RunInformationalAlertPanelRelativeToWindow(title as string, message as string, defaultButton as string, alternateButton as string, otherButton as string, docWindow as DesktopWindow) as integer
  • shared method RunInformationalAlertPanelRelativeToWindow(title as string, message as string, defaultButton as string, alternateButton as string, otherButton as string, docWindow as NSWindowMBS) as Integer
  • shared method RunInformationalAlertPanelRelativeToWindow(title as string, message as string, defaultButton as string, alternateButton as string, otherButton as string, docWindow as window) as Integer
• 10 constants
  • const NSAlertAlternateReturn=0
  • const NSAlertDefaultReturn=1
  • const NSAlertErrorReturn=-2
  • const NSAlertOtherReturn=-1
  • const NSCancelButton=0
  • const NSDocModalWindowMask=64
  • const NSHUDWindowMask=8192
  • const NSNonactivatingPanelMask=128
  • const NSOKButton=1
  • const NSUtilityWindowMask=16

Super class NSWindowMBS

• 88 properties
  • property acceptsMouseMovedEvents as boolean
  • property allowsConcurrentViewDrawing as boolean
  • property allowsToolTipsWhenApplicationIsInactive as boolean
  • property alphaValue as Double
  • property animationBehavior as Integer
  • property aspectRatio as NSSizeMBS
  • property Autodisplay as boolean
  • property backgroundColor as NSColorMBS
  • property backingLocation as Integer
  • property backingScaleFactor as Double
  • property backingType as Integer
  • property canBecomeKeyWindow as boolean
  • property canBecomeMainWindow as boolean
  • property canBecomeVisibleWithoutLogin as boolean
  • property canHide as boolean
  • property canStoreColor as boolean
  • property className as string
  • property classPath as string
  • property collectionBehavior as Integer
  • property colorSpace as NSColorSpaceMBS
  • property contentAspectRatio as NSSizeMBS
  • property contentLayoutRect as NSRectMBS
  • property contentMaxSize as NSSizeMBS
  • property contentMinSize as NSSizeMBS
  • property contentResizeIncrements as NSSizeMBS
  • property contentView as NSViewMBS
  • property currentEvent as NSEventMBS
  • property deepestScreen as NSScreenMBS
  • property depthLimit as Integer
  • property displaysWhenScreenProfileChanges as boolean
  • property frame as NSRectMBS
  • property hasDynamicDepthLimit as boolean
  • property hasShadow as boolean
  • Property Height as Double
  • property hidesOnDeactivate as boolean
  • property identifier as string
  • property ignoresMouseEvents as boolean
  • property initialFirstResponder as NSViewMBS
  • property isDocumentEdited as boolean
  • property isExcludedFromWindowsMenu as boolean
  • property isFlushWindowDisabled as boolean
  • property isKeyWindow as boolean
  • property isMainWindow as boolean
  • property isMiniaturized as boolean
  • property isMovableByWindowBackground as boolean
  • property isOnActiveSpace as boolean
  • property isOneShot as boolean
  • property isOpaque as boolean
  • property isSheet as boolean
  • property isZoomed as boolean
  • Property Left as Double
  • property Level as Integer
  • property maxSize as NSSizeMBS
  • property miniwindowImage as Variant
  • property miniwindowTitle as String
  • property minSize as NSSizeMBS
  • property Movable as boolean
  • property parentWindow as NSWindowMBS
  • property preferredBackingLocation as Integer
  • property preservesContentDuringLiveResize as boolean
  • property preventsApplicationTerminationWhenModal as boolean
  • property representedFile as folderitem
  • property representedFilename as string
  • property representedURL as string
  • property resizeIncrements as NSSizeMBS
  • property Restorable as boolean
  • property screen as NSScreenMBS
  • property sharingType as Integer
  • property showsResizeIndicator as boolean
  • property showsToolbarButton as boolean
  • property styleMask as Integer
  • property SubTitle as String
  • property tabbingIdentifier as String
  • property tabbingMode as Integer
  • property Title as String
  • property titlebarAppearsTransparent as Boolean
  • property titlebarSeparatorStyle as Integer
  • property titleVisibility as Integer
  • property toolbar as Variant
  • property toolbarStyle as Integer
  • Property Top as Double
  • property viewsNeedDisplay as boolean
  • property Visible as boolean
  • Property Width as Double
  • property windowController as NSWindowControllerMBS
  • property windowNumber as Integer
  • property worksWhenModal as boolean
  • property frameAutosaveName as string
• 2 shared properties
  • shared property allowsAutomaticWindowTabbing as Boolean
  • shared property userTabbingPreference as Integer
• 114 methods
  • method addChildWindow(win as DesktopWindow, order as integer)
  • method addChildWindow(win as NSWindowMBS, order as Integer)
  • method addChildWindow(win as window, order as Integer)
  • method addTabbedWindow(win as NSWindowMBS, ordered as Integer)
  • method animator as NSWindowMBS
  • method areCursorRectsEnabled as boolean
  • method attachedSheet as NSWindowMBS
  • method autorecalculatesContentBorderThicknessForEdge(edge as Integer) as boolean
  • method becomeKeyWindow
  • method becomeMainWindow
  • method cacheImageInRect(r as NSRectMBS)
  • method Center
  • method childWindows as NSWindowMBS()
  • method ClearFocus
  • method Close
  • method Constructor(w as DesktopWindow)
  • method Constructor(w as window)
  • method Constructor(x as Double, y as Double, w as Double, h as Double, styleMask as Integer, BackingStoreType as Integer = 0, deferCreation as boolean = false, canBecomeKeyWindow as boolean = false)
  • method contentBorderThicknessForEdge(edge as Integer) as Double
  • method contentRectForFrameRect(windowFrame as NSRectMBS) as NSRectMBS
  • method convertBaseToScreen(p as NSPointMBS) as NSPointMBS
  • method convertScreenToBase(p as NSPointMBS) as NSPointMBS
  • method dataWithEPSInsideRect(r as NSRectMBS) as Memoryblock
  • method dataWithPDFInsideRect(r as NSRectMBS) as Memoryblock
  • method deminiaturize
  • method disableCursorRects
  • method disableFlushWindow
  • method disableScreenUpdatesUntilFlush
  • method disableSnapshotRestoration
  • method discardCachedImage
  • method discardCursorRects
  • method display
  • method displayIfNeeded
  • method dockTile as Variant
  • method dragImage(image as NSImageMBS, viewLocation as NSPointMBS, offset as NSSizeMBS, NSEvent as NSEventMBS, pboard as NSPasteboardMBS, source as NSViewMBS, slideFlag as boolean)
  • method enableCursorRects
  • method enableFlushWindow
  • method enableSnapshotRestoration
  • method endEditingFor(anObject as object = nil)
  • method fieldEditor(createFlag as boolean = True, forObject as object = nil) as Variant
  • method firstResponder as NSResponderMBS
  • method flushWindow
  • method flushWindowIfNeeded
  • method frameRectForContentRect(windowContent as NSRectMBS) as NSRectMBS
  • method GetFrame(byref left as Double, byref top as Double, byref width as Double, byref height as Double)
  • method gState as Integer
  • method Hide
  • method inLiveResize as boolean
  • method invalidateCursorRectsForView(View as NSViewMBS)
  • method invalidateRestorableState
  • method invalidateShadow
  • method keyDown(e as NSEventMBS)
  • method makeFirstResponder(r as NSResponderMBS) as boolean
  • method makeKeyAndOrderFront
  • method makeKeyWindow
  • method makeMainWindow
  • method mergeAllWindows
  • method miniaturize
  • method moveTabToNewWindow
  • method orderBack
  • method orderFront
  • method orderFrontRegardless
  • method orderOut
  • method PerformClose
  • method performMiniaturize
  • method performWindowDragWithEvent(event as NSEventMBS)
  • method performZoom
  • method print
  • method registerForDraggedTypes(Types() as string)
  • method removeChildWindow(win as NSWindowMBS)
  • method removeChildWindow(win as window)
  • method resetCursorRects
  • method resignKeyWindow
  • method resignMainWindow
  • method resizeFlags as Integer
  • method restoreCachedImage
  • method runToolbarCustomizationPalette
  • method saveFrameUsingName(s as String)
  • method selectKeyViewFollowingView(view as NSViewMBS)
  • method selectKeyViewPrecedingView(view as NSViewMBS)
  • method selectNextKeyView
  • method selectNextTab
  • method selectPreviousKeyView
  • method selectPreviousTab
  • method sendEvent(e as NSEventMBS)
  • method setAutorecalculatesContentBorderThickness(flag as boolean, edge as Integer)
  • method setBottomCornerRounded(flag as boolean)
  • method setContentBorderThickness(thickness as Double, edge as Integer)
  • method setContentSize(size as NSSizeMBS)
  • method setFrame(frameRect as NSRectMBS)
  • method setFrame(frameRect as NSRectMBS, display as boolean)
  • method setFrame(frameRect as NSRectMBS, display as boolean, animated as boolean)
  • method SetFrame(left as Double, top as Double, width as Double, height as Double)
  • method setFrameAutosaveName(name as String) as boolean
  • method setFrameFromString(s as String)
  • method setFrameOrigin(point as NSPointMBS)
  • method setFrameTopLeftPoint(point as NSPointMBS)
  • method setFrameUsingName(name as String, force as boolean = false) as boolean
  • method setRestorationClass
  • method setTitleWithRepresentedFile(filename as folderitem)
  • method setTitleWithRepresentedFilename(filename as string)
  • method Show
  • method standardWindowButton(button as Integer) as Variant
  • method stringWithSavedFrame as String
  • method tabbedWindows as NSWindowMBS()
  • method toggleFullScreen
  • method toggleTabBar
  • method toggleToolbarShown
  • method toolbarview as NSViewMBS
  • method unregisterDraggedTypes
  • method update
  • method useOptimizedDrawing(value as boolean)
  • method WindowHandle as Integer
  • method zoom
• 44 shared methods
  • shared method contentRectForFrameRect(windowFrame as NSRectMBS, styleMask as UInt32) as NSRectMBS
  • shared method frameRectForContentRect(windowContentRect as NSRectMBS, styleMask as UInt32) as NSRectMBS
  • shared method minFrameWidthWithTitle(WindowTitle as string, styleMask as UInt32) as Double
  • shared method NSDockWindowLevel as Integer
  • shared method NSFloatingWindowLevel as Integer
  • shared method NSMainMenuWindowLevel as Integer
  • shared method NSModalPanelWindowLevel as Integer
  • shared method NSNormalWindowLevel as Integer
  • shared method NSPopUpMenuWindowLevel as Integer
  • shared method NSScreenSaverWindowLevel as Integer
  • shared method NSStatusWindowLevel as Integer
  • shared method NSSubmenuWindowLevel as Integer
  • shared method NSTornOffMenuWindowLevel as Integer
  • shared method NSWindowDidBecomeKeyNotification as string
  • shared method NSWindowDidBecomeMainNotification as string
  • shared method NSWindowDidChangeScreenNotification as string
  • shared method NSWindowDidChangeScreenProfileNotification as string
  • shared method NSWindowDidDeminiaturizeNotification as string
  • shared method NSWindowDidEndLiveResizeNotification as string
  • shared method NSWindowDidEndSheetNotification as string
  • shared method NSWindowDidEnterFullScreenNotification as string
  • shared method NSWindowDidEnterVersionBrowserNotification as string
  • shared method NSWindowDidExitFullScreenNotification as string
  • shared method NSWindowDidExitVersionBrowserNotification as string
  • shared method NSWindowDidExposeNotification as string
  • shared method NSWindowDidMiniaturizeNotification as string
  • shared method NSWindowDidMoveNotification as string
  • shared method NSWindowDidResignKeyNotification as string
  • shared method NSWindowDidResignMainNotification as string
  • shared method NSWindowDidResizeNotification as string
  • shared method NSWindowDidUpdateNotification as string
  • shared method NSWindowWillBeginSheetNotification as string
  • shared method NSWindowWillCloseNotification as string
  • shared method NSWindowWillEnterFullScreenNotification as string
  • shared method NSWindowWillEnterVersionBrowserNotification as string
  • shared method NSWindowWillExitFullScreenNotification as string
  • shared method NSWindowWillExitVersionBrowserNotification as string
  • shared method NSWindowWillMiniaturizeNotification as string
  • shared method NSWindowWillMoveNotification as string
  • shared method NSWindowWillStartLiveResizeNotification as string
  • shared method removeFrameUsingName(name as string)
  • shared method standardWindowButton(button as Integer, StyleMask as Integer) as Variant
  • shared method windowNumberAtPoint(x as Double, y as Double, belowWindowWithWindowNumber as Integer = 0) as Integer
  • shared method windowNumbersWithOptions(options as Integer = 0) as Integer()
• 68 constants

Super class NSResponderMBS

• 3 properties
  • property Handle as Integer
  • property menu as NSMenuMBS
  • property nextResponder as NSResponderMBS
• 123 methods
  • method beginGestureWithEvent(e as NSEventMBS)
  • method cancelOperation
  • method capitalizeWord
  • method centerSelectionInVisibleArea
  • method changeCaseOfLetter
  • method complete
  • method Constructor   Private
  • method cursorUpdate(e as NSEventMBS)
  • method deleteBackward
  • method deleteBackwardByDecomposingPreviousCharacter
  • method deleteForward
  • method deleteToBeginningOfLine
  • method deleteToBeginningOfParagraph
  • method deleteToEndOfLine
  • method deleteToEndOfParagraph
  • method deleteToMark
  • method deleteWordBackward
  • method deleteWordForward
  • method endGestureWithEvent(e as NSEventMBS)
  • method flagsChanged(e as NSEventMBS)
  • method flushBufferedKeyEvents
  • method helpRequested(e as NSEventMBS)
  • method indent
  • method insertBacktab
  • method insertContainerBreak
  • method insertDoubleQuoteIgnoringSubstitution
  • method insertLineBreak
  • method insertNewline
  • method insertNewlineIgnoringFieldEditor
  • method insertParagraphSeparator
  • method insertSingleQuoteIgnoringSubstitution
  • method insertTab
  • method insertTabIgnoringFieldEditor
  • method keyDown(e as NSEventMBS)
  • method keyUp(e as NSEventMBS)
  • method lowercaseWord
  • method magnifyWithEvent(e as NSEventMBS)
  • method makeBaseWritingDirectionLeftToRight
  • method makeBaseWritingDirectionNatural
  • method makeBaseWritingDirectionRightToLeft
  • method makeTextWritingDirectionLeftToRight
  • method makeTextWritingDirectionNatural
  • method makeTextWritingDirectionRightToLeft
  • method mouseDown(e as NSEventMBS)
  • method mouseDragged(e as NSEventMBS)
  • method mouseEntered(e as NSEventMBS)
  • method mouseExited(e as NSEventMBS)
  • method mouseMoved(e as NSEventMBS)
  • method mouseUp(e as NSEventMBS)
  • method moveBackward
  • method moveBackwardAndModifySelection
  • method moveDown
  • method moveDownAndModifySelection
  • method moveForward
  • method moveForwardAndModifySelection
  • method moveLeft
  • method moveLeftAndModifySelection
  • method moveParagraphBackwardAndModifySelection
  • method moveParagraphForwardAndModifySelection
  • method moveRight
  • method moveRightAndModifySelection
  • method moveToBeginningOfDocument
  • method moveToBeginningOfDocumentAndModifySelection
  • method moveToBeginningOfLine
  • method moveToBeginningOfLineAndModifySelection
  • method moveToBeginningOfParagraph
  • method moveToBeginningOfParagraphAndModifySelection
  • method moveToEndOfDocument
  • method moveToEndOfDocumentAndModifySelection
  • method moveToEndOfLine
  • method moveToEndOfLineAndModifySelection
  • method moveToEndOfParagraph
  • method moveToEndOfParagraphAndModifySelection
  • method moveToLeftEndOfLine
  • method moveToLeftEndOfLineAndModifySelection
  • method moveToRightEndOfLine
  • method moveToRightEndOfLineAndModifySelection
  • method moveUp
  • method moveUpAndModifySelection
  • method moveWordBackward
  • method moveWordBackwardAndModifySelection
  • method moveWordForward
  • method moveWordForwardAndModifySelection
  • method moveWordLeft
  • method moveWordLeftAndModifySelection
  • method moveWordRight
  • method moveWordRightAndModifySelection
  • method otherMouseDown(e as NSEventMBS)
  • method otherMouseDragged(e as NSEventMBS)
  • method otherMouseUp(e as NSEventMBS)
  • method pageDown
  • method pageDownAndModifySelection
  • method pageUp
  • method pageUpAndModifySelection
  • method performMnemonic(theString as string) as boolean
  • method presentError(e as NSErrorMBS) as boolean
  • method rightMouseDown(e as NSEventMBS)
  • method rightMouseDragged(e as NSEventMBS)
  • method rightMouseUp(e as NSEventMBS)
  • method rotateWithEvent(e as NSEventMBS)
  • method scrollLineDown
  • method scrollLineUp
  • method scrollPageDown
  • method scrollPageUp
  • method scrollToBeginningOfDocument
  • method scrollToEndOfDocument
  • method scrollWheel(e as NSEventMBS)
  • method selectAll
  • method selectLine
  • method selectParagraph
  • method selectToMark
  • method selectWord
  • method setMark
  • method showContextHelp
  • method swapWithMark
  • method swipeWithEvent(e as NSEventMBS)
  • method tabletPoint(e as NSEventMBS)
  • method tabletProximity(e as NSEventMBS)
  • method transpose
  • method transposeWords
  • method undoManager as NSUndoManagerMBS
  • method uppercaseWord
  • method yank

Sub classes:

• class NSOpenPanelMBS

Some events using this class:

• NSSavePanelObserverMBS.DidShowPanel(panel as NSSavePanelMBS, Result as Integer)
• NSSavePanelObserverMBS.WillShowPanel(panel as NSSavePanelMBS)

Some examples using this class:

• /MacCocoa/NSSavePanel
• /MacCocoa/NSSavePanelObserver

Blog Entries

• News from the MBS Xojo Plugins in Version 23.0
• MBS Xojo Plugins, version 22.6pr3
• MBS Xojo Plugins, version 20.1pr5
• Customized File Open and Save Dialogs for Windows
• MBS Xojo Plugins, version 19.4pr1
• MBS Xojo / Real Studio Plugins, version 14.3pr2
• MBS Real Studio Plugins, version 12.5pr8
• Sandboxing
• MBS Plugins 11.1 Release notes
• MonkeyBread Software Releases the MBS Plugins 8.2

Xojo Developer Magazine

• 18.3, page 52: Happy Birthday MonkeyBread Software, What is new in the MBS Xojo Plugins by Stefanie Juchmes

Release notes

• Version 23.0
  • Added showsTagField property to NSSavePanelMBS class.
  • Added tagNames and setTagNames methods to NSSavePanelMBS class.
• Version 20.1
  • Fixed NameFieldStringValue in NSSavePanelMBS to properly set with empty text.
• Version 19.4
  • Fixed title property for NSSavePanelMBS to avoid NSException for empty string.

The items on this page are in the following plugins: MBS MacBase Plugin, MBS MacCocoa Plugin.

NSRunningApplicationMBS   -   NSSavePanelObserverMBS