Instance Method

openUntitledDocumentAndDisplay(_:)

Creates a new untitled document, presents its user interface if displayDocument is true, and returns the document if successful.

Declaration

func openUntitledDocumentAndDisplay(_ displayDocument: Bool) throws -> NSDocument

Parameters

displayDocument

true if the user interface for the document should be shown, otherwise false.

outError

On return, an error if the document could not be created, otherwise nil.

Return Value

Returns the new NSDocument object, or nil if a new untitled document could not be created. If this method returns nil, it also sets the address referenced by outError to an NSError object that tell why the document could not be created.

Discussion

The default implementation of this method calls defaultType to determine the type of new document to create, calls makeUntitledDocument(ofType:) to create it, then calls addDocument(_:) to record its opening.

When displayDocument is true, this method sends the new document makeWindowControllers() and showWindows() messages. In this scenario, showWindows() shows only the window controllers that have been assigned to the document.

See Also

Creating and Opening Documents

func document(for: URL) -> NSDocument?

Returns, for a given URL, the open document whose file or file package is located by the URL, or nil if there is no such open document.

func duplicateDocument(withContentsOf: URL, copying: Bool, displayName: String?) -> NSDocument

Creates a new document by reading the contents for the document from another URL, presents its user interface, and returns the document if successful.

func openDocument(withContentsOf: URL, display: Bool, completionHandler: (NSDocument?, Bool, Error?) -> Void)

Opens a document located by a URL, optionally presents its user interface, and calls the passed-in completion handler.

func makeDocument(for: URL?, withContentsOf: URL, ofType: String) -> NSDocument

Instantiates a document located by a URL, of a specified type, but by reading the contents for the document from another URL, and returns it if successful.

func makeDocument(withContentsOf: URL, ofType: String) -> NSDocument

Instantiates a document located by a URL, of a specified type, and returns it if successful.

func makeUntitledDocument(ofType: String) -> NSDocument

Instantiates a new untitled document of the specified type and returns it if successful.

func reopenDocument(for: URL?, withContentsOf: URL, display: Bool, completionHandler: (NSDocument?, Bool, Error?) -> Void)

Reopens a document, optionally located by a URL, by reading the contents for the document from another URL, optionally presents its user interface, and calls the passed-in completion handler.