Instance Method

initWithURL:options:documentAttributes:error:

Initializes a new NSAttributedString object from the contents of the given URL.

Declaration

- (instancetype)initWithURL:(NSURL *)url options:(NSDictionary<NSAttributedStringDocumentReadingOptionKey, id> *)options documentAttributes:(NSDictionary<NSAttributedStringDocumentAttributeKey, id> * _Nullable *)dict error:(NSError * _Nullable *)error;

Parameters

url: An NSURL object specifying the document to load.
options: Specifies how the document should be loaded. Contains values described in Option keys for importing documents.
docAttributes: An in-out dictionary containing document-level attributes described in Document Attributes. May be NULL, in which case no document attributes are returned.
error: An in-out parameter that returns an error if the method returns nil.

Return Value

Returns an initialized object, or nil if the data can’t be decoded.

Discussion

Filter services can be used to convert the file into a format recognized by Cocoa. The options dictionary specifies how the document should be loaded and can contain the values described in Option keys for importing documents.

If NSDocumentTypeDocumentOption is specified, the document is treated as being in the specified format. If NSDocumentTypeDocumentOption is not specified, the method examines the document and loads it using whatever format it seems to contain.

Also returns by reference in dict a dictionary containing document-level attributes described in Document Attributes. The dict parameter may be nil, in which case no document attributes are returned. Returns an initialized object, or nil if the file at url can’t be decoded, after setting error to point to an NSError object that encapsulates the reason why the attributed string object could not be created.