Word.SearchOptions class

Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

Gibt (falls angegeben) an, ob alle Interpunktionszeichen zwischen Wörtern ignoriert werden sollen. Der Standardwert ist false. Entspricht dem Kontrollkästchen _Ignore Interpunktion characters_ im Dialogfeld "Suchen und Ersetzen ".

ignorePunct: boolean;

Eigenschaftswert

Hinweise

API-Satz: WordApi 1.1

Gibt an, ob alle Leerzeichen zwischen Wörtern ignoriert werden sollen. Der Standardwert ist false. Entspricht dem Kontrollkästchen _Ignore Leerzeichen characters_ im Dialogfeld "Suchen und Ersetzen ".

ignoreSpace: boolean;

Eigenschaftswert

Hinweise

API-Satz: WordApi 1.1

Gibt an, ob eine Suche unter Berücksichtigung der Groß-/Kleinschreibung durchgeführt werden soll. Der Standardwert ist false. Entspricht dem Kontrollkästchen "_Match case_" im Dialogfeld "Suchen und Ersetzen ".

matchCase: boolean;

Eigenschaftswert

Hinweise

API-Satz: WordApi 1.1

Gibt an, ob mit Wörtern übereinstimmt wird, die mit der Suchzeichenfolge beginnen. Der Standardwert ist false. Entspricht dem Kontrollkästchen "_Match prefix_" im Dialogfeld "Suchen und Ersetzen ".

matchPrefix: boolean;

Eigenschaftswert

Hinweise

API-Satz: WordApi 1.1

Gibt an, ob Wörter gefunden werden sollen, die mit der Suchzeichenfolge enden. Der Standardwert ist false. Entspricht dem Kontrollkästchen "_Match suffix_" im Dialogfeld "Suchen und Ersetzen ".

matchSuffix: boolean;

Eigenschaftswert

Hinweise

API-Satz: WordApi 1.1

Gibt bei Angabe an, ob nur ganze Wörter gefunden werden sollen, nicht Text, der Teil eines größeren Worts ist. Der Standardwert ist false. Entspricht dem Kontrollkästchen _Find ganzen Wörtern only_ im Dialogfeld "Suchen und Ersetzen ".

matchWholeWord: boolean;

Eigenschaftswert

Hinweise

API-Satz: WordApi 1.1

Gibt (falls angegeben) an, ob die Suche mithilfe spezieller Suchoperatoren durchgeführt wird. Der Standardwert ist false. Entspricht dem Kontrollkästchen "_Use wildcards_" im Dialogfeld "Suchen und Ersetzen ".

matchWildcards: boolean;

Eigenschaftswert

Hinweise

API-Satz: WordApi 1.1

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

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

Parameter

Gibt zurück

Beispiele

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

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

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

Parameter

Gibt zurück

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

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

Parameter

Gibt zurück

Erstellen Sie eine neue Instance des Word.SearchOptions Objekts.

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

Parameter

Gibt zurück

Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.

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

Parameter

Gibt zurück

Legt mehrere Eigenschaften für das Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.

set(properties: Word.SearchOptions): void;

Parameter

Gibt zurück

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON Methode des Objekts auf, das an sie übergeben wird.) Während das ursprüngliche Word.SearchOptions Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Word.Interfaces.SearchOptionsData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.

toJSON(): Word.Interfaces.SearchOptionsData;

Gibt zurück