Word.SearchOptions class

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

context: RequestContext;

Valor da propriedade

Se for fornecido, especifica se deve ignorar todos os carateres de pontuação entre palavras. A predefinição é false. Corresponde à caixa de characters_ marcar _Ignore pontuação na caixa de diálogo Localizar e Substituir.

ignorePunct: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.1 ]

Se for fornecido, especifica se deve ignorar todo o espaço em branco entre palavras. A predefinição é false. Corresponde à caixa de _Ignore espaço em branco characters_ marcar na caixa de diálogo Localizar e Substituir.

ignoreSpace: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.1 ]

Se for fornecido, especifica se deve efetuar uma pesquisa sensível a maiúsculas e minúsculas. A predefinição é false. Corresponde à caixa de _Match case_ marcar na caixa de diálogo Localizar e Substituir.

matchCase: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.1 ]

Se for fornecido, especifica se deve corresponder as palavras que começam com a cadeia de pesquisa. A predefinição é false. Corresponde à caixa de _Match prefix_ marcar na caixa de diálogo Localizar e Substituir.

matchPrefix: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.1 ]

Se for fornecido, especifica se deve corresponder as palavras que terminam com a cadeia de pesquisa. A predefinição é false. Corresponde à caixa de _Match suffix_ marcar na caixa de diálogo Localizar e Substituir.

matchSuffix: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.1 ]

Se for fornecido, especifica se pretende localizar apenas palavras inteiras e não texto que faça parte de uma palavra maior. A predefinição é false. Corresponde à caixa _Find palavras inteiras only_ marcar na caixa de diálogo Localizar e Substituir.

matchWholeWord: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.1 ]

Se for fornecido, especifica se a pesquisa será efetuada com operadores de pesquisa especiais. A predefinição é false. Corresponde à caixa de _Use wildcards_ marcar na caixa de diálogo Localizar e Substituir.

matchWildcards: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.1 ]

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

Retornos

Exemplos

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

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

Retornos

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

Retornos

Crie uma nova instância do Word.SearchOptions objeto.

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

Parâmetros

Retornos

Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.

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

Parâmetros

Retornos

Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.

set(properties: Word.SearchOptions): void;

Parâmetros

Retornos

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Word.SearchOptions é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.SearchOptionsData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Word.Interfaces.SearchOptionsData;

Retornos