Executes the specified block for each range of a particular attribute in the attributed string.
SDKs
- iOS 4.0+
- macOS 10.6+
- Mac Catalyst 13.0+Beta
- tvOS 9.0+
- watchOS 2.0+
Framework
- Foundation
Declaration
- (void)enumerateAttribute:(NSAttributedParameters
attrNameThe name of the attribute to enumerate.
enumerationRangeThe range over which the attribute values are enumerated.
optsThe options used by the enumeration. For possible values, see
NSAttributed.String Enumeration Options blockThe block to apply to ranges of the specified attribute in the attributed string.
The block takes three arguments:
- value
The value for the specified attribute.
- range
The range of the attribute value in the attributed string.
- stop
A reference to a Boolean value. The block can set the value to
YESwithin the block to stop further processing of the attributed string.
Discussion
If this method is called by an instance of NSMutable, 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.