Excel.Application class

Пакет:: excel

Представляет приложение Excel, которое управляет книгой.

Extends: OfficeExtension.ClientObject

Свойства

activeWindow	Возвращает объект, `window` представляющий активное окно (окно сверху). Только для чтения.
calculationEngineVersion	Возвращает версию модуля вычислений Excel, использованного для последнего полного пересчета.
calculationMode	Возвращает режим вычисления, используемый в книге, определяемый константами в `Excel.CalculationMode`. Возможные значения: `Automatic`, где Excel управляет пересчетом; `AutomaticExceptTables`, где Excel управляет пересчетом, но игнорирует изменения в таблицах; `Manual`, где расчет выполняется по запросу пользователя. Это свойство среды выполнения. Этот `calculationMode` параметр не сохраняется в книге.
calculationState	Возвращает состояние вычисления приложения. См. `Excel.CalculationState` дополнительные сведения.
context	Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
cultureInfo	Предоставляет сведения на основе текущих параметров системной культуры. К ним относятся имена языковых параметров, форматирование чисел и другие параметры, зависящие от языка и региональных параметров.
decimalSeparator	Возвращает строку, используемую в качестве десятичного разделителя для числовых значений. Это зависит от локальных параметров Excel.
formatStaleValues	Указывает, включен или отключен параметр "Форматировать устаревшие значения" в параметрах вычисления. Устаревшие формулы отображаются с устаревшим форматированием, если этот параметр включен.
iterativeCalculation	Возвращает параметры итеративного вычисления. В Excel для Windows и Mac настройки будут применены к приложению Excel. В Excel в Интернете и на других платформах параметры будут применяться к активной книге.
thousandsSeparator	Возвращает строку, используемую для разделения групп цифр слева от десятичного числа числовых значений. Это зависит от локальных параметров Excel.
useSystemSeparators	Указывает, включены ли системные разделители Excel. Системные разделители включают в себя десятичный разделитель и разделитель разрядов.
windows	Возвращает все открытые окна Excel.

Методы

calculate(calculationType)	Пересчитывает данные во всех открытых в текущий момент книгах Excel.
calculate(calculationType)	Пересчитывает данные во всех открытых в текущий момент книгах Excel.
checkSpelling(word, options)	Проверяет орфографию в отдельном слове. Возвращает правильное написание слова. В `true` противном случае возвращает `false`.
enterEditingMode()	Переход в режим редактирования для выделенного диапазона активного листа. Этот метод эквивалентен использованию клавиши F2 при выделении ячейки или диапазона в пользовательском интерфейсе Excel.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
set(properties, options)	Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.
set(properties)	Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.
suspendApiCalculationUntilNextSync()	Приостанавливает вычисление до вызова следующего `context.sync()` . После этого за пересчет книги и распространение всех зависимостей несет ответственность разработчик.
suspendScreenUpdatingUntilNextSync()	Приостанавливает обновление экрана до тех пор, пока не будет вызван следующий `context.sync()` . Примечание. Не звоните `suspendScreenUpdatingUntilNextSync` несколько раз (например, в цикле). Повторные вызовы приведут к мерцанию окна Excel.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`, в свою очередь, вызывает `toJSON` метод переданного ему объекта.) В то время как исходный `Excel.Application` объект является объектом API, `toJSON` метод возвращает простой объект JavaScript (типизированный как `Excel.Interfaces.ApplicationData`), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.
union(firstRange, secondRange, additionalRanges)	Возвращает объект, `RangeAreas` представляющий объединение двух или более `Range` объектов `RangeAreas` . Входные данные `Range` или `RangeAreas` объекты должны находиться на том же листе. Максимальное количество параметров — 30, включая первые два.

Сведения о свойстве

activeWindow

Возвращает объект, window представляющий активное окно (окно сверху). Только для чтения.

readonly activeWindow: Excel.Window;

Значение свойства

Excel.Window

calculationEngineVersion

Возвращает версию модуля вычислений Excel, использованного для последнего полного пересчета.

readonly calculationEngineVersion: number;

Значение свойства

number

calculationMode

Возвращает режим вычисления, используемый в книге, определяемый константами в Excel.CalculationMode. Возможные значения: Automatic, где Excel управляет пересчетом; AutomaticExceptTables, где Excel управляет пересчетом, но игнорирует изменения в таблицах; Manual, где расчет выполняется по запросу пользователя. Это свойство среды выполнения. Этот calculationMode параметр не сохраняется в книге.

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

Значение свойства

Excel.CalculationMode | "Automatic" | "AutomaticExceptTables" | "Manual"

Примеры

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

await Excel.run(async (context) => {
  context.application.calculationMode = Excel.CalculationMode.manual;
  context.application.load("calculationMode");
  await context.sync();

  console.log("Current calculation mode: " + context.application.calculationMode);
});

calculationState

Возвращает состояние вычисления приложения. См. Excel.CalculationState дополнительные сведения.

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

Значение свойства

Excel.CalculationState | "Done" | "Calculating" | "Pending"

context

Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.

context: RequestContext;

Значение свойства

Excel.RequestContext

cultureInfo

Предоставляет сведения на основе текущих параметров системной культуры. К ним относятся имена языковых параметров, форматирование чисел и другие параметры, зависящие от языка и региональных параметров.

readonly cultureInfo: Excel.CultureInfo;

Значение свойства

Excel.CultureInfo

Примеры

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

await Excel.run(async (context) => {
  context.application.cultureInfo.datetimeFormat.load([
    "longDatePattern",
    "shortDatePattern",
    "dateSeparator",
    "longTimePattern",
    "timeSeparator"
  ]);
  await context.sync();

  // Use the cultural settings API to retrieve the user's system date and time settings.
  const systemLongDatePattern = context.application.cultureInfo.datetimeFormat.longDatePattern;
  const systemShortDatePattern = context.application.cultureInfo.datetimeFormat.shortDatePattern;
  const systemDateSeparator = context.application.cultureInfo.datetimeFormat.dateSeparator;
  const systemLongTimePattern = context.application.cultureInfo.datetimeFormat.longTimePattern;
  const systemTimeSeparator = context.application.cultureInfo.datetimeFormat.timeSeparator;

  // Display the date and time settings in your console.
  console.log("System date/time settings: ");
  console.log(`  System long date format: ${systemLongDatePattern}`);
  console.log(`  System short date format: ${systemShortDatePattern}`);
  console.log(`  System date separator: ${systemDateSeparator}`);
  console.log(`  System long time format: ${systemLongTimePattern}`);
  console.log(`  System time separator: ${systemTimeSeparator}`);

  await context.sync();
});

decimalSeparator

Возвращает строку, используемую в качестве десятичного разделителя для числовых значений. Это зависит от локальных параметров Excel.

readonly decimalSeparator: string;

Значение свойства

string

Примеры

// 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

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Указывает, включен или отключен параметр "Форматировать устаревшие значения" в параметрах вычисления. Устаревшие формулы отображаются с устаревшим форматированием, если этот параметр включен.

formatStaleValues: boolean;

Значение свойства

boolean

iterativeCalculation

Возвращает параметры итеративного вычисления. В Excel для Windows и Mac настройки будут применены к приложению Excel. В Excel в Интернете и на других платформах параметры будут применяться к активной книге.

readonly iterativeCalculation: Excel.IterativeCalculation;

Значение свойства

Excel.IterativeCalculation

thousandsSeparator

Возвращает строку, используемую для разделения групп цифр слева от десятичного числа числовых значений. Это зависит от локальных параметров Excel.

readonly thousandsSeparator: string;

Значение свойства

string

useSystemSeparators

Указывает, включены ли системные разделители Excel. Системные разделители включают в себя десятичный разделитель и разделитель разрядов.

readonly useSystemSeparators: boolean;

Значение свойства

boolean

windows

Возвращает все открытые окна Excel.

readonly windows: Excel.WindowCollection;

Значение свойства

Excel.WindowCollection

Сведения о методе

calculate(calculationType)

Пересчитывает данные во всех открытых в текущий момент книгах Excel.

calculate(calculationType: Excel.CalculationType): void;

Параметры

calculationType: Excel.CalculationType

Определяет тип расчета, который нужно использовать. См. Excel.CalculationType дополнительные сведения.

Возвращаемое значение

void

Примеры

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

calculate(calculationType)

Пересчитывает данные во всех открытых в текущий момент книгах Excel.

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

Параметры

calculationType: "Recalculate" | "Full" | "FullRebuild"

Определяет тип расчета, который нужно использовать. См. Excel.CalculationType дополнительные сведения.

Возвращаемое значение

void

Примеры

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

checkSpelling(word, options)

Проверяет орфографию в отдельном слове. Возвращает правильное написание слова. В true противном случае возвращает false.

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

Параметры

word: string

Слово, которое нужно проверить.

options: Excel.CheckSpellingOptions

Необязательный параметр. Параметры проверки орфографии.

Возвращаемое значение

OfficeExtension.ClientResult<boolean>

enterEditingMode()

Переход в режим редактирования для выделенного диапазона активного листа. Этот метод эквивалентен использованию клавиши F2 при выделении ячейки или диапазона в пользовательском интерфейсе Excel.

enterEditingMode(): void;

Возвращаемое значение

void

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

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

Параметры

options: Excel.Interfaces.ApplicationLoadOptions

Предоставляет параметры для загружаемых свойств объекта.

Возвращаемое значение

Excel.Application

load(propertyNames)

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

Параметры

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

load(propertyNamesAndPaths)

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

Параметры

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.

Возвращаемое значение

Excel.Application

set(properties, options)

Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.

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

Параметры

properties: Excel.Interfaces.ApplicationUpdateData

Объект JavaScript со свойствами, структурированными изоморфно свойствам объекта, для которого вызывается метод.

options: OfficeExtension.UpdateOptions

Предоставляет возможность подавления ошибок, если объект properties пытается задать какие-либо свойства только для чтения.

Возвращаемое значение

void

set(properties)

Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.

set(properties: Excel.Application): void;

Параметры

properties: Excel.Application

Возвращаемое значение

void

suspendApiCalculationUntilNextSync()

Приостанавливает вычисление до вызова следующего context.sync() . После этого за пересчет книги и распространение всех зависимостей несет ответственность разработчик.

suspendApiCalculationUntilNextSync(): void;

Возвращаемое значение

void

suspendScreenUpdatingUntilNextSync()

Приостанавливает обновление экрана до тех пор, пока не будет вызван следующий context.sync() .

Примечание. Не звоните suspendScreenUpdatingUntilNextSync несколько раз (например, в цикле). Повторные вызовы приведут к мерцанию окна Excel.

suspendScreenUpdatingUntilNextSync(): void;

Возвращаемое значение

void

Примеры

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

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.Application объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Excel.Interfaces.ApplicationData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.

toJSON(): Excel.Interfaces.ApplicationData;

Возвращаемое значение

Excel.Interfaces.ApplicationData

union(firstRange, secondRange, additionalRanges)

Возвращает объект, RangeAreas представляющий объединение двух или более Range объектов RangeAreas . Входные данные Range или RangeAreas объекты должны находиться на том же листе. Максимальное количество параметров — 30, включая первые два.

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

Параметры

firstRange: Excel.Range | Excel.RangeAreas

Первый Range или RangeAreas объект.

secondRange: Excel.Range | Excel.RangeAreas

Второй Range или RangeAreas объект.

additionalRanges: (Excel.Range | Excel.RangeAreas)[]

Необязательный параметр. Дополнительные Range или RangeAreas объекты для включения в объединение, до 28.

Возвращаемое значение

Excel.RangeAreas

Обратная связь

Были ли сведения на этой странице полезными?

Excel.Application class

Комментарии

Используется

Свойства

Методы

Сведения о свойстве

activeWindow

Значение свойства

Комментарии

calculationEngineVersion

Значение свойства

Комментарии

calculationMode

Значение свойства

Комментарии

Примеры

calculationState

Значение свойства

Комментарии

context

Значение свойства

cultureInfo

Значение свойства

Комментарии

Примеры

decimalSeparator

Значение свойства

Комментарии

Примеры

formatStaleValues

Значение свойства

Комментарии

iterativeCalculation

Значение свойства

Комментарии

thousandsSeparator

Значение свойства

Комментарии

useSystemSeparators

Значение свойства

Комментарии

windows

Значение свойства

Комментарии

Сведения о методе

calculate(calculationType)

Параметры

Возвращаемое значение

Комментарии

Примеры

calculate(calculationType)

Параметры

Возвращаемое значение

Комментарии

Примеры

checkSpelling(word, options)

Параметры

Возвращаемое значение

Комментарии

enterEditingMode()

Возвращаемое значение

Комментарии

load(options)

Параметры

Возвращаемое значение

load(propertyNames)

Параметры

Возвращаемое значение

Примеры

load(propertyNamesAndPaths)

Параметры

Возвращаемое значение

set(properties, options)

Параметры

Возвращаемое значение

set(properties)

Параметры

Возвращаемое значение

suspendApiCalculationUntilNextSync()

Возвращаемое значение