使用Word加载项中的搜索选项查找文本

加载项经常需要基于文档文本运行。 每个内容控件都会公开搜索方法， (这包括 Body、Paragraph、Range、Table、TableRow 和基 ContentControl 对象) 。 此方法采用字符串 (或通配符表达式，) 表示要搜索的文本和 SearchOptions 对象。 它返回与搜索文本匹配的区域集合。

搜索选项

搜索选项为多个用于定义搜索参数处理方式的布尔值集合。

搜索特殊字符

下表列出了某些特殊字符的搜索表示法。

通配符指导

下表提供了与 Word JavaScript API 的搜索通配符相关的指导。

转义特殊字符

通配符搜索实质上与在正则表达式上搜索相同。 正则表达式中存在特殊字符，包括“[”、“]”、“ (”、“) ”、“{”、“}”、“*”、“？”、“<”、“”、“”、“>！”、“@”。 如果其中一个字符是代码要搜索的文本字符串的一部分，则需要对其进行转义，以便Word知道应该按字面量处理它，而不是正则表达式逻辑的一部分。 若要转义Word UI 搜索中的字符，请在该字符前面加上反斜杠字符 ('\') ，但若要以编程方式转义字符，请将其置于“[]”字符之间。 例如，“[*]*”搜索以“*”开头、后跟任意数量的其他字符的任何字符串。

示例

下面示例演示常见情况。

忽略标点符号搜索

// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Queue a command to search the document and ignore punctuation.
    const searchResults = context.document.body.search('video you', {ignorePunct: true});

    // Queue a command to load the font property values.
    searchResults.load('font');

    // Synchronize the document state.
    await context.sync();
    console.log('Found count: ' + searchResults.items.length);

    // Queue a set of commands to change the font for each found item.
    for (let i = 0; i < searchResults.items.length; i++) {
        searchResults.items[i].font.color = 'purple';
        searchResults.items[i].font.highlightColor = '#FFFF00'; //Yellow
        searchResults.items[i].font.bold = true;
    }

    // Synchronize the document state.
    await context.sync();
});

基于前缀搜索

// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Queue a command to search the document based on a prefix.
    const searchResults = context.document.body.search('vid', {matchPrefix: true});

    // Queue a command to load the font property values.
    searchResults.load('font');

    // Synchronize the document state.
    await context.sync();
    console.log('Found count: ' + searchResults.items.length);

    // Queue a set of commands to change the font for each found item.
    for (let i = 0; i < searchResults.items.length; i++) {
        searchResults.items[i].font.color = 'purple';
        searchResults.items[i].font.highlightColor = '#FFFF00'; //Yellow
        searchResults.items[i].font.bold = true;
    }

    // Synchronize the document state.
    await context.sync();
});

基于后缀搜索

// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Queue a command to search the document for any string of characters after 'ly'.
    const searchResults = context.document.body.search('ly', {matchSuffix: true});

    // Queue a command to load the font property values.
    searchResults.load('font');

    // Synchronize the document state.
    await context.sync();
    console.log('Found count: ' + searchResults.items.length);

    // Queue a set of commands to change the font for each found item.
    for (let i = 0; i < searchResults.items.length; i++) {
        searchResults.items[i].font.color = 'orange';
        searchResults.items[i].font.highlightColor = 'black';
        searchResults.items[i].font.bold = true;
    }

    // Synchronize the document state.
    await context.sync();
});

使用通配符搜索

// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Queue a command to search the document with a wildcard
    // for any string of characters that starts with 'to' and ends with 'n'.
    const searchResults = context.document.body.search('to*n', {matchWildcards: true});

    // Queue a command to load the font property values.
    searchResults.load('font');

    // Synchronize the document state.
    await context.sync();
    console.log('Found count: ' + searchResults.items.length);

    // Queue a set of commands to change the font for each found item.
    for (let i = 0; i < searchResults.items.length; i++) {
        searchResults.items[i].font.color = 'purple';
        searchResults.items[i].font.highlightColor = 'pink';
        searchResults.items[i].font.bold = true;
    }

    // Synchronize the document state.
    await context.sync();
});

搜索特殊字符

// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Queue a command to search the document for tabs.
    const searchResults = context.document.body.search('^t');

    // Queue a command to load the font property values.
    searchResults.load('font');

    // Synchronize the document state.
    await context.sync();
    console.log('Found count: ' + searchResults.items.length);

    // Queue a set of commands to change the font for each found item.
    for (let i = 0; i < searchResults.items.length; i++) {
        searchResults.items[i].font.color = 'purple';
        searchResults.items[i].font.highlightColor = 'pink';
        searchResults.items[i].font.bold = true;
    }

    // Synchronize the document state.
    await context.sync();
});

使用通配符搜索转义的特殊字符

如前面 转义特殊字符中所述，正则表达式使用特殊字符。 为了使通配符搜索以编程方式查找其中一个特殊字符，需要使用“[”和“]”对其进行转义。 此示例演示如何使用通配符搜索查找“{”特殊字符。

// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Queue a command to search the document with a wildcard for an escaped opening curly brace.
    const searchResults = context.document.body.search('[{]', { matchWildcards: true });

    // Queue a command to load the font property values.
    searchResults.load('font');

    // Synchronize the document state.
    await context.sync();
    console.log('Found count: ' + searchResults.items.length);

    // Queue a set of commands to change the font for each found item.
    for (let i = 0; i < searchResults.items.length; i++) {
        searchResults.items[i].font.color = 'purple';
        searchResults.items[i].font.highlightColor = 'pink';
        searchResults.items[i].font.bold = true;
    }

    // Synchronize the document state.
    await context.sync();
});

尝试Script Lab中的代码示例

获取Script Lab加载项并试用本文中提供的代码示例。 若要了解详细信息，请参阅使用 Script Lab 探索 Office JavaScript API。

另请参阅

有关详细信息，请参阅以下内容：

• Word JavaScript 参考 API
• Script Lab中提供了相关Word代码示例：
  • 搜索
  • 获取字数统计
• 查找和替换Word中的文本