Excel.SearchCriteria interface

使用する検索条件を表します。

注釈

API セット: ExcelApi 1.9

使用元

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const table = sheet.tables.getItem("ExpensesTable");
    const searchRange = table.getRange();
    
    // Search for cells that exactly match "TODO", ignoring case, and starting from the top-left of the range and going forward.
    const searchCriteria: Excel.SearchCriteria = {
        completeMatch: true,
        matchCase: false,
        searchDirection: Excel.SearchDirection.forward
    };
    const foundRange = searchRange.findOrNullObject("TODO", searchCriteria);
    foundRange.load("address");
    await context.sync();

    if (foundRange.isNullObject) {
        console.log("Text not found");
    } else {
        console.log(foundRange.address);
    }
});

プロパティ

completeMatch

一致を完全にする必要があるか、部分的に一致させる必要があるかを指定します。 完全一致の場合は、セルの内容全体が一致します。 部分一致は、セルの内容内の部分文字列に一致します (例: catcaterpillarscatter に部分的に一致します)。 既定値は false (部分的) です。

matchCase

一致で大文字と小文字が区別されるかどうかを指定します。 既定値は false (大文字と小文字の区別なし) です。

searchDirection

検索の方向を指定します。 既定値は前方向です。 Excel.SearchDirection を参照してください。

プロパティの詳細

completeMatch

一致を完全にする必要があるか、部分的に一致させる必要があるかを指定します。 完全一致の場合は、セルの内容全体が一致します。 部分一致は、セルの内容内の部分文字列に一致します (例: catcaterpillarscatter に部分的に一致します)。 既定値は false (部分的) です。

completeMatch?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.9

matchCase

一致で大文字と小文字が区別されるかどうかを指定します。 既定値は false (大文字と小文字の区別なし) です。

matchCase?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.9

searchDirection

検索の方向を指定します。 既定値は前方向です。 Excel.SearchDirection を参照してください。

searchDirection?: Excel.SearchDirection | "Forward" | "Backwards";

プロパティ値

Excel.SearchDirection | "Forward" | "Backwards"

注釈

API セット: ExcelApi 1.9