Word.SearchOptions class

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Dans cette option, indique s’il faut ignorer tous les signes de ponctuation entre les mots. La valeur par défaut est false. Correspond à la zone characters_ case activée de ponctuation _Ignore de la boîte de dialogue Rechercher et remplacer.

ignorePunct: boolean;

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.1

S’il est fourni, spécifie s’il faut ignorer tous les espaces entre les mots. La valeur par défaut est false. Correspond à la zone _Ignore characters_ case activée d’espaces blancs de la boîte de dialogue Rechercher et remplacer.

ignoreSpace: boolean;

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.1

Le cas échéant, indique s’il faut effectuer une recherche respectant la casse. La valeur par défaut est false. Correspond à la zone _Match case_ case activée de la boîte de dialogue Rechercher et remplacer.

matchCase: boolean;

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.1

Si ces informations sont fournies, elles spécifient s’il faut faire correspondre les mots commençant par la chaîne de recherche. La valeur par défaut est false. Correspond à la zone _Match prefix_ case activée de la boîte de dialogue Rechercher et remplacer.

matchPrefix: boolean;

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.1

S’il est fourni, indique s’il faut faire correspondre les mots se terminant par la chaîne de recherche. La valeur par défaut est false. Correspond à la zone _Match suffix_ case activée de la boîte de dialogue Rechercher et remplacer.

matchSuffix: boolean;

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.1

S’il est fourni, indique s’il faut rechercher uniquement des mots entiers, et non du texte faisant partie d’un mot plus grand. La valeur par défaut est false. Correspond à la zone _Find only_ case activée mots entiers de la boîte de dialogue Rechercher et remplacer.

matchWholeWord: boolean;

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.1

Si cette option est fournie, elle indique si la recherche sera effectuée à l’aide d’opérateurs de recherche spéciaux. La valeur par défaut est false. Correspond à la zone _Use wildcards_ case activée de la boîte de dialogue Rechercher et remplacer.

matchWildcards: boolean;

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.1

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

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

Paramètres

Retours

Exemples

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

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

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

Paramètres

Retours

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

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

Paramètres

Retours

Créez une nouvelle instance de l’objetWord.SearchOptions.

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

Paramètres

Retours

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.

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

Paramètres

Retours

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

set(properties: Word.SearchOptions): void;

Paramètres

Retours

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Word.SearchOptions est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Word.Interfaces.SearchOptionsDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Word.Interfaces.SearchOptionsData;

Retours