fsdk.TextSearch类 参考

Public 成员函数
def	FindNext ()
	搜索下一个匹配的模式。 更多...
def	FindPrev ()
	搜索上一个匹配的模式。 更多...
def	GetMatchEndCharIndex ()
	基于当前匹配页面，获取当前匹配模式最后一个字符的索引。 更多...
def	GetMatchPageIndex ()
	获取当前匹配所属的页面索引。 更多...
def	GetMatchRects ()
	获取当前匹配模式的矩形。 更多...
def	GetMatchSentence ()
	获取包含当前匹配模式的句子。 更多...
def	GetMatchSentenceEndIndex ()
	基于匹配句子，获取当前匹配模式最后一个字符的索引。 更多...
def	GetMatchSentenceStartIndex ()
	基于匹配句子，获取当前匹配模式第一个字符的索引。 更多...
def	GetMatchStartCharIndex ()
	基于当前匹配页面，获取当前匹配模式第一个字符的索引。 更多...
def	IsEmpty ()
	检查当前对象是否为空。 更多...
def	SetEndPage (page_index)
	设置结束页面索引。 更多...
def	SetPattern (key_words, is_regex_search)
	设置要搜索的关键词。 更多...
def	SetSearchFlags (search_flags)
	设置搜索标志。 更多...
def	SetStartCharacter (char_index)
	设置起始字符索引，搜索过程从该位置开始。 更多...
def	SetStartPage (page_index)
	设置起始页面索引。 更多...

详细描述

此类可以在PDF文档/XFA文档/文本页面或PDF注释的外观中构造文本搜索。 它提供进行文本搜索和获取搜索结果的函数：

• 要指定搜索模式和选项，请使用函数 fsdk.TextSearch.SetPattern 、 fsdk.TextSearch.SetStartPage 、fsdk.TextSearch.SetEndPage 和 fsdk.TextSearch.SetSearchFlags 。

• 要进行搜索，请使用函数 fsdk.TextSearch.FindNext 或 fsdk.TextSearch.FindPrev 。

• 要获取搜索结果，请使用GetMatchXXX()函数。

成员函数说明

FindNext()

def fsdk.TextSearch.FindNext

(

)

搜索下一个匹配的模式。

返回

true 表示找到下一个匹配，false 表示找不到下一个匹配或 发生其他错误。

FindPrev()

def fsdk.TextSearch.FindPrev

(

)

搜索上一个匹配的模式。

返回

true 表示找到上一个匹配，false 表示找不到上一个匹配或 发生其他错误。

GetMatchEndCharIndex()

def fsdk.TextSearch.GetMatchEndCharIndex

(

)

基于当前匹配页面，获取当前匹配模式最后一个字符的索引。

返回

当前匹配页面中最后一个字符的索引，从0开始。 -1表示未找到匹配的句子。

GetMatchPageIndex()

def fsdk.TextSearch.GetMatchPageIndex

(

)

获取当前匹配所属的页面索引。

此函数只能用于PDF文档或XFA文档中的文本搜索。

返回

包含当前匹配的页面索引，从0开始。 -1表示未找到匹配的模式。

GetMatchRects()

def fsdk.TextSearch.GetMatchRects

(

)

获取当前匹配模式的矩形。

返回

矩形数组。

GetMatchSentence()

def fsdk.TextSearch.GetMatchSentence

(

)

获取包含当前匹配模式的句子。

返回

包含当前匹配的句子内容。

GetMatchSentenceEndIndex()

def fsdk.TextSearch.GetMatchSentenceEndIndex

(

)

基于匹配句子，获取当前匹配模式最后一个字符的索引。

在一个句子中，可能有超过2个匹配模式。此函数与函数 一起， 可以帮助确认句子中的哪个模式就是当前匹配的模式。

返回

基于匹配句子的当前匹配模式最后一个字符的索引，从0开始。 -1表示未找到匹配的句子。

GetMatchSentenceStartIndex()

def fsdk.TextSearch.GetMatchSentenceStartIndex

(

)

基于匹配句子，获取当前匹配模式第一个字符的索引。

在一个句子中，可能有超过2个匹配模式。此函数与函数 一起， 可以帮助确认句子中的哪个模式就是当前匹配的模式。

返回

基于匹配句子的当前匹配模式第一个字符的索引，从0开始。 -1表示未找到匹配的句子。

GetMatchStartCharIndex()

def fsdk.TextSearch.GetMatchStartCharIndex

(

)

基于当前匹配页面，获取当前匹配模式第一个字符的索引。

返回

当前匹配页面中第一个字符的索引，从0开始。 -1表示未找到匹配的句子。

IsEmpty()

def fsdk.TextSearch.IsEmpty

(

)

检查当前对象是否为空。

当前对象为空时，意味着当前对象无用。

返回

true 表示当前对象为空，false 表示不为空。

SetEndPage()

def fsdk.TextSearch.SetEndPage

(

page_index

)

设置结束页面索引。

此函数只能用于使用 PDFDoc 对象或 fsdk.XFADoc 对象 构造的文本搜索对象。对于其他情况，此函数将抛出异常 fsdk.E_ErrUnsupported 。
如果不调用此函数，默认值count-1将用作结束页面索引。

参数

[in]

page_index

搜索结束的页面索引。 有效范围：从0到(count-1)。count 由函数 fsdk.PDFDoc.GetPageCount （对于PDF文档）或函数 fsdk.XFADoc.GetPageCount （对于XFA文档）返回。

返回

true 表示成功，false 表示失败。

SetPattern()

def fsdk.TextSearch.SetPattern	(		key_words,
			is_regex_search
	)

设置要搜索的关键词。

参数

[in]	key_words	要搜索的文本内容。它不应是空字符串。
[in]	is_regex_search	true 表示启用正则表达式搜索，false 表示不启用。 如果启用正则表达式搜索，函数 fsdk.TextSearch.SetSearchFlags 设置的搜索标志将被忽略。默认值：false。

返回

true 表示成功，false 表示失败。

SetSearchFlags()

def fsdk.TextSearch.SetSearchFlags

(

search_flags

)

设置搜索标志。

如果不调用此函数，将使用默认值 fsdk.TextSearchE_SearchNormal 。

参数

[in]

search_flags

搜索标志。请参考从 fsdk.TextSearchE_SearchNormal 开始的值， 这可以是这些值中的一个或组合。

返回

true 表示成功，false 表示失败。

SetStartCharacter()

def fsdk.TextSearch.SetStartCharacter

(

char_index

)

设置起始字符索引，搜索过程从该位置开始。

此函数只能用于使用 TextPage 对象或 PDFDoc 对象 构造的文本搜索对象。对于其他情况，此函数将抛出异常 fsdk.E_ErrUnsupported 。
如果不为新构造的文本搜索对象调用此函数， 将使用默认值作为起始字符索引：

• 对于由函数 fsdk.TextSearch.FindNext 开始的第一次搜索， 将使用0作为起始字符索引。

• 对于由函数 fsdk.TextSearch.FindPrev 开始的第一次搜索， 将使用(count-1)作为起始字符索引。

参数

[in]

char_index

搜索过程开始的起始字符索引。 有效范围：从0到(count-1)。count 表示搜索过程起始页面中的字符数量。

返回

true 表示成功，false 表示失败。

SetStartPage()

def fsdk.TextSearch.SetStartPage

(

page_index

)

设置起始页面索引。

此函数只能用于使用 PDFDoc 对象或 fsdk.XFADoc 对象 构造的文本搜索对象。对于其他情况，此函数将抛出异常 fsdk.E_ErrUnsupported 。
如果不调用此函数，默认值0将用作起始页面索引。

参数

[in]

page_index

搜索开始的页面索引。 有效范围：从0到(count-1)。count 由函数 fsdk.PDFDoc.GetPageCount （对于PDF文档）或函数 fsdk.XFADoc.GetPageCount （对于XFA文档）返回。

返回

true 表示成功，false 表示失败。