如何在 UILabel 中找到文本子字符串的 CGRect？

Question

对于给定的NSRange，我想在UILabel 中找到与NSRange 的字形相对应的CGRect。例如，我想在“The quick brown fox jumps over the lazy dog”这句话中找到包含“dog”一词的CGRect。

诀窍是，UILabel 有多行，而文字确实是attributedText，所以要找到字符串的确切位置有点困难。

我想在我的 UILabel 子类上编写的方法如下所示：

 - (CGRect)rectForSubstringWithRange:(NSRange)range;

---

详情，有兴趣的朋友：

我的目标是能够创建一个具有 UILabel 确切外观和位置的新 UILabel，然后我可以制作动画。我已经弄清楚了其余的，但它是尤其是这一步，现在让我退缩了。

到目前为止，我为尝试解决问题所做的工作：

• 我希望在 iOS 7 中会有一些 Text Kit 可以解决这个问题，但我看到的大多数 Text Kit 示例都集中在 UITextView 和 UITextField，而不是UILabel。
• 我在这里看到 Stack Overflow 上的另一个问题，该问题有望解决问题，但接受的答案已有两年多的历史，而且代码在属性文本上表现不佳。

我敢打赌，这个问题的正确答案涉及以下之一：

• 使用标准文本工具包方法在一行代码中解决此问题。我敢打赌它会涉及NSLayoutManager 和textContainerForGlyphAtIndex:effectiveRange
• 编写一个复杂的方法，将 UILabel 分成几行，并在一行中找到一个字形的矩形，很可能使用 Core Text 方法。我目前最好的选择是拆开 @mattt's 优秀的 TTTAttributedLabel，它有一种方法可以在某个点找到一个字形 - 如果我将其反转，并找到一个字形的点，那可能会奏效。

---

更新：这里有一个 github 要点，其中包含我迄今为止尝试解决此问题的三件事：https://gist.github.com/bryanjclark/7036101

Answer 1

我不热衷于将范围作为参数提供，因为我很懒。我宁愿让方法为我找到范围。考虑到这一点，我对上面的NoodleOfDeath's answer 进行了改编，以将String 作为参数。

extension String {
    func nsRange(of substring: String) -> NSRange? {
        // Get the swift range
        guard let range = range(of: substring) else { return nil }

        // Get the distance to the start of the substring
        let start = distance(from: startIndex, to: range.lowerBound) as Int
        //Get the distance to the end of the substring
        let end = distance(from: startIndex, to: range.upperBound) as Int

        //length = endOfSubstring - startOfSubstring
        //start = startOfSubstring
        return NSMakeRange(start, end - start)
    }
}


extension UILabel {
    /// Finds the bounding rect of a substring in a `UILabel`
    /// - Parameter substring: The substring whose bounding box you'd like to determine
    /// - Returns: An optional `CGRect`
    func boundingRect(for substring: String) -> CGRect? {
        guard let attributedText = attributedText,
              let text = self.text,
              let range: NSRange = text.nsRange(of: substring) else {
            return nil
        }

        let textStorage = NSTextStorage(attributedString: attributedText)
        let layoutManager = NSLayoutManager()
        textStorage.addLayoutManager(layoutManager)
        let textContainer = NSTextContainer(size: bounds.size)
        textContainer.lineFragmentPadding = 0.0
        layoutManager.addTextContainer(textContainer)
        var glyphRange = NSRange()
        layoutManager.characterRange(forGlyphRange: range, actualGlyphRange: &glyphRange)

        return layoutManager.boundingRect(forGlyphRange: glyphRange, in: textContainer)
    }
}

Answer 2

正确的答案是你实际上不能。这里的大多数解决方案都试图以不同的精度重新创建UILabel 内部行为。碰巧的是，在最近的 iOS 版本中，UILabel 使用 TextKit/CoreText 框架呈现文本。在早期版本中，它实际上在底层使用了 WebKit。谁知道它将来会用什么。即使是现在，使用 TextKit 进行复制也存在明显的问题（不是在谈论面向未来的解决方案）。我们不太清楚（或不能保证）文本布局和渲染是如何实际执行的，即使用了哪些参数——只要看看提到的所有边缘情况。对于您测试的一些简单案例，某些解决方案可能会“意外地”为您工作——即使在当前版本的 iOS 中也不能保证任何事情。文本渲染很难，不要让我开始 RTL 支持、动态类型、表情符号等。

如果您需要适当的解决方案，请不要使用UILabel。它是一个简单的组件，而且它的 TextKit 内部没有暴露在 API 中这一事实清楚地表明 Apple 不希望开发人员构建依赖于这个实现细节的解决方案。

您也可以使用 UITextView。它方便地公开了它的 TextKit 内部结构，并且非常可配置，因此您几乎可以实现 UILabel 的所有优点。

你也可以直接使用 TextKit （或者使用 CoreText 甚至更低）。很有可能，如果您确实需要查找文本位置，您可能很快就会需要这些框架中提供的其他强大工具。一开始它们很难使用，但我觉得大部分复杂性来自于实际学习文本布局和渲染的工作原理——这是一项非常相关和有用的技能。一旦您熟悉了 Apple 出色的文本框架，您就会感到自己有权在文本方面做更多事情。

Answer 3

swift 4 解决方案，甚至适用于多行字符串，边界已替换为intrinsicContentSize

extension UILabel {
func boundingRectForCharacterRange(range: NSRange) -> CGRect? {

    guard let attributedText = attributedText else { return nil }

    let textStorage = NSTextStorage(attributedString: attributedText)
    let layoutManager = NSLayoutManager()

    textStorage.addLayoutManager(layoutManager)

    let textContainer = NSTextContainer(size: intrinsicContentSize)

    textContainer.lineFragmentPadding = 0.0

    layoutManager.addTextContainer(textContainer)

    var glyphRange = NSRange()

    layoutManager.characterRange(forGlyphRange: range, actualGlyphRange: &glyphRange)

    return layoutManager.boundingRect(forGlyphRange: glyphRange, in: textContainer)
}
}

Answer 4

以Luke Rogers's answer 为基础，但用 swift 编写：

斯威夫特 2

extension UILabel {
    func boundingRectForCharacterRange(_ range: NSRange) -> CGRect? {

        guard let attributedText = attributedText else { return nil }

        let textStorage = NSTextStorage(attributedString: attributedText)
        let layoutManager = NSLayoutManager()

        textStorage.addLayoutManager(layoutManager)

        let textContainer = NSTextContainer(size: bounds.size)
        textContainer.lineFragmentPadding = 0.0

        layoutManager.addTextContainer(textContainer)

        var glyphRange = NSRange()

        // Convert the range for glyphs.
        layoutManager.characterRangeForGlyphRange(range, actualGlyphRange: &glyphRange)

        return layoutManager.boundingRectForGlyphRange(glyphRange, inTextContainer: textContainer)        
    }
}

示例用法（Swift 2）

let label = UILabel()
let text = "aa bb cc"
label.attributedText = NSAttributedString(string: text)
let sublayer = CALayer()
sublayer.borderWidth = 1
sublayer.frame = label.boundingRectForCharacterRange(NSRange(text.range(of: "bb")!, in: text))
label.layer.addSublayer(sublayer)

斯威夫特 3/4

extension UILabel {
    func boundingRect(forCharacterRange range: NSRange) -> CGRect? {

        guard let attributedText = attributedText else { return nil }

        let textStorage = NSTextStorage(attributedString: attributedText)
        let layoutManager = NSLayoutManager()

        textStorage.addLayoutManager(layoutManager)

        let textContainer = NSTextContainer(size: bounds.size)
        textContainer.lineFragmentPadding = 0.0

        layoutManager.addTextContainer(textContainer)

        var glyphRange = NSRange()

        // Convert the range for glyphs.
        layoutManager.characterRange(forGlyphRange: range, actualGlyphRange: &glyphRange)

        return layoutManager.boundingRect(forGlyphRange: glyphRange, in: textContainer)       
    }
}

示例用法（Swift 3/4）

let label = UILabel()
let text = "aa bb cc"
label.attributedText = NSAttributedString(string: text)
let sublayer = CALayer()
sublayer.borderWidth = 1
sublayer.frame = label.boundingRect(forCharacterRange: NSRange(text.range(of: "bb")!, in: text))
label.layer.addSublayer(sublayer)

Answer 5

另一种方法是，如果您启用了自动字体大小调整，则如下所示：

let stringLength: Int = countElements(self.attributedText!.string)
let substring = (self.attributedText!.string as NSString).substringWithRange(substringRange)

//First, confirm that the range is within the size of the attributed label
if (substringRange.location + substringRange.length  > stringLength)
{
    return CGRectZero
}

//Second, get the rect of the label as a whole.
let textRect: CGRect = self.textRectForBounds(self.bounds, limitedToNumberOfLines: self.numberOfLines)

let path: CGMutablePathRef = CGPathCreateMutable()
CGPathAddRect(path, nil, textRect)
let framesetter = CTFramesetterCreateWithAttributedString(self.attributedText)
let tempFrame: CTFrameRef = CTFramesetterCreateFrame(framesetter, CFRangeMake(0, stringLength), path, nil)
if (CFArrayGetCount(CTFrameGetLines(tempFrame)) == 0)
{
    return CGRectZero
}

let lines: CFArrayRef = CTFrameGetLines(tempFrame)
let numberOfLines: Int = self.numberOfLines > 0 ? min(self.numberOfLines, CFArrayGetCount(lines)) :  CFArrayGetCount(lines)
if (numberOfLines == 0)
{
    return CGRectZero
}

var returnRect: CGRect = CGRectZero

let nsLinesArray: NSArray = CTFrameGetLines(tempFrame) // Use NSArray to bridge to Array
let ctLinesArray = nsLinesArray as Array
var lineOriginsArray = [CGPoint](count:ctLinesArray.count, repeatedValue: CGPointZero)

CTFrameGetLineOrigins(tempFrame, CFRangeMake(0, numberOfLines), &lineOriginsArray)

for (var lineIndex: CFIndex = 0; lineIndex < numberOfLines; lineIndex++)
{
    let lineOrigin: CGPoint = lineOriginsArray[lineIndex]
    let line: CTLineRef = unsafeBitCast(CFArrayGetValueAtIndex(lines, lineIndex), CTLineRef.self) //CFArrayGetValueAtIndex(lines, lineIndex) 
    let lineRange: CFRange = CTLineGetStringRange(line)

    if ((lineRange.location <= substringRange.location) && (lineRange.location + lineRange.length >= substringRange.location + substringRange.length))
    {
        var charIndex: CFIndex = substringRange.location - lineRange.location; // That's the relative location of the line
        var secondary: CGFloat = 0.0
        let xOffset: CGFloat = CTLineGetOffsetForStringIndex(line, charIndex, &secondary);

        // Get bounding information of line

        var ascent: CGFloat = 0.0
        var descent: CGFloat = 0.0
        var leading: CGFloat = 0.0

        let width: Double = CTLineGetTypographicBounds(line, &ascent, &descent, &leading)
        let yMin: CGFloat = floor(lineOrigin.y - descent);
        let yMax: CGFloat = ceil(lineOrigin.y + ascent);

        let yOffset: CGFloat = ((yMax - yMin) * CGFloat(lineIndex))

        returnRect = (substring as NSString).boundingRect(with: CGSize(width: Double.greatestFiniteMagnitude, height: Double.greatestFiniteMagnitude), options: .usesLineFragmentOrigin, attributes: [.font: self.font ?? UIFont.systemFont(ofSize: 1)], context: nil)
        returnRect.origin.x = xOffset + self.frame.origin.x
        returnRect.origin.y = yOffset + self.frame.origin.y + ((self.frame.size.height - textRect.size.height) / 2)

        break
    }
}

return returnRect

Answer 6

对于正在寻找plain text 扩展的任何人！

extension UILabel {    
    func boundingRectForCharacterRange(range: NSRange) -> CGRect? {
        guard let text = text else { return nil }

        let textStorage = NSTextStorage.init(string: text)
        let layoutManager = NSLayoutManager()

        textStorage.addLayoutManager(layoutManager)

        let textContainer = NSTextContainer(size: bounds.size)
        textContainer.lineFragmentPadding = 0.0

        layoutManager.addTextContainer(textContainer)

        var glyphRange = NSRange()

        // Convert the range for glyphs.
        layoutManager.characterRange(forGlyphRange: range, actualGlyphRange: &glyphRange)

        return layoutManager.boundingRect(forGlyphRange: glyphRange, in: textContainer)
    }
}

_{附注Noodle of Death`s answer的更新答案。}

Answer 7

在代码中遵循Joshua's answer，我想出了以下似乎运行良好的方法：

- (CGRect)boundingRectForCharacterRange:(NSRange)range
{
    NSTextStorage *textStorage = [[NSTextStorage alloc] initWithAttributedString:[self attributedText]];
    NSLayoutManager *layoutManager = [[NSLayoutManager alloc] init];
    [textStorage addLayoutManager:layoutManager];
    NSTextContainer *textContainer = [[NSTextContainer alloc] initWithSize:[self bounds].size];
    textContainer.lineFragmentPadding = 0;
    [layoutManager addTextContainer:textContainer];

    NSRange glyphRange;

    // Convert the range for glyphs.
    [layoutManager characterRangeForGlyphRange:range actualGlyphRange:&glyphRange];

    return [layoutManager boundingRectForGlyphRange:glyphRange inTextContainer:textContainer];
}

Answer 8

我的建议是使用 Text Kit。不幸的是，我们无法访问UILabel 使用的布局管理器，但是可以创建它的副本并使用它来获取范围的矩形。

我的建议是创建一个 NSTextStorage 对象，其中包含与标签中完全相同的属性文本。接下来创建一个NSLayoutManager 并将其添加到文本存储对象中。最后创建一个与标签大小相同的NSTextContainer，并将其添加到布局管理器中。

现在文本存储与标签具有相同的文本，并且文本容器与标签的大小相同，因此我们应该能够使用 boundingRectForGlyphRange:inTextContainer: 向我们创建的布局管理器请求我们的范围的矩形。确保首先在布局管理器对象上使用 glyphRangeForCharacterRange:actualCharacterRange: 将字符范围转换为字形范围。

一切顺利，您应该在标签内指定范围的边界 CGRect。

我还没有对此进行测试，但这将是我的方法，并且通过模仿 UILabel 本身的工作方式应该很有可能成功。

Answer 9

你能把你的类建立在 UITextView 上吗？如果是这样，请查看 UiTextInput 协议方法。尤其参见几何和击球休息方法。