类 FSTextPage 继承关系图:
构造函数 | |
| (FSRotation) | - getBaselineRotation: |
| 获取指定矩形的文本趋势（作为旋转）。 更多... | |
| (int) | - getCharCount |
| 获取所有字符的数量。 更多... | |
| (FSTextPageCharInfo *) | - getCharInfo: |
| 获取特定字符的字符信息。 更多... | |
| (FSRange *) | - getCharRange: |
| 获取指定矩形区域内所有文本矩形的字符索引范围。 更多... | |
| (NSString *) | - getChars:count: |
| 获取由起始索引和数量指定范围内的所有字符。 更多... | |
| (int) | - getIndexAtPos:y:tolerance: |
| 获取页面上指定位置处或附近的字符索引， 在中。 更多... | |
| (NSString *) | - getText: |
| 获取页面文本。 更多... | |
| (NSString *) | - getTextInRect: |
| 获取矩形内的文本，在中。 更多... | |
| (FSRectF *) | - getTextRect: |
| 通过索引获取文本矩形。 更多... | |
| (FSRectFArray *) | - getTextRectArrayByRect: |
| 获取指定矩形区域内所有文本矩形的数组。 更多... | |
| (int) | - getTextRectCount:count: |
| 计算由起始索引和数量指定范围内的文本矩形。 更多... | |
| (NSString *) | - getTextUnderAnnot: |
| 获取与指定注释相交的页面文本。 更多... | |
| (FSRange *) | - getWordAtPos:y:tolerance: |
| 获取页面上指定位置处或附近单词的字符范围， 在中。 更多... | |
| (id) | - initWithOther: |
| 用另一个文本页面对象的构造函数。 更多... | |
| (id) | - initWithPage:flags: |
| 从已解析的PDF页面构造函数。 更多... | |
| (BOOL) | - isEmpty |
| 检查当前对象是否为空。 更多... | |
详细描述
PDF文本页面表示PDF页面中的所有文本内容，根据为这些文本指定的解析标志。 类 FSTextPage 可用于检索PDF页面中文本的信息，例如单个字符、单个单词、 指定字符范围或矩形内的文本内容等。
此类对象还可用于构造其他文本相关类的对象，以便对文本内容进行更多操作 或从文本内容访问指定信息：
-
要在PDF页面的文本内容中搜索文本，请使用文本页面对象构造 FSTextSearch 对象。
-
要访问用作超文本链接的文本，请使用文本页面对象构造 FSPageTextLinks 对象。
此类表示和OFD文本页面相关的方法。
函数文档
◆ getBaselineRotation:()
| - (FSRotation) getBaselineRotation: | (int) | rect_index |
获取指定矩形的文本趋势（作为旋转）。
- 参数
-
[in] rect_index 要检索的矩形的索引。 有效范围：从0到(count -1)。count 由函数 FSTextPage::getTextRectCount:count: 返回。
- 返回
- 文本趋势，作为旋转值。请参考从 FSRotation0 开始的值， 这将是这些值中的一个。
◆ getCharCount()
| - (int) getCharCount |
获取所有字符的数量。
- 返回
- 字符数量。
◆ getCharInfo:()
| - (FSTextPageCharInfo *) getCharInfo: | (int) | char_index |
获取特定字符的字符信息。
- 参数
-
[in] char_index 字符的从零开始的索引。 范围：从0到(charcount - 1)。charcount 由函数 FSTextPage::getCharCount 返回。
- 返回
- 由字符索引指定的字符的字符信息。
◆ getCharRange:()
获取指定矩形区域内所有文本矩形的字符索引范围。
- 参数
-
[in] rect 矩形区域，在中。
- 返回
- 指定矩形区域内所有文本矩形的字符索引范围。
◆ getChars:count:()
| - (NSString *) getChars: | (int) | start | |
| count: | (int) | count | |
获取由起始索引和数量指定范围内的所有字符。
- 参数
-
[in] start 起始字符的索引，它是期望文本内容的第一个字符。 有效范围：从0到(charcount -1)。charcount 由函数 FSTextPage::getCharCount 返回。默认值：0。
[in] count 要检索的字符数量。-1表示获取从start_index到PDF页面末尾的 所有字符。特别地，当参数count 大于(charcount - start)，将检索所有剩余字符 （从start_index开始）。charcount 由函数 FSTextPage::getCharCount 返回。默认值：-1。
- 返回
- 指定字符索引范围内的字符。
◆ getIndexAtPos:y:tolerance:()
| - (int) getIndexAtPos: | (float) | x | |
| y: | (float) | y | |
| tolerance: | (float) | tolerance | |
获取页面上指定位置处或附近的字符索引， 在中。
- 参数
-
[in] x x位置的值，在中。
[in] y y位置的值，在中。
[in] tolerance 字符命中检测的容差值，以点为单位。这不应为负数。
- 返回
- 位于或接近点(x,y)的字符索引，从0开始。特别地，如果在点(x, y)附近 有多个字符，将返回最小的字符索引。 如果在该点处或附近没有字符，将返回-1。
◆ getText:()
| - (NSString *) getText: | (FSTextPageTextOrderFlag) | flag |
获取页面文本。
- 参数
-
[in] flag 文本顺序标志，决定如何获取相关PDF页面的文本内容。请参考从 FSTextPageTextStreamOrder 开始的值，这应该是这些值中的一个。
- 返回
- 相关PDF页面的所有文本内容，按指定的文本顺序。
◆ getTextInRect:()
| - (NSString *) getTextInRect: | (FSRectF*) | rect |
获取矩形内的文本，在中。
- 参数
-
[in] rect 矩形区域，在中。
- 返回
- 指定矩形内的文本字符串。
◆ getTextRect:()
| - (FSRectF *) getTextRect: | (int) | rect_index |
通过索引获取文本矩形。
- 参数
-
[in] rect_index 要检索的矩形的索引。 有效范围：从0到(count -1)。count 由函数 FSTextPage::getTextRectCount:count: 返回。
- 返回
- 指定的文本矩形。
◆ getTextRectArrayByRect:()
| - (FSRectFArray *) getTextRectArrayByRect: | (FSRectF*) | rect |
获取指定矩形区域内所有文本矩形的数组。
- 参数
-
[in] rect 矩形区域，在中。
- 返回
- 指定矩形内的文本矩形数组。
◆ getTextRectCount:count:()
| - (int) getTextRectCount: | (int) | start | |
| count: | (int) | count | |
计算由起始索引和数量指定范围内的文本矩形。
- 参数
-
[in] start 字符索引范围中起始字符的索引。 有效范围：从0到(charcount -1)。charcount 由函数 FSTextPage::getCharCount 返回。
[in] count 字符索引范围中的字符数量。-1表示获取从start_index到PDF页面末尾的 所有字符。
- 返回
- 指定字符索引范围内的文本矩形数量。-1表示错误。
◆ getTextUnderAnnot:()
| - (NSString *) getTextUnderAnnot: | (FSAnnot*) | annot |
获取与指定注释相交的页面文本。
如果整个字符或字符的大部分与注释相交， 当前函数将检索此字符。
- 参数
-
[in] annot 注释。要检索与此注释相交的页面文本。 目前，仅支持文本标记注释 （高亮/下划线/删除线/波浪线注释）；对于其他类型的注释， 此函数将抛出异常 FSErrUnsupported 。
- 返回
- 与指定注释相交的文本。
◆ getWordAtPos:y:tolerance:()
| - (FSRange *) getWordAtPos: | (float) | x | |
| y: | (float) | y | |
| tolerance: | (float) | tolerance | |
获取页面上指定位置处或附近单词的字符范围， 在中。
目前，对于中文/日文/韩文，仅支持获取指定位置处或附近的单个字符。
- 参数
-
[in] x x位置的值，在中。
[in] y y位置的值，在中。
[in] tolerance 单词命中检测的容差值，以点为单位。这不应为负数。
- 返回
- 表示期望单词的字符范围。此范围对象中最多会有一个有效的范围段。 如果返回的范围对象为空，表示未找到此类单词。
◆ initWithOther:()
| - (id) initWithOther: | (FSTextPage*) | other |
用另一个文本页面对象的构造函数。
构造函数，通过另一个OFD文本页面对象。
- 参数
-
[in] other 另一个文本页面对象。
[in] other 另一个OFD文本页面对象。
◆ initWithPage:flags:()
| - (id) initWithPage: | (FSPDFPage*) | page | |
| flags: | (int) | flags | |
从已解析的PDF页面构造函数。
- 参数
-
[in] page 有效的PDF页面对象。此页面应已被解析。
[in] flags 文本页面的解析标志。请参考从 FSTextPageParseTextNormal 开始的值，这可以是这些值中的一个或组合。
◆ isEmpty()
| - (BOOL) isEmpty |
检查当前对象是否为空。
当前对象为空时，意味着当前对象无用。
- 返回
- YES 表示当前对象为空，NO 表示不为空。
当前对象为空时，表示当前对象是无用的。
- 返回
- YES 表示当前对象为空，NO 表示不为空。
