offset(from:to:)
Returns the number of characters between the specified locations.
Declaration
func offset(from: any NSTextLocation, to: any NSTextLocation) -> IntParameters
- from:
The starting location in the text storage. For example, you might specify the beginning of the document as the starting location.
- to:
The end location in the text storage.
Return Value
The number of characters between the start and end locations. If the to location comes before the from location, the returned value is negative.
Discussion
You can get NSTextLocation objects for the start and end of the text storage from the documentRange property of the NSTextElementProvider protocol, which NSTextContentStorage implements. If you provide an NSTextLocation object doesn’t match the type of the ones in the documentRange property, this method throws an exception.