Excel.Query class

オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。

context: RequestContext;

プロパティ値

クエリが最後に更新されたときのクエリ エラー メッセージを取得します。

readonly error: Excel.QueryError | "Unknown" | "None" | "FailedLoadToWorksheet" | "FailedLoadToDataModel" | "FailedDownload" | "FailedToCompleteDownload";

プロパティ値

注釈

[ API セット: ExcelApi 1.14 ]

オブジェクト型に読み込まれたクエリを取得します。

readonly loadedTo: Excel.LoadToType | "ConnectionOnly" | "Table" | "PivotTable" | "PivotChart";

プロパティ値

注釈

[ API セット: ExcelApi 1.14 ]

クエリがデータ モデルに読み込まれるかどうかを指定します。

readonly loadedToDataModel: boolean;

プロパティ値

注釈

[ API セット: ExcelApi 1.14 ]

クエリの名前を取得します。 クエリ名にピリオドや引用符を含めることはできません。

readonly name: string;

プロパティ値

注釈

[ API セット: ExcelApi 1.14 ]

例

// This function retrieves the query collection in a workbook, 
// loads the query items in that collection, and then
// logs the name of each query to the console.
await Excel.run(async (context) => {
    const queries = context.workbook.queries; 
    queries.load("items"); 
    await context.sync(); 

    console.log("Name of each query: ")
    console.log("  " + queries.items.map((query) => query.name).join("\n  "));
});

クエリが最後に更新された日時を取得します。

readonly refreshDate: Date;

プロパティ値

注釈

[ API セット: ExcelApi 1.14 ]

例

// This function retrieves the query collection in a workbook, 
// loads the query items in that collection, and then
// logs the last refresh date of each query to the console.
await Excel.run(async (context) => {
    const queries = context.workbook.queries; 
    queries.load("items"); 
    await context.sync(); 

    console.log("Last refresh date of each query: ")
    console.log("  " + queries.items.map((query) => query.refreshDate).join("\n  "));
});       

クエリが最後に更新されたときに読み込まれた行の数を取得します。 最後の更新でエラーが発生した場合、値は -1 になります。

readonly rowsLoadedCount: number;

プロパティ値

注釈

[ API セット: ExcelApi 1.14 ]

例

// This function retrieves the query collection in a workbook, 
// loads the query items in that collection, and then
// logs the number of rows loaded in each query.
await Excel.run(async (context) => {
    const queries = context.workbook.queries; 
    queries.load("items"); 
    await context.sync(); 

    console.log("Rows loaded from each query: ")
    console.log("  " + queries.items.map((query) => query.rowsLoadedCount).join("\n  "));
});

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(options?: Excel.Interfaces.QueryLoadOptions): Excel.Query;

パラメーター

戻り値

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNames?: string | string[]): Excel.Query;

パラメーター

戻り値

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.Query;

パラメーター

戻り値

API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Excel.Query オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.QueryData として型指定) を返します。

toJSON(): Excel.Interfaces.QueryData;

戻り値