Word.SearchOptions class

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

If provided, specifies whether to ignore all punctuation characters between words. The default is false. Corresponds to the _Ignore punctuation characters_ check box in the Find and Replace dialog box.

ignorePunct: boolean;

Property Value

Remarks

[ API set: WordApi 1.1 ]

If provided, specifies whether to ignore all whitespace between words. The default is false. Corresponds to the _Ignore white-space characters_ check box in the Find and Replace dialog box.

ignoreSpace: boolean;

Property Value

Remarks

[ API set: WordApi 1.1 ]

If provided, specifies whether to perform a case sensitive search. The default is false. Corresponds to the _Match case_ check box in the Find and Replace dialog box.

matchCase: boolean;

Property Value

Remarks

[ API set: WordApi 1.1 ]

If provided, specifies whether to match words that begin with the search string. The default is false. Corresponds to the _Match prefix_ check box in the Find and Replace dialog box.

matchPrefix: boolean;

Property Value

Remarks

[ API set: WordApi 1.1 ]

If provided, specifies whether to match words that end with the search string. The default is false. Corresponds to the _Match suffix_ check box in the Find and Replace dialog box.

matchSuffix: boolean;

Property Value

Remarks

[ API set: WordApi 1.1 ]

If provided, specifies whether to find only entire words, not text that's part of a larger word. The default is false. Corresponds to the _Find whole words only_ check box in the Find and Replace dialog box.

matchWholeWord: boolean;

Property Value

Remarks

[ API set: WordApi 1.1 ]

If provided, specifies whether the search will be performed using special search operators. The default is false. Corresponds to the _Use wildcards_ check box in the Find and Replace dialog box.

matchWildcards: boolean;

Property Value

Remarks

[ API set: WordApi 1.1 ]

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

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

Parameters

Returns

Examples

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

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

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

Parameters

Returns

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

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

Parameters

Returns

Create a new instance of the Word.SearchOptions object.

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

Parameters

Returns

Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.

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

Parameters

Returns

Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Word.SearchOptions): void;

Parameters

Returns

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original Word.SearchOptions object is an API object, the toJSON method returns a plain JavaScript object (typed as Word.Interfaces.SearchOptionsData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Word.Interfaces.SearchOptionsData;

Returns