查找(Find)

查找对象 Find，是代表查找操作的执行条件

方法列表

方法	返回类型	说明
Execute()	无	搜索并高亮文本
ClearHighlight()	无	取消结果高亮
ReplaceTextAll()	Boolean	全量替换查找到的内容

Execute()

搜索并高亮文本

语法

表达式.ActiveDocument.Find.Execute({searchString, options})

参数

属性	类型	默认值	必填	说明
searchString	String		是	查找文本
options	Options{}		否
options.showHighlight	Boolean	true	否	是否高亮显示搜索结果

示例

async function example() {
  await jssdk.ready();

  const app = jssdk.Application;

  // 搜索并高亮 “明日”
  await app.ActiveDocument.Find.Execute({
    searchString: '明日', 
    options: {
        showHighlight: true
    }
  })
}

ClearHighlight()

取消结果高亮

语法

表达式.ActiveDocument.Find.ClearHighlight()

示例

async function example() {
  await jssdk.ready();

  const app = jssdk.Application;

  // 取消结果高亮
  await app.ActiveDocument.Find.ClearHighlight()
}

ReplaceTextAll()

全量替换查找到的内容

语法

表达式.ActiveDocument.Find.ReplaceTextAll({searchString, replaceString, options})

参数

属性	类型	默认值	必填	说明
searchString	String		是	查找文本
replaceString	String		是	替换为的文本
options	Options{}		否
options.matchCase	Boolean	false	否	匹配大小写

返回值

返回 Boolean 代表是否替换成功。

IMPORTANT

此API在多人协同场景下不支持，调用返回结果是 false

示例

async function example() {
  await jssdk.ready();

  const app = jssdk.Application;

  // 全量替换
  const result = await app.ActiveDocument.Find.ReplaceTextAll({
    searchString: '明日', 
    replaceString: '后日', 
    options: {
        matchCase: false
    }
  })

  console.log('替换结果为', result);
}