Instance Method

saveToURL:ofType:forSaveOperation:error:

Saves the contents of the document to a file or file package located by a URL, formatted to a specified type, for a particular kind of save operation, and returns YES if successful.

Declaration

- (BOOL)saveToURL:(NSURL *)url ofType:(NSString *)typeName forSaveOperation:(NSSaveOperationType)saveOperation error:(NSError * _Nullable *)outError;

Parameters

absoluteURL

The location of the file or file package to which the document contents are saved.

typeName

The string that identifies the document type.

saveOperation

The type of save operation.

outError

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

Return Value

YES if the document contents were successfully saved; otherwise, NO.

Discussion

You can override this method to do things that need to be done before or after any save operation. If you override this method, you must call super at some point in your implementation.

See Also

Deprecated Methods

- canCloseDocument

This method is no longer supported.

- dataRepresentationOfType:

A primitive method overridden by subclasses to return a data object that represents the data of the receiver in a given type.

Deprecated
- fileAttributesToWriteToFile:ofType:saveOperation:

Returns the file attributes that should be written to the named document file of the specified type.

Deprecated
- fileName

Returns the filename (as a fully qualified path) under which the receiver has been saved.

Deprecated
- fileNameFromRunningSavePanelForSaveOperation:

Returns the filename entered into the Save panel.

- fileWrapperRepresentationOfType:

Returns an NSFileWrapper object that represents the data of the receiver in a given type.

Deprecated
- initWithContentsOfFile:ofType:

Initializes and returns an NSDocument object.

Deprecated
- initWithContentsOfURL:ofType:

Initializes and returns an NSDocument object of a given document type.

Deprecated
- loadDataRepresentation:ofType:

Overridden by subclasses to load document data.

Deprecated
- loadFileWrapperRepresentation:ofType:

Loads document data from a given file wrapper.

Deprecated
- printShowingPrintPanel:

Overridden by subclasses to print the current document’s (the receiver’s) data.

Deprecated
- readFromFile:ofType:

Reads and loads document data of the given type from the given file.

Deprecated
- readFromURL:ofType:

Reads and loads document data.

Deprecated
- revertToSavedFromFile:ofType:

Reverts the receiver to the data stored in the file system.

Deprecated
- revertToSavedFromURL:ofType:

Reverts the receiver.

Deprecated
- runModalPageLayoutWithPrintInfo:

Runs the page layout modal panel with the receiver’s printing information object.

Deprecated
- saveToFile:saveOperation:delegate:didSaveSelector:contextInfo:

Called after the user has been given the opportunity to select a destination through the modal Save panel.

Deprecated
- setFileName:

Sets the file (filename and directory path) under which document data is saved.

Deprecated
- shouldCloseWindowController:

Gives the user an opportunity to save the document.

- validateMenuItem:

Validates the Revert menu item and items selected from the Save panel’s pop-up list of writable document types items.

- writeToFile:ofType:

Writes document data to a file.

Deprecated
- writeToFile:ofType:originalFile:saveOperation:

Writes the receiver document’s contents to a file.

Deprecated
- writeToURL:ofType:

Writes document data to a URL.

Deprecated
- writeWithBackupToFile:ofType:saveOperation:

This method is called by action methods to save document contents to a file.

Deprecated