Localizar uma cadeia de caracteres dentro de um intervalo usando a API JavaScript do Excel
Este artigo fornece um exemplo de código que encontra uma cadeia de caracteres dentro de um intervalo usando a API JavaScript do Excel. Para obter a lista completa de propriedades e métodos compatíveis com o Range
objeto, consulte Classe Excel.Range.
Observação
A API JavaScript do Excel não tem um objeto ou classe "Célula". Em vez disso, a API JavaScript do Excel define todas as células do Excel como objetos Range
. Uma célula individual na interface do usuário do Excel se traduz em um objeto Range
com uma célula na API JavaScript do Excel. Um único objeto Range
também pode conter várias células contíguas. Confira Trabalhar com células usando a API JavaScript do Excel para saber mais.
Corresponder uma cadeia de caracteres dentro de um intervalo
O objeto Range
tem um método find
para pesquisar uma cadeia especificada dentro do intervalo. Ele retorna o intervalo da primeira célula com o texto correspondente.
O exemplo de código a seguir localiza a primeira célula com um valor igual à cadeia de caracteres Alimentos e registra o seu endereço no console. Observe que find
exibe um erro ItemNotFound
se a cadeia de caracteres especificada não existir no intervalo. Se você acha que a cadeia de caracteres especificada pode não estar no intervalo, use o método findOrNullObject para que seu código manipule normalmente esse cenário.
await Excel.run(async (context) => {
let sheet = context.workbook.worksheets.getItem("Sample");
let table = sheet.tables.getItem("ExpensesTable");
let searchRange = table.getRange();
let foundRange = searchRange.find("Food", {
completeMatch: true, // Match the whole cell value.
matchCase: false, // Don't match case.
searchDirection: Excel.SearchDirection.forward // Start search at the beginning of the range.
});
foundRange.load("address");
await context.sync();
console.log(foundRange.address);
});
Quando o método find
é chamado em um intervalo que representa uma única célula, a planilha inteira é pesquisada. A pesquisa começa na célula e segue na direção especificada pelo SearchCriteria.searchDirection
, envolvendo as extremidades da planilha, se necessário.