Excel.Application class

アクティブなウィンドウ (一番上のウィンドウ) を表す window オブジェクトを返します。 読み取り専用です。

readonly activeWindow: Excel.Window;

プロパティ値

注釈

API セット: ExcelApiDesktop 1.1

最後の完全な再計算に使用した Excel 計算エンジンのバージョンを返します。

readonly calculationEngineVersion: number;

プロパティ値

注釈

API セット: ExcelApi 1.9

Excel.CalculationMode の定数で定義されている、ブックで使用される計算モードを返します。 指定可能な値は、 Automatic (Excel が再計算を制御します)、 AutomaticExceptTables (Excel が再計算を制御しますが、テーブルの変更を無視します)、 Manual (ユーザーの要求に応じて計算が行われます) です。 これはランタイム プロパティです。 calculationMode設定はブックに保持されません。

calculationMode: Excel.CalculationMode | "Automatic" | "AutomaticExceptTables" | "Manual";

プロパティ値

注釈

API セット: getの場合はExcelApi 1.1、set の場合は1.8

アプリケーションの計算の状態を返します。 詳細は「Excel.CalculationState」をご覧ください。

readonly calculationState: Excel.CalculationState | "Done" | "Calculating" | "Pending";

プロパティ値

注釈

API セット: ExcelApi 1.9

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

context: RequestContext;

プロパティ値

現在のシステム カルチャの設定に基づいた情報を提供します。 これには、カルチャ名、数値の書式設定、およびカルチャに依存するその他の設定が含まれます。

readonly cultureInfo: Excel.CultureInfo;

プロパティ値

注釈

API セット: ExcelApi 1.11

数値の小数点区切り文字として使用される文字列を取得します。 これは、ローカルの Excel の設定に基づいています。

readonly decimalSeparator: string;

プロパティ値

注釈

API セット: ExcelApi 1.11

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/culture-info.yaml

await Excel.run(async (context) => {
  context.application.load("decimalSeparator,thousandsSeparator");
  context.application.cultureInfo.numberFormat.load("numberDecimalSeparator,numberGroupSeparator");
  await context.sync();

  // Local settings are set under the "Options > Advanced" menu.
  const localDecimalSeparator = context.application.decimalSeparator;
  const localThousandsSeparator = context.application.thousandsSeparator;

  const systemDecimalSeparator = context.application.cultureInfo.numberFormat.numberDecimalSeparator;
  const systemThousandsSeparator = context.application.cultureInfo.numberFormat.numberGroupSeparator;

  console.log("Local character settings: ");
  console.log(`  Local decimal separator: ${localDecimalSeparator}`);
  console.log(`  Local thousands separator: ${localThousandsSeparator}`);

  console.log("System culture settings: ");
  console.log(`  System decimal separator: ${systemDecimalSeparator}`);
  console.log(`  System thousands separator: ${systemThousandsSeparator}`);
  console.log(`  `);

  await context.sync();
});

[計算オプション] 内の [古い値を書式設定] オプションを有効か無効かを指定します。 このオプションが有効になっている場合、古い数式は古い書式設定で表示されます。

formatStaleValues: boolean;

プロパティ値

注釈

API セット: ExcelApi ベータ版 (プレビューのみ)

反復計算の設定を返します。 Windows および Mac の Excel では、設定は Excel アプリケーションに適用されます。 Excel on the web やその他のプラットフォームでは、設定がアクティブなブックに適用されます。

readonly iterativeCalculation: Excel.IterativeCalculation;

プロパティ値

注釈

API セット: ExcelApi 1.9

数値の小数点以下以下を区切るために使用する文字列を取得します。 これは、ローカルの Excel の設定に基づいています。

readonly thousandsSeparator: string;

プロパティ値

注釈

API セット: ExcelApi 1.11

Excel のシステム区切り記号を有効にするかどうかを指定します。 システム区切り記号には、小数点区切り記号と桁区切り記号が含まれます。

readonly useSystemSeparators: boolean;

プロパティ値

注釈

API セット: ExcelApi 1.11

開いているすべての Excel ウィンドウを返します。

readonly windows: Excel.WindowCollection;

プロパティ値

注釈

API セット: ExcelApiDesktop 1.1

Excel で現在開いているすべてのブックを再計算します。

calculate(calculationType: Excel.CalculationType): void;

パラメーター

返品

注釈

API セット: ExcelApi 1.1

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/90-scenarios/performance-optimization.yaml

await Excel.run(async (context) => {
  context.application.calculate(Excel.CalculationType.full);
});

Excel で現在開いているすべてのブックを再計算します。

calculate(calculationType: "Recalculate" | "Full" | "FullRebuild"): void;

パラメーター

返品

注釈

API セット: ExcelApi 1.1

例

await Excel.run(async (context) => {
    context.workbook.application.calculate('Full');
    await context.sync();
});

指定された単語のスペルをチェックします。 単語のスペルが正しい場合は true を返し、それ以外の場合は false を返します。

checkSpelling(word: string, options?: Excel.CheckSpellingOptions): OfficeExtension.ClientResult<boolean>;

パラメーター

返品

注釈

API セット: ExcelApiDesktop 1.1

作業中のワークシートで選択した範囲の編集モードに入ります。 このメソッドは、Excel UI でセルまたは範囲を選択するときに "F2" を使用するのと同じです。

enterEditingMode(): void;

返品

注釈

API セット: ExcelApiDesktop 1.1

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

load(options?: Excel.Interfaces.ApplicationLoadOptions): Excel.Application;

パラメーター

返品

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

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

パラメーター

返品

例

await Excel.run(async (context) => {
    const application = context.workbook.application;
    application.load('calculationMode');
    await context.sync();

    console.log(application.calculationMode);
});

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

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

パラメーター

返品

オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。

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

パラメーター

返品

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。

set(properties: Excel.Application): void;

パラメーター

返品

次の context.sync() が呼び出されるまで計算を中断します。 設定されると、依存関係が確実に伝達されるようにブックを再計算するのは開発者の責任です。

suspendApiCalculationUntilNextSync(): void;

返品

注釈

API セット: ExcelApi 1.6

次の context.sync() が呼び出されるまで画面の更新を中断します。

注: 繰り返し (ループ内など) suspendScreenUpdatingUntilNextSync 呼び出さないでください。 呼び出しが繰り返されると、Excel ウィンドウがちらつきます。

suspendScreenUpdatingUntilNextSync(): void;

返品

注釈

API セット: ExcelApi 1.9

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/90-scenarios/performance-optimization.yaml

await Excel.run(async (context) => {
  // Recreate the data in the worksheet with random data.
  const sheet = context.workbook.worksheets.getActiveWorksheet();

  const startTime = Date.now();
  console.log("Starting...");

  // If other parts of the sample have toggled screen painting off, this will stop screen updating until context.sync is called.
  if (pauseScreenPainting) {
    context.application.suspendScreenUpdatingUntilNextSync();
  }

  for (let i = 1; i < ROW_COUNT; i++) {
    for (let j = 1; j < COLUMN_COUNT; j++) {
      let cell = sheet.getCell(i, j);
      cell.values = [[i * j * Math.random()]];

      // If other parts of the sample have toggled tracking off, we will avoid tracking this range and having to manage the proxy objects.
      // For more information, see https://learn.microsoft.com/office/dev/add-ins/concepts/resource-limits-and-performance-optimization#untrack-unneeded-proxy-objects
      if (untrack) {
        cell.untrack();
      }
    }
  }

  await context.sync();

  console.log(`Ending. Adding ${ROW_COUNT * COLUMN_COUNT} cells took ${Date.now() - startTime} milliseconds`);
});

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

toJSON(): Excel.Interfaces.ApplicationData;

返品

2 つ以上のRangeまたは RangeAreas オブジェクトの和集合を表すRangeAreas オブジェクトを返します。 入力 Range または RangeAreas オブジェクトは、同じワークシートからのものである必要があります。 パラメーターの最大数は、最初の 2 つを含めて 30 です。

union(firstRange: Range | RangeAreas, secondRange: Range | RangeAreas, ...additionalRanges: (Range | RangeAreas)[]): Excel.RangeAreas;

パラメーター

返品

注釈

API セット: ExcelApiDesktop 1.1