Word.SearchOptions class

リファレンス

パッケージ:: word

検索操作に含めるオプションを指定します。 Word JavaScript API で検索オプションを使用する方法の詳細については、「検索オプションを使用してWord アドイン内のテキストを検索する」を参照してください。

Extends: OfficeExtension.ClientObject

注釈

例

// 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	オブジェクトに関連付けられている要求コンテキスト。これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。
ignorePunct	単語間のすべての句読点文字を無視するかどうかを示す値を指定します。 [検索と置換] ダイアログボックスの [句読点を無視する] チェックボックスに相当します。
ignoreSpace	単語間のすべての空白を無視するかどうかを示す値を指定します。 [検索と置換] ダイアログボックスの [空白文字チェック無視する] ボックスに対応します。
matchCase	大文字と小文字を区別する検索を実行するかどうかを示す値を指定します。 [検索と置換] ダイアログボックスの [大文字と小文字チェック一致] ボックスに対応します。
matchPrefix	検索文字列で始まる単語と一致するかどうかを示す値を指定します。 [検索と置換] ダイアログボックスの [接頭辞に一致する] チェックボックスに相当します。
matchSuffix	検索文字列で終わる単語と一致するかどうかを示す値を指定します。 [検索と置換] ダイアログボックスの [接尾辞に一致する] に相当します。
matchWholeWord	大きな単語の一部であるテキストではなく、単語全体のみを検索するかどうかを示す値を指定します。 [検索と置換] ダイアログボックスの [完全に一致する単語だけを検索する] チェックボックスに相当します。
matchWildcards	特殊な検索演算子を使用して検索を実行するかどうかを示す値を指定します。 [検索と置換] ダイアログボックスの [ワイルドカードを使用する] チェックボックスに相当します。

メソッド

load(options)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
load(propertyNames)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
load(propertyNamesAndPaths)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
newObject(context)	`Word.SearchOptions` オブジェクトの新しいインスタンスを作成します。
set(properties, options)	オブジェクトの複数のプロパティを同時に設定します。適切なプロパティを持つプレーンオブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。
set(properties)	既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
toJSON()	API オブジェクトが`JSON.stringify()`に渡されたときにより便利な出力を提供するために、JavaScript `toJSON()` メソッドをオーバーライドします。 (`JSON.stringify`、それに渡されるオブジェクトの `toJSON` メソッドを呼び出します)。元の `Word.SearchOptions` オブジェクトは API オブジェクトですが、 `toJSON` メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( `Word.Interfaces.SearchOptionsData` として型指定) を返します。

プロパティの詳細

context

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

context: RequestContext;

プロパティ値

Word.RequestContext

ignorePunct

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

ignorePunct: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.1 ]

ignoreSpace

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

ignoreSpace: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.1 ]

matchCase

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

matchCase: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.1 ]

matchPrefix

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

matchPrefix: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.1 ]

matchSuffix

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

matchSuffix: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.1 ]

matchWholeWord

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

matchWholeWord: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.1 ]

matchWildcards

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

matchWildcards: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.1 ]

メソッドの詳細

load(options)

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

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

パラメーター

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();
});

load(propertyNames)

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

パラメーター

propertyNames: string | string[]

読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。

戻り値

Word.SearchOptions

load(propertyNamesAndPaths)

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

パラメーター

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。

戻り値

Word.SearchOptions

newObject(context)

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

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

パラメーター

context: OfficeExtension.ClientRequestContext

戻り値

Word.SearchOptions

set(properties, options)

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

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

パラメーター

properties: Word.Interfaces.SearchOptionsUpdateData

メソッドが呼び出されるオブジェクトのプロパティに等形的に構造化されたプロパティを持つ JavaScript オブジェクト。

options: OfficeExtension.UpdateOptions

properties オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。

戻り値

void

set(properties)

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

set(properties: Word.SearchOptions): void;

パラメーター

properties: Word.SearchOptions

戻り値

void

toJSON()

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

toJSON(): Word.Interfaces.SearchOptionsData;

戻り値

Word.Interfaces.SearchOptionsData

次の方法で共有

Word.SearchOptions class

注釈

例

プロパティ

メソッド

プロパティの詳細

context

プロパティ値

ignorePunct

プロパティ値

注釈

ignoreSpace

プロパティ値

注釈

matchCase

プロパティ値

注釈

matchPrefix

プロパティ値

注釈

matchSuffix

プロパティ値

注釈

matchWholeWord

プロパティ値

注釈

matchWildcards

プロパティ値

注釈

メソッドの詳細

load(options)

パラメーター

戻り値

例

load(propertyNames)

パラメーター

戻り値

load(propertyNamesAndPaths)

パラメーター

戻り値

newObject(context)

パラメーター

戻り値

set(properties, options)

パラメーター

戻り値

set(properties)

パラメーター

戻り値

toJSON()

戻り値

その他のリソース