Find

Find

JSSDK: 1.3.3、FilezOffice V6.0 FP3 支持

代表查找操作的执行条件。

方法

findData

找到的所有匹配项，并返回匹配项数目或匹配项范围数组。

语法

Find.findData(findText, matchCase, matchWholeWord, options)

Find: 查找操作的执行条件对象。

参数

属性	数据类型	必填	说明
findText	string	是	要查找的文本
matchCase	boolean	否	是否区分大小写
matchWholeWord	boolean	否	是否全词匹配
options	object	否	可选配置项，见下方说明

options 参数说明

JSSDK: 1.9.6、FilezOffice v8.2 FP1 支持

属性	数据类型	必填	说明
resultType	Word.FindResultType	否	控制返回结果类型。Word.FindResultType.Count（默认）返回匹配数目；Word.FindResultType.Ranges 返回匹配项的 Range 数组

返回值

• 当 resultType 为 Word.FindResultType.Count 或未传 options 时：Promise<number>
• 当 resultType 为 Word.FindResultType.Ranges 时：Promise<Range[]>

示例

// 全文查找内容“文本“，全词匹配，返回匹配数目
async function example1() {
  const count = await Application.ActiveDocument.Content.Find.findData("文本", false, true);
}

// 在当前选区内查找内容“文本“，全词匹配
async function example2() {
  const range = await Application.ActiveDocument.getSelection();
  const count = await range.Find.findData("文本", false, true);
}

// 显式指定返回 count
async function example3() {
  const count = await Application.ActiveDocument.Content.Find.findData("text", false, false, { resultType: Word.FindResultType.Count });
  console.log(count);
}

// 返回匹配项的 Range 数组
async function example4() {
  const ranges = await Application.ActiveDocument.Content.Find.findData("text", false, false, { resultType: Word.FindResultType.Ranges });
  console.log(ranges);
}

clearHitHighlight

取消突出显示，并返回一个 boolean 类型的值 ，表示该操作是否成功。

语法

Find.clearHitHighlight()

Find: 查找操作的执行条件对象。

返回值

Promise<boolean>

示例

async function example1() {
  const success = await Application.ActiveDocument.Content.Find.clearHighlight();
}

execute

JSSDK: 1.5.2、FilezOffice V7.0 FP2支持

• 搜索并高亮文本

语法

Find.execute(findText, showHighlight)

Find: 查找操作的执行条件对象。

参数

属性	数据类型	必填	说明
findText	string	否	要搜索的文本
showHighlight	boolean	否	是否高亮显示搜索结果，默认true

返回值

Promise<boolean>

示例

// 搜索并高亮文本
async function example1() {
  const success = await Application.ActiveDocument.Content.Find.execute('FilezOffice', true);
  console.log('success:', success);
}