UIManagedDocument Class

Definition

A UIDocument that integrates with Core Data.

[Foundation.Register("UIManagedDocument", true)]
[ObjCRuntime.Unavailable(ObjCRuntime.PlatformName.TvOS, ObjCRuntime.PlatformArchitecture.All, null)]
public class UIManagedDocument : UIKit.UIDocument
type UIManagedDocument = class
    inherit UIDocument
Inheritance
UIManagedDocument
Attributes

Constructors

UIManagedDocument(IntPtr)

A constructor used when creating managed representations of unmanaged objects; Called by the runtime.

UIManagedDocument(NSObjectFlag)

Constructor to call on derived classes to skip initialization and merely allocate the object.

UIManagedDocument(NSUrl)

Properties

Class (Inherited from NSObject)
ClassHandle

The handle for this class.

DebugDescription

A developer-meaningful description of this object.

(Inherited from NSObject)
Description

Description of the object, the Objective-C version of ToString.

(Inherited from NSObject)
DocumentState

The current UIDocumentState of this UIDocument. Read-only.

(Inherited from UIDocument)
FileModificationDate

The date and time at which the document file was last modified.

(Inherited from UIDocument)
FileType

The Uniform Type Identifier for this UIDocument. Read-only.

(Inherited from UIDocument)
FileUrl

The file URL from which this UIDocument was initialized. Read-only.

(Inherited from UIDocument)
Handle

Handle (pointer) to the unmanaged object representation.

(Inherited from NSObject)
HasUnsavedChanges

Whether this UIDocument has any unsaved changes.

(Inherited from UIDocument)
IsDirectBinding (Inherited from NSObject)
IsProxy (Inherited from NSObject)
LocalizedName

The localized name of this UIDocument. Read-only.

(Inherited from UIDocument)
ManagedObjectContext

This UIManagedDocument's managed object context. Read-only.

ManagedObjectModel

This UIManagedDocument's managed object model. Read-only.

ModelConfiguration

A name to be passed when configuring the persistent store.

PersistentStoreName

The name for the persistent store file inside the document's file package.

PersistentStoreOptions

Options to be used when creating the persistent store.

PesentedItemOperationQueue

Gets an operation queue.

(Inherited from UIDocument)
PresentedItemObservedUbiquityAttributes

Gets the set of ubiquity attributes that will generate notifications if they are modified.

(Inherited from UIDocument)
PresentedItemURL

Gets URL of presented item.

(Inherited from UIDocument)
Progress

A NSProgress object that reports on the current operation of this document.

(Inherited from UIDocument)
RetainCount

Returns the current Objective-C retain count for the object.

(Inherited from NSObject)
SavingFileType

The file type used for saving this UIDocument.

(Inherited from UIDocument)
Self (Inherited from NSObject)
Superclass (Inherited from NSObject)
SuperHandle

Handle used to represent the methods in the base class for this NSObject.

(Inherited from NSObject)
UndoManager

The NSUndoManager for this UIDocument.

(Inherited from UIDocument)
UserActivity

Object that encapsulates user activity information.

(Inherited from UIDocument)
Zone (Inherited from NSObject)

Methods

AccommodatePresentedItemDeletion(Action<NSError>)

Accomodates the presented subitem deletion.

(Inherited from UIDocument)
AccommodatePresentedSubitemDeletion(NSUrl, Action<NSError>)

Accomodates the presented subitem deletion.

(Inherited from UIDocument)
AdditionalContent(NSUrl, NSError)

Responsible for writing non-Core Data content to the additional content directory in the document's file package.

AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr)

Registers an object for being observed externally (using NSString keyPath).   Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method.

(Inherited from NSObject)
AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr)

Registers an object for being observed externally (using string keyPath).   Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method.

(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)
AutoSave(UIOperationHandler)

Called by the system immediately prior to automatic saving of UIDocuments with unsaved changes.

(Inherited from UIDocument)
AutoSaveAsync()

Called by the system immediately prior to automatic saving of UIDocuments with unsaved changes.

(Inherited from UIDocument)
AwakeFromNib()

Called after the object has been loaded from the nib file. Overriders must call base.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, NSDictionary) (Inherited from NSObject)
Bind(String, NSObject, String, NSDictionary)
Obsolete.
(Inherited from NSObject)
BindingInfo(String)
Obsolete.
(Inherited from NSObject)
BindingOptionDescriptions(String)
Obsolete.
(Inherited from NSObject)
BindingValueClass(String)
Obsolete.
(Inherited from NSObject)
ChangeCountTokenForSaveOperation(UIDocumentSaveOperation)

When overridden, returns an object encapsulating document changes. Used with UpdateChangeCount and Save.

(Inherited from UIDocument)
Close(UIOperationHandler)

Asynchronously closes the document after saving any changes.

(Inherited from UIDocument)
CloseAsync()

Asynchronously closes the document after saving any changes.

(Inherited from UIDocument)
CommitEditing() (Inherited from NSObject)
CommitEditing(NSObject, Selector, IntPtr) (Inherited from NSObject)
ConfigurePersistentStoreCoordinator(NSUrl, String, String, NSDictionary, NSError)

Creates or loads the document's persistent store.

ConformsToProtocol(IntPtr)

Invoked to determine if this object implements the specified protocol.

(Inherited from NSObject)
ContentsForType(String, NSError)

Application developers should override this method to return the document data to be saved.

(Inherited from UIDocument)
Copy()

Performs a copy of the underlying Objective-C object.

(Inherited from NSObject)
DangerousAutorelease() (Inherited from NSObject)
DangerousRelease() (Inherited from NSObject)
DangerousRetain() (Inherited from NSObject)
DidChange(NSKeyValueChange, NSIndexSet, NSString)

Indicates a change occurred to the indexes for a to-many relationship.

(Inherited from NSObject)
DidChange(NSString, NSKeyValueSetMutationKind, NSSet) (Inherited from NSObject)
DidChangeValue(String)

Indicates that a change occurred on the specified key.

(Inherited from NSObject)
DisableEditing()

When overridden, allows app developers to disable editing when it is unsafe to make changes to this UIDocument.

(Inherited from UIDocument)
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)

Indicates that this object does not recognize the specified selector.

(Inherited from NSObject)
EnableEditing()

When overridden, allows app developers to re-enable editing when it is safe to make changes to this UIDocument.

(Inherited from UIDocument)
Equals(NSObject) (Inherited from NSObject)
Equals(Object) (Inherited from NSObject)
ExposedBindings() (Inherited from NSObject)
FinishedHandlingError(NSError, Boolean)

Application developers should call this function when they have finished handling an error.

(Inherited from UIDocument)
GetBindingInfo(NSString) (Inherited from NSObject)
GetBindingOptionDescriptions(NSString) (Inherited from NSObject)
GetBindingValueClass(NSString) (Inherited from NSObject)
GetDictionaryOfValuesFromKeys(NSString[])

Retrieves the values of the specified keys.

(Inherited from NSObject)
GetFileAttributesToWrite(NSUrl, UIDocumentSaveOperation, NSError)

A dictionary of file attributes to associate with this UIDocument when writing or updating it.

(Inherited from UIDocument)
GetFileNameExtension(String, UIDocumentSaveOperation)

The file extension to append to the file URL of this UIDocument when writing it.

(Inherited from UIDocument)
GetHashCode()

Generates a hash code for the current instance.

(Inherited from NSObject)
GetMethodForSelector(Selector) (Inherited from NSObject)
GetNativeField(String)
Obsolete.
(Inherited from NSObject)
GetNativeHash() (Inherited from NSObject)
GetPersistentStoreType(String)

The Core Data store type for the specified document file type.

HandleError(NSError, Boolean)

Called when an error occurs during reading, saving, or reverting this UIDocument.

(Inherited from UIDocument)
Init() (Inherited from NSObject)
InitializeHandle(IntPtr) (Inherited from NSObject)
InitializeHandle(IntPtr, String) (Inherited from NSObject)
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)
LoadFromContents(NSObject, String, NSError)

App developers should override this method to load document data into their domain objects.

(Inherited from UIDocument)
MarkDirty()

Promotes a regular peer object (IsDirectBinding is true) into a toggleref object.

(Inherited from NSObject)
MutableCopy()

Creates a mutable copy of the specified NSObject.

(Inherited from NSObject)
ObjectDidEndEditing(NSObject) (Inherited from NSObject)
ObserveValue(NSString, NSObject, NSDictionary, IntPtr)

Indicates that the value at the specified keyPath relative to this object has changed.

(Inherited from NSObject)
Open(UIOperationHandler)

Asynchronously opens a document.

(Inherited from UIDocument)
OpenAsync()

Asynchronously opens a document.

(Inherited from UIDocument)
PerformAsynchronousFileAccess(Action)

Performs an asynchronous file access action.

(Inherited from UIDocument)
PerformAsynchronousFileAccessAsync()

Performs an asynchronous file access action.

(Inherited from UIDocument)
PerformSelector(Selector) (Inherited from NSObject)
PerformSelector(Selector, NSObject) (Inherited from NSObject)
PerformSelector(Selector, NSObject, Double)

Invokes the selector on the current instance and if the obj is not null, it passes this as its single parameter.

(Inherited from NSObject)
PerformSelector(Selector, NSObject, Double, NSString[]) (Inherited from NSObject)
PerformSelector(Selector, NSObject, NSObject) (Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean) (Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[]) (Inherited from NSObject)
PrepareForInterfaceBuilder() (Inherited from NSObject)
PresentedItemChanged()

Changed NSFileVersion of item.

(Inherited from UIDocument)
PresentedItemChangedUbiquityAttributes(NSSet<NSString>)

The system calls this function to indicate that the have changed in ubiquity.

(Inherited from UIDocument)
PresentedItemGainedVersion(NSFileVersion)

Presents gained NSFileVersion of item.

(Inherited from UIDocument)
PresentedItemLostVersion(NSFileVersion)

Presents lost version of item.

(Inherited from UIDocument)
PresentedItemMoved(NSUrl)

Defines subitem move between URLs.

(Inherited from UIDocument)
PresentedItemResolveConflictVersion(NSFileVersion)

Resolves conflict version of item.

(Inherited from UIDocument)
PresentedSubitemAppeared(NSUrl)

Sets appearance URL.

(Inherited from UIDocument)
PresentedSubitemChanged(NSUrl)

Changed NSFileVersion of subitem.

(Inherited from UIDocument)
PresentedSubitemGainedVersion(NSUrl, NSFileVersion)

Presents gained version of subitem.

(Inherited from UIDocument)
PresentedSubitemLostVersion(NSUrl, NSFileVersion)

Presents lost version of file.

(Inherited from UIDocument)
PresentedSubitemMoved(NSUrl, NSUrl)

Defines subitem move between URLs.

(Inherited from UIDocument)
PresentedSubitemResolvedConflictVersion(NSUrl, NSFileVersion)

Resolves conflict version of subitem.

(Inherited from UIDocument)
Read(NSUrl, NSError)

Reads the document data from the specified location into the application sandbox.

(Inherited from UIDocument)
ReadAdditionalContent(NSUrl, NSError)

Responsible for reading non-Core Data content from the additional content directory in the document's file package.

RelinquishPresentedItemToReader(NSFilePresenterReacquirer)

Another request has been made for read access the presented item. (App developers overriding this method must run the readerAction action after releasing the resource.)

(Inherited from UIDocument)
RelinquishPresentedItemToWriter(NSFilePresenterReacquirer)

Another request has been made for write access the presented item. (App developers overriding this method must run the writerAction action after releasing the resource.)

(Inherited from UIDocument)
RemoveObserver(NSObject, NSString)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath.

(Inherited from NSObject)
RemoveObserver(NSObject, NSString, IntPtr)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context.

(Inherited from NSObject)
RemoveObserver(NSObject, String)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath.

(Inherited from NSObject)
RemoveObserver(NSObject, String, IntPtr)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context.

(Inherited from NSObject)
RespondsToSelector(Selector)

Whether this object recognizes the specified selector.

(Inherited from NSObject)
RestoreUserActivityState(NSUserActivity)

Restores the state of the user activity.

(Inherited from UIDocument)
RevertToContentsOfUrl(NSUrl, UIOperationHandler)

Reverts the UIDocument to the most recent document data stored on-disk.

(Inherited from UIDocument)
RevertToContentsOfUrlAsync(NSUrl)

Reverts the UIDocument to the most recent document data stored on-disk.

(Inherited from UIDocument)
Save(NSUrl, UIDocumentSaveOperation, UIOperationHandler)

Saves the document data to the specified location in the application sandbox.

(Inherited from UIDocument)
SaveAsync(NSUrl, UIDocumentSaveOperation)

Saves the document data to the specified location in the application sandbox.

(Inherited from UIDocument)
SavePresentedItemChanges(Action<NSError>)

Saves changes to the presented item.

(Inherited from UIDocument)
SetNativeField(String, NSObject)
Obsolete.
(Inherited from NSObject)
SetNilValueForKey(NSString)

Sets the value of the specified key to null.

(Inherited from NSObject)
SetValueForKey(NSObject, NSString)

Sets the value of the property specified by the key to the specified value.

(Inherited from NSObject)
SetValueForKeyPath(IntPtr, NSString)

A constructor used when creating managed representations of unmanaged objects; Called by the runtime.

(Inherited from NSObject)
SetValueForKeyPath(NSObject, NSString)

Sets the value of a property that can be reached using a keypath.

(Inherited from NSObject)
SetValueForUndefinedKey(NSObject, NSString)

Indicates an attempt to write a value to an undefined key. If not overridden, raises an NSUndefinedKeyException.

(Inherited from NSObject)
SetValuesForKeysWithDictionary(NSDictionary)

Sets the values of this NSObject to those in the specified dictionary.

(Inherited from NSObject)
ToString()

Returns a string representation of the value of the current instance.

(Inherited from NSObject)
Unbind(NSString) (Inherited from NSObject)
Unbind(String)
Obsolete.
(Inherited from NSObject)
UpdateChangeCount(NSObject, UIDocumentSaveOperation)

When overridden, can customize the change count with reference to the specified changeCountToken.

(Inherited from UIDocument)
UpdateChangeCount(UIDocumentChangeKind)

Updates the change counter by indicating the kind of change.

(Inherited from UIDocument)
UpdateUserActivityState(NSUserActivity)

Updates the activity's state.

(Inherited from UIDocument)
UserInteractionNoLongerPermittedForError(NSError)

Indicates that it is no longer safe to proceed without handling the error.

(Inherited from UIDocument)
ValueForKey(NSString)

Returns the value of the property associated with the specified key.

(Inherited from NSObject)
ValueForKeyPath(NSString)

Returns the value of a property that can be reached using a keypath.

(Inherited from NSObject)
ValueForUndefinedKey(NSString)

Indicates an attempt to read a value of an undefined key. If not overridden, raises an NSUndefinedKeyException.

(Inherited from NSObject)
WillChange(NSKeyValueChange, NSIndexSet, NSString)

Indicates that the values of the specified indices in the specified key are about to change.

(Inherited from NSObject)
WillChange(NSString, NSKeyValueSetMutationKind, NSSet) (Inherited from NSObject)
WillChangeValue(String)

Indicates that the value of the specified key is about to change.

(Inherited from NSObject)
WriteAdditionalContent(NSObject, NSUrl, NSUrl, NSError)

Writes non-Core Data content to the document's file package.

WriteContents(NSObject, NSDictionary, NSUrl, UIDocumentSaveOperation, NSError)

Writes and ensures that the document data is written properly to the specified location in the application sandbox.

(Inherited from UIDocument)
WriteContents(NSObject, NSUrl, UIDocumentSaveOperation, NSUrl, NSError)

Writes and ensures that the document data is written properly to the specified location in the application sandbox.

(Inherited from UIDocument)

Extension Methods

AccommodatePresentedItemDeletion(INSFilePresenter, Action<NSError>)
AccommodatePresentedSubitemDeletion(INSFilePresenter, NSUrl, Action<NSError>)
GetPresentedItemObservedUbiquityAttributes(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>)
GetDebugDescription(INSObjectProtocol)
GetProgress(INSProgressReporting)
GetAccessibilityCustomRotors(NSObject)

Gets the array of UIAccessibilityCustomRotor objects appropriate for this object.

SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[])

Sets the array of UIAccessibilityCustomRotor objects appropriate for this object.

Applies to

See also