Instance Method

rtf(from:documentAttributes:)

Returns an NSData object that contains an RTF stream corresponding to the characters and attributes within the given range, omitting all attachment attributes.

Declaration

func rtf(from range: NSRange, documentAttributes dict: [NSAttributedString.DocumentAttributeKey : Any] = [:]) -> Data?

Parameters

aRange

The range.

docAttributes

A required dictionary specifying the document attributes. The dictionary contains values from Document Types and must at least contain documentType.

Return Value

A data object containing an RTF stream for the attributed string.

Discussion

Writes the document-level attributes in docAttributes, as explained in RTF Files and Attributed Strings.

Raises an rangeException if any part of aRange lies beyond the end of the receiver’s characters.

When writing data to the pasteboard, you can use the NSData object as the first argument to the NSPasteboard method setData(_:forType:), with a second argument of NSRTFPboardType. Although this method strips attachments, it leaves the attachment characters in the text itself. The NSText method rtf(from:), on the other hand, does strip attachment characters when extracting RTF.

See Also

Generating Data

func data(from: NSRange, documentAttributes: [NSAttributedString.DocumentAttributeKey : Any] = [:])

Returns an data object that contains a text stream corresponding to the characters and attributes within the given range.

func fileWrapper(from: NSRange, documentAttributes: [NSAttributedString.DocumentAttributeKey : Any] = [:])

Returns an NSFileWrapper object that contains a text stream corresponding to the characters and attributes within the given range.

func docFormat(from: NSRange, documentAttributes: [NSAttributedString.DocumentAttributeKey : Any] = [:])

Returns a data object that contains a Microsoft Word–format stream corresponding to the characters and attributes within the specified range.

func rtfd(from: NSRange, documentAttributes: [NSAttributedString.DocumentAttributeKey : Any] = [:])

Returns an data object that contains an RTFD stream corresponding to the characters and attributes within the range.

func rtfdFileWrapper(from: NSRange, documentAttributes: [NSAttributedString.DocumentAttributeKey : Any] = [:])

Returns an NSFileWrapper object that contains an RTFD document corresponding to the characters and attributes within the given range.