模式类型：矩形选择。
更多...
构造函数 | |
| (BOOL) | - findNext |
| 搜索下一个匹配的模式。 更多... | |
| (BOOL) | - findPrev |
| 搜索上一个匹配的模式。 更多... | |
| (int) | - getMatchEndCharIndex |
| 基于当前匹配页面，获取当前匹配模式最后一个字符的索引。 更多... | |
| (int) | - getMatchPageIndex |
| 获取当前匹配所属的页面索引。 更多... | |
| (FSRectFArray *) | - getMatchRects |
| 获取当前匹配模式的矩形。 更多... | |
| (NSString *) | - getMatchSentence |
| 获取包含当前匹配模式的句子。 更多... | |
| (int) | - getMatchSentenceEndIndex |
| 基于匹配句子，获取当前匹配模式最后一个字符的索引。 更多... | |
| (int) | - getMatchSentenceStartIndex |
| 基于匹配句子，获取当前匹配模式第一个字符的索引。 更多... | |
| (int) | - getMatchStartCharIndex |
| 基于当前匹配页面，获取当前匹配模式第一个字符的索引。 更多... | |
| (id) | - initWithAnnot: |
| 对于指定PDF注释的构造函数。 更多... | |
| (id) | - initWithDocument:cancel:flags: |
| 对于PDF文档的构造函数。 更多... | |
| (id) | - initWithOther: |
| 用另一个文本搜索对象的构造函数。 更多... | |
| (id) | - initWithText_page: |
| 对于指定文本页面的构造函数。 更多... | |
| (id) | - initWithXfa_document:cancel: |
| 对于指定XFA文档的构造函数。 更多... | |
| (BOOL) | - isEmpty |
| 检查当前对象是否为空。 更多... | |
| (BOOL) | - setEndPage: |
| 设置结束页面索引。 更多... | |
| (BOOL) | - setPattern:is_regex_search: |
| 设置要搜索的关键词。 更多... | |
| (BOOL) | - setSearchFlags: |
| 设置搜索标志。 更多... | |
| (BOOL) | - setStartCharacter: |
| 设置起始字符索引，搜索过程从该位置开始。 更多... | |
| (BOOL) | - setStartPage: |
| 设置起始页面索引。 更多... | |
详细描述
模式类型：矩形选择。
模式类型：段落选择。
此类可以在PDF文档/XFA文档/文本页面或PDF注释的外观中构造文本搜索。 它提供进行文本搜索和获取搜索结果的函数：
-
要指定搜索模式和选项，请使用函数 FSTextSearch::setPattern:is_regex_search: 、 FSTextSearch::setStartPage: 、 FSTextSearch::setEndPage: 和 FSTextSearch::setSearchFlags: 。
-
要进行搜索，请使用函数 FSTextSearch::findNext 或 FSTextSearch::findPrev 。
-
要获取搜索结果，请使用GetMatchXXX()函数。
此类表示OFD文本搜索相关的方法。
函数文档
◆ findNext()
| - (BOOL) findNext |
搜索下一个匹配的模式。
- 返回
- YES 表示找到下一个匹配，NO 表示找不到下一个匹配或 发生其他错误。
◆ findPrev()
| - (BOOL) findPrev |
搜索上一个匹配的模式。
- 返回
- YES 表示找到上一个匹配，NO 表示找不到上一个匹配或 发生其他错误。
◆ getMatchEndCharIndex()
| - (int) getMatchEndCharIndex |
基于当前匹配页面，获取当前匹配模式最后一个字符的索引。
- 返回
- 当前匹配页面中最后一个字符的索引，从0开始。 -1表示未找到匹配的句子。
◆ getMatchPageIndex()
| - (int) getMatchPageIndex |
获取当前匹配所属的页面索引。
此函数只能用于PDF文档或XFA文档中的文本搜索。
- 返回
- 包含当前匹配的页面索引，从0开始。 -1表示未找到匹配的模式。
◆ getMatchRects()
| - (FSRectFArray *) getMatchRects |
获取当前匹配模式的矩形。
- 返回
- 矩形数组。
◆ getMatchSentence()
| - (NSString *) getMatchSentence |
获取包含当前匹配模式的句子。
- 返回
- 包含当前匹配的句子内容。
◆ getMatchSentenceEndIndex()
| - (int) getMatchSentenceEndIndex |
基于匹配句子，获取当前匹配模式最后一个字符的索引。
在一个句子中，可能有超过2个匹配模式。此函数与函数 一起， 可以帮助确认句子中的哪个模式就是当前匹配的模式。
- 返回
- 基于匹配句子的当前匹配模式最后一个字符的索引，从0开始。 -1表示未找到匹配的句子。
◆ getMatchSentenceStartIndex()
| - (int) getMatchSentenceStartIndex |
基于匹配句子，获取当前匹配模式第一个字符的索引。
在一个句子中，可能有超过2个匹配模式。此函数与函数 一起， 可以帮助确认句子中的哪个模式就是当前匹配的模式。
- 返回
- 基于匹配句子的当前匹配模式第一个字符的索引，从0开始。 -1表示未找到匹配的句子。
◆ getMatchStartCharIndex()
| - (int) getMatchStartCharIndex |
基于当前匹配页面，获取当前匹配模式第一个字符的索引。
- 返回
- 当前匹配页面中第一个字符的索引，从0开始。 -1表示未找到匹配的句子。
◆ initWithAnnot:()
| - (id) initWithAnnot: | (FSAnnot*) | annot |
对于指定PDF注释的构造函数。
目前，仅支持在以下注释类型的外观中搜索： 自由文本注释、印章注释、小部件注释和线条注释。
- 参数
-
[in] annot 有效的注释对象。
◆ initWithDocument:cancel:flags:()
| - (id) initWithDocument: | (FSPDFDoc*) | document | |
| cancel: | (id<FSSearchCancelCallback>) | cancel | |
| flags: | (int) | flags | |
对于PDF文档的构造函数。
用户可以设置有效的 对象，以便在触发 SearchCancelCallback中的回调函数时决定是否取消搜索过程。
- 参数
-
[in] document 有效的PDF文档对象。
[in] cancel 对象，决定在触发回调函数时 是否需要取消搜索过程。这可以是 nil，表示不取消搜索过程。 如果不是 nil，应该是用户实现的有效 对象。默认值：nil。
[in] flags 搜索期间用于解析文本的解析标志。请参考从 FSTextPageParseTextNormal 开始的值，这可以是这些值中的一个或组合。
默认值： FSTextPageParseTextNormal 。
◆ initWithOther:()
| - (id) initWithOther: | (FSTextSearch*) | other |
用另一个文本搜索对象的构造函数。
构造函数，通过另一个文本搜索对象。
- 参数
-
[in] other 另一个文本搜索对象。
◆ initWithText_page:()
| - (id) initWithText_page: | (FSTextPage*) | text_page |
对于指定文本页面的构造函数。
- 参数
-
[in] text_page 文本页面对象。
◆ initWithXfa_document:cancel:()
| - (id) initWithXfa_document: | (FSXFADoc*) | xfa_document | |
| cancel: | (id<FSSearchCancelCallback>) | cancel | |
对于指定XFA文档的构造函数。
- 参数
-
[in] xfa_document 有效的XFA文档对象。它应该已经通过 函数 FSXFADoc::startLoad: 加载。
[in] cancel 对象，决定在触发回调函数时 是否需要取消搜索过程。这可以是 nil， 表示不取消搜索过程。如果不是 nil， 应该是用户实现的有效 对象。 默认值：nil。
◆ isEmpty()
| - (BOOL) isEmpty |
检查当前对象是否为空。
当前对象为空时，意味着当前对象无用。
- 返回
- YES 表示当前对象为空，NO 表示不为空。
当前对象为空时，表示当前对象是无用的。
- 返回
- YES 表示当前对象为空，NO 表示不为空。
◆ setEndPage:()
| - (BOOL) setEndPage: | (int) | page_index |
设置结束页面索引。
此函数只能用于使用 FSPDFDoc 对象或 FSXFADoc 对象 构造的文本搜索对象。对于其他情况，此函数将抛出异常 FSErrUnsupported 。
如果不调用此函数，默认值count-1将用作结束页面索引。
- 参数
-
[in] page_index 搜索结束的页面索引。 有效范围：从0到(count-1)。count 由函数 FSPDFDoc::getPageCount （对于PDF文档）或函数 FSXFADoc::getPageCount （对于XFA文档）返回。
- 返回
- YES 表示成功，NO 表示失败。
◆ setPattern:is_regex_search:()
| - (BOOL) setPattern: | (NSString *) | key_words | |
| is_regex_search: | (BOOL) | is_regex_search | |
设置要搜索的关键词。
- 参数
-
[in] key_words 要搜索的文本内容。它不应是空字符串。
[in] is_regex_search YES 表示启用正则表达式搜索，NO 表示不启用。 如果启用正则表达式搜索，函数 FSTextSearch::setSearchFlags: 设置的搜索标志将被忽略。默认值：NO。
- 返回
- YES 表示成功，NO 表示失败。
◆ setSearchFlags:()
| - (BOOL) setSearchFlags: | (unsigned int) | search_flags |
设置搜索标志。
如果不调用此函数，将使用默认值 FSTextSearchSearchNormal 。
- 参数
-
[in] search_flags 搜索标志。请参考从 FSTextSearchSearchNormal 开始的值， 这可以是这些值中的一个或组合。
- 返回
- YES 表示成功，NO 表示失败。
◆ setStartCharacter:()
| - (BOOL) setStartCharacter: | (int) | char_index |
设置起始字符索引，搜索过程从该位置开始。
此函数只能用于使用 FSTextPage 对象或 FSPDFDoc 对象 构造的文本搜索对象。对于其他情况，此函数将抛出异常 FSErrUnsupported 。
如果不为新构造的文本搜索对象调用此函数， 将使用默认值作为起始字符索引：
-
对于由函数 FSTextSearch::findNext 开始的第一次搜索， 将使用0作为起始字符索引。
-
对于由函数 FSTextSearch::findPrev 开始的第一次搜索， 将使用(count-1)作为起始字符索引。
- 参数
-
[in] char_index 搜索过程开始的起始字符索引。 有效范围：从0到(count-1)。count 表示搜索过程起始页面中的字符数量。
- 返回
- YES 表示成功，NO 表示失败。
◆ setStartPage:()
| - (BOOL) setStartPage: | (int) | page_index |
设置起始页面索引。
此函数只能用于使用 FSPDFDoc 对象或 FSXFADoc 对象 构造的文本搜索对象。对于其他情况，此函数将抛出异常 FSErrUnsupported 。
如果不调用此函数，默认值0将用作起始页面索引。
- 参数
-
[in] page_index 搜索开始的页面索引。 有效范围：从0到(count-1)。count 由函数 FSPDFDoc::getPageCount （对于PDF文档）或函数 FSXFADoc::getPageCount （对于XFA文档）返回。
- 返回
- YES 表示成功，NO 表示失败。
