Instance Method

enumerateAttributes(in:options:using:)

Executes the specified closure for each range of attributes in the attributed string.

Declaration

func enumerateAttributes(in enumerationRange: NSRange, options opts: NSAttributedString.EnumerationOptions = [], using block: ([NSAttributedString.Key : Any], NSRange, UnsafeMutablePointer<ObjCBool>) -> Void)

Parameters

enumerationRange

The range over which the attributes are enumerated.

opts

The options used by the enumeration. For possible values, see NSAttributedString.EnumerationOptions.

block

The closure to apply to ranges of attributes in the attributed string.

The closure takes three arguments:

  • A dictionary of attribute values keyed by name.

  • The range of the attribute values in the attributed string.

  • A reference to a Boolean value, which you can set to true within the closure to stop further processing of the attributed string.

Discussion

If this method is called by an instance of NSMutableAttributedString, mutation (deletion, addition, or change) is allowed only if the mutation is within the range provided to the block. After a mutation, the enumeration continues with the range immediately following the processed range, adjusting for any change in length caused by the mutation. For example, if block is called with a range starting at location N, and the block deletes all the characters in the provided range, the next call will also pass N as the location of the range.

See Also

Enumerating over Attributes in a String