UIKit.UIDocument Members

The members of UIKit.UIDocument are listed below.

See Also: Inherited members from Foundation.NSObject

Public Constructors

Protected Constructors

Constructor to call on derived classes to skip initialization and merely allocate the object.
A constructor used when creating managed representations of unmanaged objects; Called by the runtime.

Public Properties

[read-only]
override
ClassHandleIntPtr. The handle for this class.
[read-only]
DocumentStateUIDocumentState. The current UIDocumentState of this UIDocument. Read-only.
FileModificationDateFoundation.NSDate. The date and time at which the document file was last modified.
[read-only]
FileTypestring. The Uniform Type Identifier for this UIDocument. Read-only.
[read-only]
FileUrlFoundation.NSUrl. The file URL from which this UIDocument was initialized. Read-only.
[read-only]
HasUnsavedChangesbool. Whether this UIDocument has any unsaved changes.
[read-only]
LocalizedNamestring. The localized name of this UIDocument. Read-only.
[read-only]
PesentedItemOperationQueueFoundation.NSOperationQueue. Gets an operation queue.
[read-only]
PresentedItemURLFoundation.NSUrl. Gets URL of presented item.
[read-only]
SavingFileTypestring. The file type used for saving this UIDocument.
[read-only]
static
StateChangedNotificationFoundation.NSString. Notification constant for StateChanged
UndoManagerFoundation.NSUndoManager. The NSUndoManager for this UIDocument.
UserActivityFoundation.NSUserActivity. Object that encapsulates user activity information.

Public Methods

AccommodatePresentedItemDeletion(Action<Foundation.NSError>)
Accomodates the presented subitem deletion.
AccommodatePresentedSubitemDeletion(Foundation.NSUrl, Action<Foundation.NSError>)
Accomodates the presented subitem deletion.
AutoSave(UIOperationHandler)
Called by the system immediately prior to automatic saving of UIDocuments with unsaved changes.
AutoSaveAsync() : System.Threading.Tasks.Task<bool>
Called by the system immediately prior to automatic saving of UIDocuments with unsaved changes.
ChangeCountTokenForSaveOperation(UIDocumentSaveOperation) : Foundation.NSObject
When overridden, returns an object encapsulating document changes. Used with UpdateChangeCount and Save.
Close(UIOperationHandler)
Asynchronously closes the document after saving any changes.
CloseAsync() : System.Threading.Tasks.Task<bool>
Asynchronously closes the document after saving any changes.
ContentsForType(string, out Foundation.NSError) : Foundation.NSObject
Application developers should override this method to return the document data to be saved.
DisableEditing()
When overridden, allows app developers to disable editing when it is unsafe to make changes to this UIDocument.
EnableEditing()
When overridden, allows app developers to re-enable editing when it is safe to make changes to this UIDocument.
FinishedHandlingError(Foundation.NSError, bool)
Application developers should call this function when they have finished handling an error.
GetFileAttributesToWrite(Foundation.NSUrl, UIDocumentSaveOperation, out Foundation.NSError) : Foundation.NSDictionary
A dictionary of file attributes to associate with this UIDocument when writing or updating it.
GetFileNameExtension(string, UIDocumentSaveOperation) : string
The file extension to append to the file URL of this UIDocument when writing it.
HandleError(Foundation.NSError, bool)
Called when an error occurs during reading, saving, or reverting this UIDocument.
LoadFromContents(Foundation.NSObject, string, out Foundation.NSError) : bool
App developers should override this method to load document data into their domain objects.
Open(UIOperationHandler)
Asynchronously opens a document.
OpenAsync() : System.Threading.Tasks.Task<bool>
Asynchronously opens a document.
PerformAsynchronousFileAccess(Action)
Performs an asynchronous file access action.
PerformAsynchronousFileAccessAsync() : System.Threading.Tasks.Task
Schedules a read or write operation on a background thread.
PresentedItemChanged()
Changed NSFileVersion of item.
PresentedItemGainedVersion(Foundation.NSFileVersion)
Presents gained NSFileVersion of item.
PresentedItemLostVersion(Foundation.NSFileVersion)
Presents lost version of item.
PresentedItemMoved(Foundation.NSUrl)
Defines subitem move between URLs.
PresentedItemResolveConflictVersion(Foundation.NSFileVersion)
Resolves conflict version of item.
PresentedSubitemAppeared(Foundation.NSUrl)
Sets appearance URL.
PresentedSubitemChanged(Foundation.NSUrl)
Changed NSFileVersion of subitem.
PresentedSubitemGainedVersion(Foundation.NSUrl, Foundation.NSFileVersion)
Presents gained version of subitem.
PresentedSubitemLostVersion(Foundation.NSUrl, Foundation.NSFileVersion)
Presents lost version of file.
PresentedSubitemMoved(Foundation.NSUrl, Foundation.NSUrl)
Defines subitem move between URLs.
PresentedSubitemResolvedConflictVersion(Foundation.NSUrl, Foundation.NSFileVersion)
Resolves conflict version of subitem.
Read(Foundation.NSUrl, out Foundation.NSError) : bool
Reads the document data from the specified location into the application sandbox.
RelinquishPresentedItemToReader(Foundation.NSFilePresenterReacquirer)
Documentation for this section has not yet been entered.
RelinquishPresentedItemToWriter(Foundation.NSFilePresenterReacquirer)
Documentation for this section has not yet been entered.
RestoreUserActivityState(Foundation.NSUserActivity)
Restores the state of the user activity.
RevertToContentsOfUrl(Foundation.NSUrl, UIOperationHandler)
Reverts the UIDocument to the most recent document data stored on-disk.
RevertToContentsOfUrlAsync(Foundation.NSUrl) : System.Threading.Tasks.Task<bool>
Reverts the UIDocument to the most recent document data stored on-disk.
Save(Foundation.NSUrl, UIDocumentSaveOperation, UIOperationHandler)
Saves the document data to the specified location in the application sandbox.
SaveAsync(Foundation.NSUrl, UIDocumentSaveOperation) : System.Threading.Tasks.Task<bool>
Saves the document data to the specified location in the application sandbox.
SavePresentedItemChanges(Action<Foundation.NSError>)
Saves changes to the presented item.
UpdateChangeCount(UIDocumentChangeKind)
Updates the change counter by indicating the kind of change.
UpdateChangeCount(Foundation.NSObject, UIDocumentSaveOperation)
When overridden, can customize the change count with reference to the specified changeCountToken.
UpdateUserActivityState(Foundation.NSUserActivity)
Updates the activity's state.
UserInteractionNoLongerPermittedForError(Foundation.NSError)
Indicates that it is no longer safe to proceed without handling the error.
WriteContents(Foundation.NSObject, Foundation.NSDictionary, Foundation.NSUrl, UIDocumentSaveOperation, out Foundation.NSError) : bool
Writes and ensures that the document data is written properly to the specified location in the application sandbox.
WriteContents(Foundation.NSObject, Foundation.NSUrl, UIDocumentSaveOperation, Foundation.NSUrl, out Foundation.NSError) : bool
Writes and ensures that the document data is written properly to the specified location in the application sandbox.

Protected Methods

override
Dispose(bool)
Releases the resources used by the UIDocument object.