Word.SearchOptions class

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

Especifica un valor que indica si se deben omitir todos los caracteres de puntuación entre palabras. Corresponde a la casilla Omitir puntuación en el cuadro de diálogo Buscar y reemplazar.

ignorePunct: boolean;

Valor de propiedad

Comentarios

[ Conjunto de API: WordApi 1.1 ]

Especifica un valor que indica si se debe omitir todo el espacio en blanco entre palabras. Corresponde a la casilla Omitir caracteres de espacios en blanco del cuadro de diálogo Buscar y reemplazar.

ignoreSpace: boolean;

Valor de propiedad

Comentarios

[ Conjunto de API: WordApi 1.1 ]

Especifica un valor que indica si se debe realizar una búsqueda que distingue mayúsculas de minúsculas. Corresponde a la casilla De coincidencia de mayúsculas y minúsculas del cuadro de diálogo Buscar y reemplazar.

matchCase: boolean;

Valor de propiedad

Comentarios

[ Conjunto de API: WordApi 1.1 ]

Especifica un valor que indica si se deben coincidir palabras que comienzan con la cadena de búsqueda. Corresponde a la casilla Coincidir prefijo en el cuadro de diálogo Buscar y reemplazar.

matchPrefix: boolean;

Valor de propiedad

Comentarios

[ Conjunto de API: WordApi 1.1 ]

Especifica un valor que indica si se deben coincidir palabras que terminan con la cadena de búsqueda. Corresponde a la casilla Coincidir sufijo en el cuadro de diálogo Buscar y reemplazar.

matchSuffix: boolean;

Valor de propiedad

Comentarios

[ Conjunto de API: WordApi 1.1 ]

Especifica un valor que indica si se va a buscar la operación solo palabras completas, no texto que forme parte de una palabra mayor. Corresponde a la casilla Solo palabras completas en el cuadro de diálogo Buscar y reemplazar.

matchWholeWord: boolean;

Valor de propiedad

Comentarios

[ Conjunto de API: WordApi 1.1 ]

Especifica un valor que indica si la búsqueda se realizará mediante operadores de búsqueda especiales. Corresponde a la casilla Usar caracteres comodín en el cuadro de diálogo Buscar y reemplazar.

matchWildcards: boolean;

Valor de propiedad

Comentarios

[ Conjunto de API: WordApi 1.1 ]

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

Devoluciones

Ejemplos

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

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

Devoluciones

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

Devoluciones

Cree una nueva instancia del Word.SearchOptions objeto .

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

Parámetros

Devoluciones

Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto de API del mismo tipo.

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

Parámetros

Devoluciones

Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.

set(properties: Word.SearchOptions): void;

Parámetros

Devoluciones

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Word.SearchOptions es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Word.Interfaces.SearchOptionsData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): Word.Interfaces.SearchOptionsData;

Devoluciones