Word.SearchOptions class

オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。

context: RequestContext;

プロパティ値

単語間のすべての句読点文字を無視するかどうかを示す値を指定します。 [検索と置換] ダイアログ ボックスの [句読点を無視する] チェック ボックスに相当します。

ignorePunct: boolean;

プロパティ値

注釈

[ API セット: WordApi 1.1 ]

単語間のすべての空白を無視するかどうかを示す値を指定します。 [検索と置換] ダイアログ ボックスの [空白文字を無視する] チェック ボックスに対応します。

ignoreSpace: boolean;

プロパティ値

注釈

[ API セット: WordApi 1.1 ]

大文字と小文字を区別する検索を実行するかどうかを示す値を指定します。 [検索と置換] ダイアログ ボックスの [大文字と小文字の一致] チェック ボックスに対応します。

matchCase: boolean;

プロパティ値

注釈

[ API セット: WordApi 1.1 ]

検索文字列で始まる単語と一致するかどうかを示す値を指定します。 [検索と置換] ダイアログ ボックスの [接頭辞に一致する] チェック ボックスに相当します。

matchPrefix: boolean;

プロパティ値

注釈

[ API セット: WordApi 1.1 ]

検索文字列で終わる単語と一致するかどうかを示す値を指定します。 [検索と置換] ダイアログ ボックスの [接尾辞に一致する] に相当します。

matchSuffix: boolean;

プロパティ値

注釈

[ API セット: WordApi 1.1 ]

大きな単語の一部であるテキストではなく、単語全体のみを検索するかどうかを示す値を指定します。 [検索と置換] ダイアログ ボックスの [完全に一致する単語だけを検索する] チェック ボックスに相当します。

matchWholeWord: boolean;

プロパティ値

注釈

[ API セット: WordApi 1.1 ]

特殊な検索演算子を使用して検索を実行するかどうかを示す値を指定します。 [検索と置換] ダイアログ ボックスの [ワイルドカードを使用する] チェック ボックスに相当します。

matchWildcards: boolean;

プロパティ値

注釈

[ API セット: WordApi 1.1 ]

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(options?: Word.Interfaces.SearchOptionsLoadOptions): Word.SearchOptions;

パラメーター

戻り値

例

// Ignore punctuation search
// 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 search results and get the font property values.
    searchResults.load('font');
    
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    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 by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
});  

// Search based on a prefix
// 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 search results and get the font property values.
    searchResults.load('font');
    
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();

    // 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 by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
}); 

// Search based on a suffix
// 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 search results and get the font property values.
    searchResults.load('font');
    
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    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 by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
});  

// Search using a wildcard
// 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 search results and get the font property values.
    searchResults.load('font');
    
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    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 by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
}); 

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNames?: string | string[]): Word.SearchOptions;

パラメーター

戻り値

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.SearchOptions;

パラメーター

戻り値

Word.SearchOptions オブジェクトの新しいインスタンスを作成します。

static newObject(context: OfficeExtension.ClientRequestContext): Word.SearchOptions;

パラメーター

戻り値

オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。

set(properties: Interfaces.SearchOptionsUpdateData, options?: OfficeExtension.UpdateOptions): void;

パラメーター

戻り値

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。

set(properties: Word.SearchOptions): void;

パラメーター

戻り値

API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Word.SearchOptions オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Word.Interfaces.SearchOptionsData として型指定) を返します。

toJSON(): Word.Interfaces.SearchOptionsData;

戻り値