Instance Method

read(from:ofType:)

Sets the contents of this document by reading from a file wrapper of a specified type.

Declaration

func read(from fileWrapper: FileWrapper, ofType typeName: String) throws

Parameters

fileWrapper

The file wrapper from which the document contents are read.

typeName

The string that identifies the document type.

outError

On return, if the document contents could not be read, a pointer to an error object that encapsulates the reason they could not be read.

Return Value

true if the document contents could be read; otherwise, false.

Discussion

The default implementation of this method invokes [self readFromData:[fileWrapper regularFileContents] ofType:typeName error:outError].

For backward binary compatibility with OS X v10.3 and earlier, the default implementation of this method instead invokes [self loadFileWrapperRepresentation:fileWrapper ofType:typeName] if loadFileWrapperRepresentation:ofType: is overridden.

See Also

Reading From and Writing to Files

var fileModificationDate: Date?

The last known modification date of the document’s on-disk representation.

func runModalSavePanel(for: NSDocument.SaveOperationType, delegate: Any?, didSave: Selector?, contextInfo: UnsafeMutableRawPointer?)

Presents a modal Save panel to the user, then tries to save the document if the user approves the panel.

var shouldRunSavePanelWithAccessoryView: Bool

A Boolean value indicating whether the document’s Save panel displays a list of supported writable document types.

var keepBackupFile: Bool

A Boolean value indicating whether the document keeps the backup files created before the document data is written to a file.

var backupFileURL: URL?

The URL for the document’s backup file that was created during an autosave operation.

var fileURL: URL?

The location of the document’s on-disk representation.

var isDraft: Bool

A Boolean value indicating whether the document is a draft that the user has not expressed an interest in keeping around.