NSDocument Class

Definition

Namespace:: AppKit

Assembly:: Microsoft.macOS.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

[Foundation.Register("NSDocument", true)]
public class NSDocument : Foundation.NSObject, AppKit.INSEditorRegistration, AppKit.INSMenuItemValidation, AppKit.INSUserActivityRestoring, AppKit.INSUserInterfaceValidations, Foundation.INSFilePresenter, IDisposable

[<Foundation.Register("NSDocument", true)>]
type NSDocument = class
    inherit NSObject
    interface INSEditorRegistration
    interface INativeObject
    interface IDisposable
    interface INSFilePresenter
    interface INSMenuItemValidation
    interface INSUserActivityRestoring
    interface INSUserInterfaceValidations

Inheritance: Object

NSObject
NSDocument

Attributes: RegisterAttribute

Implements: INSEditorRegistration INSMenuItemValidation INSUserActivityRestoring INSUserInterfaceValidations INSFilePresenter INativeObject IDisposable

Constructors

Name	Description
NSDocument()	Creates a new NSDocument with default values.
NSDocument(NativeHandle)	A constructor used when creating managed representations of unmanaged objects. Called by the runtime.
NSDocument(NSObjectFlag)	Constructor to call on derived classes to skip initialization and merely allocate the object.
NSDocument(NSUrl, NSUrl, String, NSError)
NSDocument(NSUrl, String, NSError)
NSDocument(String, NSError)

Properties

Name	Description
AllowsDocumentSharing
AutosavedContentsFileUrl
AutoSavesDrafts
AutosavingFileType
AutosavingIsImplicitlyCancellable
BackupFileUrl
Class	(Inherited from NSObject)
ClassHandle	The Objective-C class handle for this class.
DebugDescription	(Inherited from NSObject)
DefaultDraftName
Description	(Inherited from NSObject)
DisplayName
ExposedBindings	(Inherited from NSObject)
FileModificationDate
FileNameExtensionWasHiddenInLastRunSavePanel
FileType
FileTypeFromLastRunSavePanel
FileUrl
Handle	Handle (pointer) to the unmanaged object representation. (Inherited from NSObject)
HasUnautosavedChanges
HasUndoManager
IsBrowsingVersions
IsDirectBinding	(Inherited from NSObject)
IsDocumentEdited
IsDraft
IsEntireFileLoaded
IsInViewingMode
IsLocked
IsProxy	(Inherited from NSObject)
PDFPrintOperation
PresentedItemObservedUbiquityAttributes	Gets the set of ubiquity attributes that will generate notifications if they are modified.
PresentedItemOperationQueue	Gets the NSOperationQueue on which presenter-related methods are executed.
PresentedItemUrl	Gets URL of presented item.
PreviewRepresentableActivityItems
PrimaryPresentedItemUrl
PrintInfo
ReadableTypes
RetainCount	(Inherited from NSObject)
SavePanelShowsFileFormatsControl
Self	(Inherited from NSObject)
ShouldRunSavePanelWithAccessoryView
Superclass	(Inherited from NSObject)
SuperHandle	Handle used to represent the methods in the base class for this NSObject. (Inherited from NSObject)
UndoManager
UserActivity
UsesUbiquitousStorage
WindowControllers
WindowForSheet
WindowNibName
Zone	(Inherited from NSObject)

Methods

Name	Description
AccommodatePresentedItemDeletion(Action<NSError>)
AccommodatePresentedItemEviction(Action<NSError>)
AccommodatePresentedSubitemDeletion(NSUrl, Action<NSError>)
AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr)	(Inherited from NSObject)
AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr)	(Inherited from NSObject)
AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>)	Registers an object for being observed externally using an arbitrary method. (Inherited from NSObject)
AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>)	Registers an object for being observed externally using an arbitrary method. (Inherited from NSObject)
AddWindowController(NSWindowController)
Autosave(Boolean, NSDocumentCompletionHandler)
AutosaveDocument(NSObject, Selector, IntPtr)
AutosavesInPlace()
AwakeFromNib()	(Inherited from NSObject)
BeginInvokeOnMainThread(Action)	(Inherited from NSObject)
BeginInvokeOnMainThread(Selector, NSObject)	Invokes asynchrously the specified code on the main UI thread. (Inherited from NSObject)
Bind(NSString, NSObject, String, NSBindingOptions)	(Inherited from NSObject)
Bind(NSString, NSObject, String, NSDictionary)	(Inherited from NSObject)
BrowseDocumentVersions(NSObject)
CanCloseDocument(NSObject, Selector, IntPtr)
CanConcurrentlyReadDocumentsOfType(String)
CanWriteAsynchronously(NSUrl, String, NSSaveOperationType)
ChangeCountToken(NSSaveOperationType)
CheckAutosavingSafety(NSError)
Close()
CommitEditing()	(Inherited from NSObject)
CommitEditing(NSObject, Selector, IntPtr)	(Inherited from NSObject)
ConformsToProtocol(NativeHandle)	(Inherited from NSObject)
ContinueActivity(Action)
ContinueAsynchronousWorkOnMainThread(Action)
Copy()	(Inherited from NSObject)
DangerousAutorelease()	Calls the 'autorelease' selector on this object. (Inherited from NSObject)
DangerousRelease()	Calls the 'release' selector on this object. (Inherited from NSObject)
DangerousRetain()	Calls the 'retain' selector on this object. (Inherited from NSObject)
DidChange(NSKeyValueChange, NSIndexSet, NSString)	(Inherited from NSObject)
DidChange(NSString, NSKeyValueSetMutationKind, NSSet)	(Inherited from NSObject)
DidChangeValue(String)	(Inherited from NSObject)
Dispose()	Releases the resources used by the NSObject object. (Inherited from NSObject)
Dispose(Boolean)	Releases the resources used by the NSObject object. (Inherited from NSObject)
DoesNotRecognizeSelector(Selector)	(Inherited from NSObject)
Duplicate(NSError)
DuplicateDocument(NSDocument+DuplicateCallback)
DuplicateDocument(NSObject)
EncodeRestorableState(NSCoder, NSOperationQueue)
EncodeRestorableState(NSCoder)
Equals(NSObject)	(Inherited from NSObject)
Equals(Object)	(Inherited from NSObject)
FileAttributesToWrite(NSUrl, String, NSSaveOperationType, NSUrl, NSError)
FileNameExtensionForSaveOperation(String, NSSaveOperationType)
GetAllowedClasses(String)
GetAsData(String, NSError)
GetAsFileWrapper(String, NSError)
GetBindingInfo(NSString)	(Inherited from NSObject)
GetBindingOptionDescriptions(NSString)	(Inherited from NSObject)
GetBindingValueClass(NSString)	(Inherited from NSObject)
GetDictionaryOfValuesFromKeys(NSString[])	(Inherited from NSObject)
GetHashCode()	Generates a hash code for the current instance. (Inherited from NSObject)
GetMethodForSelector(Selector)	(Inherited from NSObject)
GetNativeHash()	(Inherited from NSObject)
Init()	(Inherited from NSObject)
InitializeHandle(NativeHandle, String)	(Inherited from NSObject)
InitializeHandle(NativeHandle)	(Inherited from NSObject)
InvalidateRestorableState()
Invoke(Action, Double)	(Inherited from NSObject)
Invoke(Action, TimeSpan)	(Inherited from NSObject)
InvokeOnMainThread(Action)	(Inherited from NSObject)
InvokeOnMainThread(Selector, NSObject)	Invokes synchrously the specified code on the main UI thread. (Inherited from NSObject)
IsEqual(NSObject)	(Inherited from NSObject)
IsKindOfClass(Class)	(Inherited from NSObject)
IsMemberOfClass(Class)	(Inherited from NSObject)
IsNativeType(String)
KeepBackupFile()
LockDocument(NSObject)
LockDocumentWithCompletionHandler(NSDocumentLockDocumentCompletionHandler)
LockWithCompletionHandler(NSDocumentLockCompletionHandler)
MakeWindowControllers()
MarkDirty()	Promotes a regular peer object (IsDirectBinding is true) into a toggleref object. (Inherited from NSObject)
MoveDocument(NSObject)
MoveDocumentToUbiquityContainer(NSObject)
MoveDocumentWithCompletionHandler(NSDocumentMoveCompletionHandler)
MoveToUrl(NSUrl, NSDocumentMoveToUrlCompletionHandler)
MutableCopy()	(Inherited from NSObject)
ObjectDidBeginEditing(INSEditor)
ObjectDidEndEditing(INSEditor)
ObjectDidEndEditing(NSObject)	(Inherited from NSObject)
ObserveValue(NSString, NSObject, NSDictionary, IntPtr)	(Inherited from NSObject)
PerformActivity(Boolean, Action)
PerformAsynchronousFileAccess(Action)
PerformSelector(Selector, NSObject, Double, NSString[])	(Inherited from NSObject)
PerformSelector(Selector, NSObject, Double)	(Inherited from NSObject)
PerformSelector(Selector, NSObject, NSObject)	(Inherited from NSObject)
PerformSelector(Selector, NSObject)	(Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[])	(Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean)	(Inherited from NSObject)
PerformSelector(Selector)	(Inherited from NSObject)
PerformSynchronousFileAccess(Action)
Prepare(NSSharingServicePicker)
PrepareForInterfaceBuilder()	(Inherited from NSObject)
PreparePageLayout(NSPageLayout)
PrepareSavePanel(NSSavePanel)
PresentedItemChanged()
PresentedItemChangedUbiquityAttributes(NSSet<NSString>)
PresentedItemGainedVersion(NSFileVersion)
PresentedItemLostVersion(NSFileVersion)
PresentedItemMoved(NSUrl)
PresentedItemResolveConflictVersion(NSFileVersion)
PresentedSubitemAppeared(NSUrl)
PresentedSubitemChanged(NSUrl)
PresentedSubitemGainedVersion(NSUrl, NSFileVersion)
PresentedSubitemLostVersion(NSUrl, NSFileVersion)
PresentedSubitemMoved(NSUrl, NSUrl)
PresentedSubitemResolvedConflictVersion(NSUrl, NSFileVersion)
PresentError(NSError, NSWindow, NSObject, Selector, IntPtr)
PresentError(NSError)
PreservesVersions()
PrintDocument(NSDictionary, Boolean, NSObject, Selector, IntPtr)
PrintDocument(NSObject)
PrintOperation(NSDictionary, NSError)
ReadFromData(NSData, String, NSError)
ReadFromFileWrapper(NSFileWrapper, String, NSError)
ReadFromUrl(NSUrl, String, NSError)
RelinquishPresentedItemToReader(NSFilePresenterReacquirer)
RelinquishPresentedItemToWriter(NSFilePresenterReacquirer)
RemoveObserver(NSObject, NSString, IntPtr)	(Inherited from NSObject)
RemoveObserver(NSObject, NSString)	(Inherited from NSObject)
RemoveObserver(NSObject, String, IntPtr)	(Inherited from NSObject)
RemoveObserver(NSObject, String)	(Inherited from NSObject)
RemoveWindowController(NSWindowController)
RenameDocument(NSObject)
RespondsToSelector(Selector)	(Inherited from NSObject)
RestorableStateKeyPaths()
RestoreDocumentWindow(String, NSCoder, NSWindowCompletionHandler)
RestoreState(NSCoder)
RestoreUserActivityState(NSUserActivity)
RevertDocumentToSaved(NSObject)
RevertToContentsOfUrl(NSUrl, String, NSError)
RunModalPageLayout(NSPrintInfo, NSObject, Selector, IntPtr)
RunModalPrintOperation(NSPrintOperation, NSObject, Selector, IntPtr)
RunModalSavePanelForSaveOperation(NSSaveOperationType, NSObject, Selector, IntPtr)
RunPageLayout(NSObject)
SaveDocument(NSObject, Selector, IntPtr)
SaveDocument(NSObject)
SaveDocumentAs(NSObject)
SaveDocumentAsPdf(NSObject)
SaveDocumentTo(NSObject)
SavePresentedItemChanges(Action<NSError>)
SaveTo(NSUrl, String, NSSaveOperationType, NSDocumentCompletionHandler)
SaveToUrl(NSUrl, String, NSSaveOperationType, NSError)
SaveToUrl(NSUrl, String, NSSaveOperationType, NSObject, Selector, IntPtr)
ScheduleAutosaving()
SetNilValueForKey(NSString)	(Inherited from NSObject)
SetValueForKey(NSObject, NSString)	(Inherited from NSObject)
SetValueForKeyPath(NativeHandle, NSString)	(Inherited from NSObject)
SetValueForKeyPath(NSObject, NSString)	(Inherited from NSObject)
SetValueForUndefinedKey(NSObject, NSString)	(Inherited from NSObject)
SetValuesForKeysWithDictionary(NSDictionary)	(Inherited from NSObject)
SetWindow(NSWindow)
ShareDocument(NSSharingService, Action<Boolean>)
ShareDocumentAsync(NSSharingService)
ShouldChangePrintInfo(NSPrintInfo)
ShouldCloseWindowController(NSWindowController, NSObject, Selector, IntPtr)
ShowWindows()
StopBrowsingVersions(Action)
StopBrowsingVersionsAsync()
ToString()	Returns a string representation of the value of the current instance. (Inherited from NSObject)
Unbind(NSString)	(Inherited from NSObject)
UnblockUserInteraction()
UnlockDocument(NSObject)
UnlockDocumentWithCompletionHandler(NSDocumentUnlockDocumentCompletionHandler)
UnlockWithCompletionHandler(NSDocumentUnlockCompletionHandler)
UpdateChangeCount(NSDocumentChangeType)
UpdateChangeCount(NSObject, NSSaveOperationType)
UpdateUserActivityState(NSUserActivity)
ValidateMenuItem(NSMenuItem)
ValidateUserInterfaceItem(INSValidatedUserInterfaceItem)
ValueForKey(NSString)	(Inherited from NSObject)
ValueForKeyPath(NSString)	(Inherited from NSObject)
ValueForUndefinedKey(NSString)	(Inherited from NSObject)
WillChange(NSKeyValueChange, NSIndexSet, NSString)	(Inherited from NSObject)
WillChange(NSString, NSKeyValueSetMutationKind, NSSet)	(Inherited from NSObject)
WillChangeValue(String)	(Inherited from NSObject)
WillNotPresentError(NSError)
WillPresentError(NSError)
WindowControllerDidLoadNib(NSWindowController)
WindowControllerWillLoadNib(NSWindowController)
WritableTypes()
WritableTypesForSaveOperation(NSSaveOperationType)
WriteSafelyToUrl(NSUrl, String, NSSaveOperationType, NSError)
WriteToUrl(NSUrl, String, NSError)
WriteToUrl(NSUrl, String, NSSaveOperationType, NSUrl, NSError)

Extension Methods

Name	Description
ObjectDidBeginEditing(INSEditorRegistration, INSEditor)
ObjectDidEndEditing(INSEditorRegistration, INSEditor)
ObjectDidBeginEditing(NSObject, INSEditor)
ObjectDidEndEditing(NSObject, INSEditor)
GetValidModes(NSObject, NSFontPanel)
ValidateToolbarItem(NSObject, NSToolbarItem)
BrowserAccessibilityDeleteTextAtCursor(NSObject, IntPtr)
BrowserAccessibilityInsertTextAtCursor(NSObject, String)
GetAccessibilityLineEndPositionFromCurrentSelection(NSObject)
GetAccessibilityLineRangeForPosition(NSObject, IntPtr)
GetAccessibilityLineStartPositionFromCurrentSelection(NSObject)
GetBrowserAccessibilityAttributedValue(NSObject, NSRange)
GetBrowserAccessibilityContainerType(NSObject)
GetBrowserAccessibilityCurrentStatus(NSObject)
GetBrowserAccessibilityHasDomFocus(NSObject)
GetBrowserAccessibilityIsRequired(NSObject)
GetBrowserAccessibilityPressedState(NSObject)
GetBrowserAccessibilityRoleDescription(NSObject)
GetBrowserAccessibilitySelectedTextRange(NSObject)
GetBrowserAccessibilitySortDirection(NSObject)
GetBrowserAccessibilityValue(NSObject, NSRange)
SetBrowserAccessibilityContainerType(NSObject, BEAccessibilityContainerType)
SetBrowserAccessibilityCurrentStatus(NSObject, String)
SetBrowserAccessibilityHasDomFocus(NSObject, Boolean)
SetBrowserAccessibilityIsRequired(NSObject, Boolean)
SetBrowserAccessibilityPressedState(NSObject, BEAccessibilityPressedState)
SetBrowserAccessibilityRoleDescription(NSObject, String)
SetBrowserAccessibilitySelectedTextRange(NSObject, NSRange)
SetBrowserAccessibilitySortDirection(NSObject, String)
ProvideImageData(NSObject, IntPtr, UIntPtr, UIntPtr, UIntPtr, UIntPtr, UIntPtr, NSObject)
ProvideImageToMTLTexture(NSObject, IMTLTexture, IMTLCommandBuffer, UIntPtr, UIntPtr, UIntPtr, UIntPtr, NSObject)
AccommodatePresentedItemDeletion(INSFilePresenter, Action<NSError>)
AccommodatePresentedItemEviction(INSFilePresenter, Action<NSError>)
AccommodatePresentedSubitemDeletion(INSFilePresenter, NSUrl, Action<NSError>)
GetPresentedItemObservedUbiquityAttributes(INSFilePresenter)	Gets the set of ubiquity attributes that will generate notifications if they are modified.
GetPrimaryPresentedItemUrl(INSFilePresenter)
PresentedItemChanged(INSFilePresenter)
PresentedItemChangedUbiquityAttributes(INSFilePresenter, NSSet<NSString>)
PresentedItemGainedVersion(INSFilePresenter, NSFileVersion)
PresentedItemLostVersion(INSFilePresenter, NSFileVersion)
PresentedItemMoved(INSFilePresenter, NSUrl)
PresentedItemResolveConflictVersion(INSFilePresenter, NSFileVersion)
PresentedSubitemAppeared(INSFilePresenter, NSUrl)
PresentedSubitemChanged(INSFilePresenter, NSUrl)
PresentedSubitemGainedVersion(INSFilePresenter, NSUrl, NSFileVersion)
PresentedSubitemLostVersion(INSFilePresenter, NSUrl, NSFileVersion)
PresentedSubitemMoved(INSFilePresenter, NSUrl, NSUrl)
PresentedSubitemResolvedConflictVersion(INSFilePresenter, NSUrl, NSFileVersion)
RelinquishPresentedItemToReader(INSFilePresenter, NSFilePresenterReacquirer)
RelinquishPresentedItemToWriter(INSFilePresenter, NSFilePresenterReacquirer)
SavePresentedItemChanges(INSFilePresenter, Action<NSError>)
SetSharedObservers(NSObject, NSKeyValueSharedObserversSnapshot)
GetDebugDescription(INSObjectProtocol)
GetHandle(INativeObject)
GetNonNullHandle(INativeObject, String)
AcceptsPreviewPanelControl(NSObject, QLPreviewPanel)
BeginPreviewPanelControl(NSObject, QLPreviewPanel)
EndPreviewPanelControl(NSObject, QLPreviewPanel)

Applies to

Share via