Excel.Worksheet class

Пакет:
excel

Лист Excel представляет собой сетку ячеек. Он может содержать данные, таблицы, диаграммы и т. д. Дополнительные сведения об объектной модели листа см. в статье Работа с листами с помощью API JavaScript в Excel.

Extends
OfficeExtension.ClientObject

Комментарии

Набор API: ExcelApi 1.1

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

Примеры

// Get a Worksheet object by its name and activate it.
await Excel.run(async (context) => { 
    const wSheetName = 'Sheet1';
    const worksheet = context.workbook.worksheets.getItem(wSheetName);
    worksheet.activate();
    await context.sync(); 
});

Свойства

autoFilter

Представляет AutoFilter объект листа.
charts

Возвращает коллекцию диаграмм, являющихся частью листа.
comments

Возвращает коллекцию всех объектов Comments на листе.
context

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

Получает коллекцию настраиваемых свойств на уровне листа.
enableCalculation

Определяет, следует ли Excel при необходимости пересчитать лист. Имеет значение "True", если Excel пересчитывает лист при необходимости. Значение false, если Excel не пересчитывает лист.
freezePanes

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

Получает коллекцию горизонтальных разрывов страницы для листа. Эта коллекция содержит только добавленные вручную разрывы страниц.
id

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

Отображаемое имя листа. Длина имени не должна превышать 32 символа.
namedSheetViews

Возвращает набор представлений листов, присутствующих на листе.
names

Коллекция имен, относящих к текущему листу.
notes

Возвращает коллекцию всех объектов заметок на листе.
pageLayout

Получает PageLayout объект листа.
pivotTables

Коллекция сводных таблиц на листе.
position

Положение листа (начиная с нуля) в книге.
protection

Возвращает объект защиты листа для листа.
shapes

Возвращает коллекцию всех объектов Shape на листе.
showDataTypeIcons

Указывает, видны ли значки типов данных на листе. По умолчанию значки типов данных отображаются.
showGridlines

Указывает, видны ли линии сетки пользователю.
showHeadings

Указывает, видны ли заголовки пользователю.
slicers

Возвращает коллекцию срезов, являющихся частью листа.
standardHeight

Возвращает стандартную (по умолчанию) высоту всех строк на листе (в пунктах).
standardWidth

Определяет стандартную (стандартную) ширину всех столбцов на листе. Одна единица ширины столбца равна ширине одного символа в стиле "Обычный". Для пропорциональных шрифтов используется ширина символа 0 (ноль).
tabColor

Цвет вкладки листа. Если при получении цвета вкладки лист невидимый, значение будет равно null. Если лист отображается, но для цвета вкладки выбрано значение "Автоматический", будет возвращена пустая строка. В противном случае свойству будет присвоен цвет в формате #RRGGBB (например, "FFA500"). При задании цвета используйте пустую строку, чтобы установить "авто" цвет или реальный цвет в противном случае.
tabId

Возвращает значение, представляющее данный лист, которое может быть прочитано Open Office XML. Это целочисленное значение, которое отличается от worksheet.id (который возвращает глобальный уникальный идентификатор) и worksheet.name (который возвращает значение, например "Лист1").
tables

Коллекция таблиц, имеющихся на листе.
tasks

Возвращает набор задач, присутствующих на листе.
verticalPageBreaks

Получает коллекцию вертикальных разрывов страницы для листа. Эта коллекция содержит только добавленные вручную разрывы страниц.
visibility

Видимость листа.

Методы

activate()

Активация листа в пользовательском интерфейсе Excel.
calculate(markAllDirty)

Вычисляет все ячейки на листе.
checkSpelling(options)

Проверяет орфографию в словах на этом листе. Этот метод позволяет открыть диалоговое окно "Орфография" в пользовательском интерфейсе Excel.
clearArrows()

Удаление стрелок трассировки с листа.
copy(positionType, relativeTo)

Копирует лист и размещает его в указанном месте.
copy(positionType, relativeTo)

Копирует лист и размещает его в указанном месте.
delete()

Удаляет лист из книги. Обратите внимание, что если для листа задано значение "VeryHidden", операция удаления завершится сбоем с исключением InvalidOperation . Прежде чем удалять его, сначала измените видимость на скрытую или видимую.
evaluate(name)

Возвращает результат вычисления строки формулы. Поддерживается только ввод формул. Если имя формулы недопустимо, возникает InvalidArgument ошибка.
findAll(text, criteria)

Находит все вхождения заданной строки на основе указанных условий и возвращает их как RangeAreas объект, состоящий из одного или нескольких прямоугольных диапазонов. Содержимое скрытых листов не возвращается.
findAllOrNullObject(text, criteria)

Находит все вхождения заданной строки на основе указанных условий и возвращает их как RangeAreas объект, состоящий из одного или нескольких прямоугольных диапазонов. Содержимое скрытых листов не возвращается.
getCell(row, column)

Получает объект, Range содержащий одну ячейку, на основе номеров строк и столбцов. Ячейка может находиться за пределами родительского диапазона, если она остается в сетке листа.
getNext(visibleOnly)

Получает рабочий лист, следующий за этим листом. Если после этого листа нет листов, этот метод выдаст ошибку.
getNextOrNullObject(visibleOnly)

Получает рабочий лист, следующий за этим листом. Если после этого листа нет листов, этот метод возвращает объект со isNullObject свойством true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getPrevious(visibleOnly)

Получение предыдущего листа. Если таких листов нет, возникает ошибка.
getPreviousOrNullObject(visibleOnly)

Получение предыдущего листа. Если предыдущих листов нет, этот метод возвращает объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getRange(address)

Получает Range объект, представляющий собой один прямоугольный блок ячеек, заданный по адресу или имени.
getRangeByIndexes(startRow, startColumn, rowCount, columnCount)

Получает объект, Range начинающийся с определенного индекса строки и индекса столбца и охватывающий определенное количество строк и столбцов.
getRanges(address)

Получает объект, представляющий RangeAreas один или несколько блоков прямоугольных диапазонов, заданных адресом или именем.
getUsedRange(valuesOnly)

Используемый диапазон — это наименьший диапазон, включающий в себя все ячейки с определенным значением или форматированием. Если весь лист пуст, эта функция возвращает верхнюю левую ячейку (т. е. не выдает ошибки).
getUsedRangeOrNullObject(valuesOnly)

Используемый диапазон — это наименьший диапазон, включающий в себя все ячейки с определенным значением или форматированием. Если весь лист пустой, этот метод возвращает объект со isNullObject свойством true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
load(options)

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

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

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

Находит и заменяет определенную строку на основе условий, указанных в текущем листе.
set(properties, options)

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

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

Показывает группы строк и столбцов по уровням структуры. Структурирование, группировка и обобщение списка данных на листе. Параметры rowLevels и columnLevels определяют, сколько уровней контура будет отображаться. Допустимый диапазон аргументов находится в диапазоне от 0 до 8. Значение 0 не влияет на текущее отображение. Если значение больше текущего количества уровней, отображают все уровни.
toJSON()

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

События

onActivated

Возникает при активации листа.
onCalculated

Возникает при пересчете листа.
onCalculationBusy

Возникают, когда ячейки на листе вычисляются асинхронно.

Это событие запускается в конце цикла вычислений, аналогично onCalculated самому событию. Обычно, когда завершается вычисление для ячейки, onCalculated запускается событие. Однако если при вычислении в ячейке помещается временное ожидающее значение (например, "#BUSY!"), оно запускается, чтобы показать, onCalculationBusy что состояние ячейки изменилось, хотя вычисление окончательного значения еще не завершено. Когда последующий цикл вычислений завершает вычисление этой ячейки onCalculated , запускается событие.

Функции формул, такие как функции JavaScript User-Defined и формулы =PY, могут вызывать это событие.
onChanged

Возникает при изменении данных на определенном листе.
onColumnSorted

Возникает при сортировке одного или нескольких столбцов. Это происходит в результате операции сортировки слева направо.
onDeactivated

Возникает при деактивации листа.
onFiltered

Возникает при применении фильтра к определенному листу.
onFormatChanged

Возникает, если изменен формат указанного листа.
onFormulaChanged

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

Событие запускается только в том случае, если ячейка уже содержит формулу. Новое значение в ячейке может не содержать формулу. Это событие не запускается при вводе формулы в ячейку, которая ранее не содержала формулу.
onNameChanged

Возникает при изменении имени листа.
onProtectionChanged

Возникает при изменении состояния защиты листа.
onRowHiddenChanged

Возникают, когда на листе изменилось скрытое состояние одной или нескольких строк.
onRowSorted

Возникает при сортировке одной или нескольких строк. Происходит в результате операции сортировки сверху вниз.
onSelectionChanged

Возникает при изменении выделения на определенном листе.
onSingleClicked

Возникает при щелчке левой кнопкой мыши или касании на листе. Это событие не будет запускаться при нажатии в следующих случаях:

  • Пользователь перетаскивает мышь для множественного выбора.

  • Пользователь выбирает ячейку в режиме, в котором выделены аргументы ячейки для ссылок на формулы.
onVisibilityChanged

Возникает при изменении видимости листа.

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

autoFilter

Представляет AutoFilter объект листа.

readonly autoFilter: Excel.AutoFilter;

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

Excel.AutoFilter

Комментарии

Набор API: ExcelApi 1.9

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-auto-filter.yaml

// This function adds a percentage AutoFilter to the active worksheet 
// and applies the filter to a column of the used range.
await Excel.run(async (context) => {
    // Retrieve the active worksheet and the used range on that worksheet.
    const sheet = context.workbook.worksheets.getActiveWorksheet();
    const farmData = sheet.getUsedRange();

    // Add a filter that will only show the rows with the top 50% of values in column 3.
    sheet.autoFilter.apply(farmData, 3, {
        criterion1: "50",
        filterOn: Excel.FilterOn.topPercent
    });

    await context.sync();
});

charts

Возвращает коллекцию диаграмм, являющихся частью листа.

readonly charts: Excel.ChartCollection;

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

Excel.ChartCollection

Комментарии

Набор API: ExcelApi 1.1

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-create-several-charts.yaml

await Excel.run(async (context) => {
  let sheet = context.workbook.worksheets.getItem("Sample");
  let salesTable = sheet.tables.getItem("SalesTable");

  let dataRange = sheet.getRange("A1:E7");

  // Create an XY scatter chart.
  let chart = sheet.charts.add(Excel.ChartType.xyscatter, dataRange, "Auto");
  chart.title.text = "Bicycle Parts Quarterly Sales";
  chart.setPosition("A36", "F48");

  await context.sync();
});

comments

Возвращает коллекцию всех объектов Comments на листе.

readonly comments: Excel.CommentCollection;

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

Excel.CommentCollection

Комментарии

Набор API: ExcelApi 1.10

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-comment-event-handler.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Comments");
    const comment = sheet.comments.getItemAt(0);
    comment.content = "Please add headers here.";
    await context.sync();
});

context

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

context: RequestContext;

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

Excel.RequestContext

customProperties

Получает коллекцию настраиваемых свойств на уровне листа.

readonly customProperties: Excel.WorksheetCustomPropertyCollection;

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

Excel.WorksheetCustomPropertyCollection

Комментарии

Набор API: ExcelApi 1.12

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/26-document/custom-properties.yaml

await Excel.run(async (context) => {
  // Load the keys and values of all custom properties in the current worksheet.
  const customWorksheetProperties = context.workbook.worksheets.getActiveWorksheet().customProperties;
  customWorksheetProperties.load(["key", "value"]);
  await context.sync();

  // Log each custom property to the console.
  // Note that your document may have more properties than those you have set using this snippet.
  customWorksheetProperties.items.forEach((property) => {
    console.log(`${property.key}: ${property.value}`);
  });
});

enableCalculation

Определяет, следует ли Excel при необходимости пересчитать лист. Имеет значение "True", если Excel пересчитывает лист при необходимости. Значение false, если Excel не пересчитывает лист.

enableCalculation: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.9

freezePanes

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

readonly freezePanes: Excel.WorksheetFreezePanes;

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

Excel.WorksheetFreezePanes

Комментарии

Набор API: ExcelApi 1.7

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-freeze-panes.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    sheet.freezePanes.unfreeze();

    await context.sync();
});

horizontalPageBreaks

Получает коллекцию горизонтальных разрывов страницы для листа. Эта коллекция содержит только добавленные вручную разрывы страниц.

readonly horizontalPageBreaks: Excel.PageBreakCollection;

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

Excel.PageBreakCollection

Комментарии

Набор API: ExcelApi 1.9

id

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

readonly id: string;

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

string

Комментарии

Набор API: ExcelApi 1.1

name

Отображаемое имя листа. Длина имени не должна превышать 32 символа.

name: string;

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

string

Комментарии

Набор API: ExcelApi 1.1

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/add-delete-rename-move-worksheet.yaml

await Excel.run(async (context) => {
    const currentSheet = context.workbook.worksheets.getActiveWorksheet();

    currentSheet.name = await uniqueWorksheetName(context);

    await context.sync();
    console.log(`Renamed worksheet to "${currentSheet.name}"`);
});

namedSheetViews

Возвращает набор представлений листов, присутствующих на листе.

readonly namedSheetViews: Excel.NamedSheetViewCollection;

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

Excel.NamedSheetViewCollection

Комментарии

Набор API: ExcelApiOnline 1.1

names

Коллекция имен, относящих к текущему листу.

readonly names: Excel.NamedItemCollection;

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

Excel.NamedItemCollection

Комментарии

Набор API: ExcelApi 1.4

notes

Возвращает коллекцию всех объектов заметок на листе.

readonly notes: Excel.NoteCollection;

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

Excel.NoteCollection

Комментарии

Набор API: ExcelApi 1.18

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/excel-note-basics.yaml

// This function changes the height and width of the first note.
await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getItem("Notes");
  const note = sheet.notes.getItemAt(0);
  note.height = 200;
  note.width = 400;
  await context.sync();
});

pageLayout

Получает PageLayout объект листа.

readonly pageLayout: Excel.PageLayout;

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

Excel.PageLayout

Комментарии

Набор API: ExcelApi 1.9

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-page-layout.yaml

await Excel.run(async (context) => {
    const farmSheet = context.workbook.worksheets.getItem("Print");
    farmSheet.pageLayout.blackAndWhite = true;
    await context.sync();
});

pivotTables

Коллекция сводных таблиц на листе.

readonly pivotTables: Excel.PivotTableCollection;

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

Excel.PivotTableCollection

Комментарии

Набор API: ExcelApi 1.3

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-get-pivottables.yaml

await Excel.run(async (context) => {
  // Get the names of all the PivotTables in the current worksheet.
  const pivotTables = context.workbook.worksheets.getActiveWorksheet().pivotTables;
  pivotTables.load("name");
  await context.sync();

  // Display the names in the console.
  console.log("PivotTables in the current worksheet:")
  pivotTables.items.forEach((pivotTable) => {
    console.log(`\t${pivotTable.name}`);
  });
});

position

Положение листа (начиная с нуля) в книге.

position: number;

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

number

Комментарии

Набор API: ExcelApi 1.1

Примеры

// Set worksheet position.
await Excel.run(async (context) => { 
    const wSheetName = 'Sheet1';
    const worksheet = context.workbook.worksheets.getItem(wSheetName);
    worksheet.position = 2;
    await context.sync(); 
});

protection

Возвращает объект защиты листа для листа.

readonly protection: Excel.WorksheetProtection;

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

Excel.WorksheetProtection

Комментарии

Набор API: ExcelApi 1.2

Примеры

// Unprotecting a worksheet with unprotect() will remove all 
// WorksheetProtectionOptions options applied to a worksheet.
// To remove only a subset of WorksheetProtectionOptions use the 
// protect() method and set the options you wish to remove to true.
await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getItem("Sheet1");
  sheet.protection.protect({
    allowInsertRows: false, // Protect row insertion
    allowDeleteRows: true // Unprotect row deletion
  });
});

shapes

Возвращает коллекцию всех объектов Shape на листе.

readonly shapes: Excel.ShapeCollection;

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

Excel.ShapeCollection

Комментарии

Набор API: ExcelApi 1.9

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-groups.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Shapes");

    const shapeGroup = sheet.shapes.getItem("Group").group;
    shapeGroup.ungroup();
    console.log("Shapes ungrouped");

    await context.sync();
});

showDataTypeIcons

Указывает, видны ли значки типов данных на листе. По умолчанию значки типов данных отображаются.

showDataTypeIcons: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.19

showGridlines

Указывает, видны ли линии сетки пользователю.

showGridlines: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.8

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/gridlines.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getActiveWorksheet();
    sheet.showGridlines = true;

    await context.sync();
});

showHeadings

Указывает, видны ли заголовки пользователю.

showHeadings: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.8

slicers

Возвращает коллекцию срезов, являющихся частью листа.

readonly slicers: Excel.SlicerCollection;

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

Excel.SlicerCollection

Комментарии

Набор API: ExcelApi 1.10

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-slicer.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Pivot");
    const slicer = sheet.slicers.add(
        "Farm Sales", /* The slicer data source. For PivotTables, this can be the PivotTable object reference or name. */
        "Type" /* The field in the data source to filter by. For PivotTables, this can be a PivotField object reference or ID. */
    );
    slicer.name = "Fruit Slicer";
    await context.sync();
});

standardHeight

Возвращает стандартную (по умолчанию) высоту всех строк на листе (в пунктах).

readonly standardHeight: number;

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

number

Комментарии

Набор API: ExcelApi 1.7

standardWidth

Определяет стандартную (стандартную) ширину всех столбцов на листе. Одна единица ширины столбца равна ширине одного символа в стиле "Обычный". Для пропорциональных шрифтов используется ширина символа 0 (ноль).

standardWidth: number;

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

number

Комментарии

Набор API: ExcelApi 1.7

tabColor

Цвет вкладки листа. Если при получении цвета вкладки лист невидимый, значение будет равно null. Если лист отображается, но для цвета вкладки выбрано значение "Автоматический", будет возвращена пустая строка. В противном случае свойству будет присвоен цвет в формате #RRGGBB (например, "FFA500"). При задании цвета используйте пустую строку, чтобы установить "авто" цвет или реальный цвет в противном случае.

tabColor: string;

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

string

Комментарии

Набор API: ExcelApi 1.7

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/tab-color.yaml

await Excel.run(async (context) => {
    const activeSheet = context.workbook.worksheets.getActiveWorksheet();
    activeSheet.tabColor = "#FF0000";

    await context.sync();
});

tabId

Возвращает значение, представляющее данный лист, которое может быть прочитано Open Office XML. Это целочисленное значение, которое отличается от worksheet.id (который возвращает глобальный уникальный идентификатор) и worksheet.name (который возвращает значение, например "Лист1").

readonly tabId: number;

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

number

Комментарии

Набор API: ExcelApi 1.14

tables

Коллекция таблиц, имеющихся на листе.

readonly tables: Excel.TableCollection;

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

Excel.TableCollection

Комментарии

Набор API: ExcelApi 1.1

tasks

Примечание

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

Возвращает набор задач, присутствующих на листе.

readonly tasks: Excel.DocumentTaskCollection;

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

Excel.DocumentTaskCollection

Комментарии

Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ)

verticalPageBreaks

Получает коллекцию вертикальных разрывов страницы для листа. Эта коллекция содержит только добавленные вручную разрывы страниц.

readonly verticalPageBreaks: Excel.PageBreakCollection;

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

Excel.PageBreakCollection

Комментарии

Набор API: ExcelApi 1.9

visibility

Видимость листа.

visibility: Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden";

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

Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden"

Комментарии

Набор API: ExcelApi 1.1 для видимости чтения; 1.2 для его настройки.

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-visibility.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("VisibilitySample");

    // Load the visibility property so it can be read after context.sync().
    sheet.load("name, visibility");

    await context.sync();

    console.log(`The visibility of worksheet "${sheet.name}" is ${sheet.visibility}.`);
});

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

activate()

Активация листа в пользовательском интерфейсе Excel.

activate(): void;

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

void

Комментарии

Набор API: ExcelApi 1.1

Примеры

await Excel.run(async (context) => { 
    const wSheetName = 'Sheet1';
    const worksheet = context.workbook.worksheets.getItem(wSheetName);
    worksheet.activate();
    await context.sync(); 
});

calculate(markAllDirty)

Вычисляет все ячейки на листе.

calculate(markAllDirty: boolean): void;

Параметры

markAllDirty

boolean

Правда, пометить все как грязные.

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

void

Комментарии

Набор API: ExcelApi 1.6

checkSpelling(options)

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

checkSpelling(options?: Excel.CheckSpellingOptions): void;

Параметры

options
Excel.CheckSpellingOptions

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

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

void

Комментарии

Набор API: ExcelApiDesktop 1.1

clearArrows()

Удаление стрелок трассировки с листа.

clearArrows(): void;

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

void

Комментарии

Набор API: ExcelApiDesktop 1.1

copy(positionType, relativeTo)

Копирует лист и размещает его в указанном месте.

copy(positionType?: Excel.WorksheetPositionType, relativeTo?: Excel.Worksheet): Excel.Worksheet;

Параметры

positionType
Excel.WorksheetPositionType

Место в книге, в которое следует поместить только что созданный лист. Значение по умолчанию — «None», при котором лист вставляется в его начало.

relativeTo
Excel.Worksheet

Существующий лист, определяющий положение только что созданного листа. Это нужно только в том случае, если positionType есть «До» или «После».

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

Excel.Worksheet

Только что созданный лист.

Комментарии

Набор API: ExcelApi 1.7

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-copy.yaml

await Excel.run(async (context) => {

    let myWorkbook = context.workbook;
    let sampleSheet = myWorkbook.worksheets.getActiveWorksheet();
    let copiedSheet = sampleSheet.copy("End")

    sampleSheet.load("name");
    copiedSheet.load("name");

    await context.sync();

    console.log("'" + sampleSheet.name + "' was copied to '" + copiedSheet.name + "'")
});

copy(positionType, relativeTo)

Копирует лист и размещает его в указанном месте.

copy(positionType?: "None" | "Before" | "After" | "Beginning" | "End", relativeTo?: Excel.Worksheet): Excel.Worksheet;

Параметры

positionType

"None" | "Before" | "After" | "Beginning" | "End"

Место в книге, в которое следует поместить только что созданный лист. Значение по умолчанию — «None», при котором лист вставляется в его начало.

relativeTo
Excel.Worksheet

Существующий лист, определяющий положение только что созданного листа. Это нужно только в том случае, если positionType есть «До» или «После».

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

Excel.Worksheet

Только что созданный лист.

Комментарии

Набор API: ExcelApi 1.7

delete()

Удаляет лист из книги. Обратите внимание, что если для листа задано значение "VeryHidden", операция удаления завершится сбоем с исключением InvalidOperation . Прежде чем удалять его, сначала измените видимость на скрытую или видимую.

delete(): void;

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

void

Комментарии

Набор API: ExcelApi 1.1

Примеры

await Excel.run(async (context) => { 
    const wSheetName = 'Sheet1';
    const worksheet = context.workbook.worksheets.getItem(wSheetName);
    worksheet.delete();
    await context.sync(); 
});

evaluate(name)

Возвращает результат вычисления строки формулы. Поддерживается только ввод формул. Если имя формулы недопустимо, возникает InvalidArgument ошибка.

evaluate(name: string): OfficeExtension.ClientResult<any>;

Параметры

name

string

Имя формулы для выполнения.

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

OfficeExtension.ClientResult<any>

Комментарии

Набор API: ExcelApiDesktop 1.1

findAll(text, criteria)

Находит все вхождения заданной строки на основе указанных условий и возвращает их как RangeAreas объект, состоящий из одного или нескольких прямоугольных диапазонов. Содержимое скрытых листов не возвращается.

findAll(text: string, criteria: Excel.WorksheetSearchCriteria): Excel.RangeAreas;

Параметры

text

string

Строка, которую нужно найти.

criteria
Excel.WorksheetSearchCriteria

Дополнительные критерии поиска, включая необходимость поиска во всей ячейке или с учетом регистра.

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

Excel.RangeAreas

Объект RangeAreas , состоящий из одного или нескольких прямоугольных диапазонов, соответствующий условиям поиска. Если ни одна ячейка не соответствует этому условию, будет выведена ItemNotFound ошибка.

Комментарии

Набор API: ExcelApi 1.9

findAllOrNullObject(text, criteria)

Находит все вхождения заданной строки на основе указанных условий и возвращает их как RangeAreas объект, состоящий из одного или нескольких прямоугольных диапазонов. Содержимое скрытых листов не возвращается.

findAllOrNullObject(text: string, criteria: Excel.WorksheetSearchCriteria): Excel.RangeAreas;

Параметры

text

string

Строка, которую нужно найти.

criteria
Excel.WorksheetSearchCriteria

Дополнительные критерии поиска, включая необходимость поиска во всей ячейке или с учетом регистра.

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

Excel.RangeAreas

Объект RangeAreas , состоящий из одного или нескольких прямоугольных диапазонов, соответствующий условиям поиска. Если совпадений нет, этот метод возвращает объект со свойством isNullObject , установленным в true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

Комментарии

Набор API: ExcelApi 1.9

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-find-all.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const foundRanges = sheet.findAllOrNullObject("Complete", {
        completeMatch: true,
        matchCase: false
    });

    await context.sync();

    if (foundRanges.isNullObject) {
        console.log("No complete projects");
    } else {
        foundRanges.format.fill.color = "green"
    }
});

getCell(row, column)

Получает объект, Range содержащий одну ячейку, на основе номеров строк и столбцов. Ячейка может находиться за пределами родительского диапазона, если она остается в сетке листа.

getCell(row: number, column: number): Excel.Range;

Параметры

row

number

Номер строки ячейки, которую требуется извлечь. Используется нулевой индекс.

column

number

Номер столбца ячейки, которую требуется извлечь. Используется нулевой индекс.

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

Excel.Range

Комментарии

Набор API: ExcelApi 1.1

Примеры

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8";
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const cell = worksheet.getCell(0,0);
    cell.load('address');
    await context.sync();

    console.log(cell.address);
});

getNext(visibleOnly)

Получает рабочий лист, следующий за этим листом. Если после этого листа нет листов, этот метод выдаст ошибку.

getNext(visibleOnly?: boolean): Excel.Worksheet;

Параметры

visibleOnly

boolean

Необязательный параметр. Если true, рассматриваются только видимые листы, пропуская скрытые.

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

Excel.Worksheet

Комментарии

Набор API: ExcelApi 1.5

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/reference-worksheets-by-relative-position.yaml

await Excel.run(async (context) => {
    const sheets = context.workbook.worksheets;

    // We don't want to include the default worksheet that was created
    // when the workbook was created, so our "firstSheet" will be the one
    // after the literal first. Note chaining of navigation methods.
    const firstSheet = sheets.getFirst().getNext();
    const lastSheet = sheets.getLast();
    const firstTaxRateRange = firstSheet.getRange("B2");
    const lastTaxRateRange = lastSheet.getRange("B2");

    firstSheet.load("name");
    lastSheet.load("name");
    firstTaxRateRange.load("text");
    lastTaxRateRange.load("text");

    await context.sync();

    let firstYear = firstSheet.name.substr(5, 4);
    let lastYear = lastSheet.name.substr(5, 4);
    console.log(`Tax Rate change from ${firstYear} to ${lastYear}`, `Tax rate for ${firstYear}: ${firstTaxRateRange.text[0][0]}\nTax rate for ${lastYear}: ${lastTaxRateRange.text[0][0]}`)

    await context.sync();
});

getNextOrNullObject(visibleOnly)

Получает рабочий лист, следующий за этим листом. Если после этого листа нет листов, этот метод возвращает объект со isNullObject свойством true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

getNextOrNullObject(visibleOnly?: boolean): Excel.Worksheet;

Параметры

visibleOnly

boolean

Необязательный параметр. Если true, рассматриваются только видимые листы, пропуская скрытые.

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

Excel.Worksheet

Комментарии

Набор API: ExcelApi 1.5

getPrevious(visibleOnly)

Получение предыдущего листа. Если таких листов нет, возникает ошибка.

getPrevious(visibleOnly?: boolean): Excel.Worksheet;

Параметры

visibleOnly

boolean

Необязательный параметр. Если true, рассматриваются только видимые листы, пропуская скрытые.

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

Excel.Worksheet

Комментарии

Набор API: ExcelApi 1.5

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/reference-worksheets-by-relative-position.yaml

await Excel.run(async (context) => {
    const sheets = context.workbook.worksheets;
    const currentSheet = sheets.getActiveWorksheet();
    const previousYearSheet = currentSheet.getPrevious();
    const currentTaxDueRange = currentSheet.getRange("C2");
    const previousTaxDueRange = previousYearSheet.getRange("C2");

    currentSheet.load("name");
    previousYearSheet.load("name");
    currentTaxDueRange.load("text");
    previousTaxDueRange.load("text");

    await context.sync();

    let currentYear = currentSheet.name.substr(5, 4);
    let previousYear = previousYearSheet.name.substr(5, 4);
    console.log("Two Year Tax Due Comparison", `Tax due for ${currentYear} was ${currentTaxDueRange.text[0][0]}\nTax due for ${previousYear} was ${previousTaxDueRange.text[0][0]}`)

    await context.sync();
});

getPreviousOrNullObject(visibleOnly)

Получение предыдущего листа. Если предыдущих листов нет, этот метод возвращает объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

getPreviousOrNullObject(visibleOnly?: boolean): Excel.Worksheet;

Параметры

visibleOnly

boolean

Необязательный параметр. Если true, рассматриваются только видимые листы, пропуская скрытые.

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

Excel.Worksheet

Комментарии

Набор API: ExcelApi 1.5

getRange(address)

Получает Range объект, представляющий собой один прямоугольный блок ячеек, заданный по адресу или имени.

getRange(address?: string): Excel.Range;

Параметры

address

string

Необязательный параметр. Строка, представляющая адрес или имя диапазона. Например, "A1:B2". Если аргумент не указан, возвращается весь диапазон листа. Максимальная address длина составляет 8192 символа. Если адрес превышает ограничение символов, этот метод возвращает InvalidArgument ошибку.

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

Excel.Range

Комментарии

Набор API: ExcelApi 1.1

Примеры

// Use the range address to get the range object.
await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8";
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const range = worksheet.getRange(rangeAddress);
    range.load('cellCount');
    await context.sync();
    
    console.log(range.cellCount);
});

getRangeByIndexes(startRow, startColumn, rowCount, columnCount)

Получает объект, Range начинающийся с определенного индекса строки и индекса столбца и охватывающий определенное количество строк и столбцов.

getRangeByIndexes(startRow: number, startColumn: number, rowCount: number, columnCount: number): Excel.Range;

Параметры

startRow

number

Начальная строка (с нулевым индексом).

startColumn

number

Столбец "Пуск" (с нулевой индексацией).

rowCount

number

Количество строк, включаемых в диапазон.

columnCount

number

Количество столбцов для включения в диапазон.

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

Excel.Range

Комментарии

Набор API: ExcelApi 1.7

getRanges(address)

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

getRanges(address?: string): Excel.RangeAreas;

Параметры

address

string

Необязательный параметр. Строка, содержащая адреса либо имена отдельных диапазонов, разделенных запятыми или точкой с запятой. Например: "A1:B2, A5:B5" или "A1:B2; A5:B5". Если параметр не задан, RangeAreas возвращается объект для всего листа.

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

Excel.RangeAreas

Комментарии

Набор API: ExcelApi 1.9

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-areas.yaml

await Excel.run(async (context) => {

    const sheet = context.workbook.worksheets.getActiveWorksheet();
    const specifiedRanges = sheet.getRanges("D3:D5, G3:G5");
    specifiedRanges.format.fill.color = "pink";

    await context.sync();
})

getUsedRange(valuesOnly)

Используемый диапазон — это наименьший диапазон, включающий в себя все ячейки с определенным значением или форматированием. Если весь лист пуст, эта функция возвращает верхнюю левую ячейку (т. е. не выдает ошибки).

getUsedRange(valuesOnly?: boolean): Excel.Range;

Параметры

valuesOnly

boolean

Необязательный параметр. Если true, в качестве используемых ячеек рассматриваются только ячейки со значениями (форматирование игнорируется). [Набор API: ExcelApi 1.2]

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

Excel.Range

Комментарии

Набор API: ExcelApi 1.1

Примеры

await Excel.run(async (context) => { 
    const wSheetName = 'Sheet1';
    const worksheet = context.workbook.worksheets.getItem(wSheetName);
    const usedRange = worksheet.getUsedRange();
    usedRange.load('address');
    await context.sync();
    
    console.log(usedRange.address);
});

getUsedRangeOrNullObject(valuesOnly)

Используемый диапазон — это наименьший диапазон, включающий в себя все ячейки с определенным значением или форматированием. Если весь лист пустой, этот метод возвращает объект со isNullObject свойством true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

getUsedRangeOrNullObject(valuesOnly?: boolean): Excel.Range;

Параметры

valuesOnly

boolean

Необязательный параметр. Учитывает только ячейки со значениями.

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

Excel.Range

Комментарии

Набор API: ExcelApi 1.4

load(options)

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

load(options?: Excel.Interfaces.WorksheetLoadOptions): Excel.Worksheet;

Параметры

options
Excel.Interfaces.WorksheetLoadOptions

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

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

Excel.Worksheet

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.

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

Excel.Worksheet

Примеры

// Get worksheet properties based on sheet name.
await Excel.run(async (context) => { 
    const wSheetName = 'Sheet1';
    const worksheet = context.workbook.worksheets.getItem(wSheetName);
    worksheet.load('position')
    await context.sync();
    
    console.log(worksheet.position);
});

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

Excel.Worksheet

replaceAll(text, replacement, criteria)

Находит и заменяет определенную строку на основе условий, указанных в текущем листе.

replaceAll(text: string, replacement: string, criteria: Excel.ReplaceCriteria): OfficeExtension.ClientResult<number>;

Параметры

text

string

Строка для поиска.

replacement

string

Строка, заменяющая исходную строку.

criteria
Excel.ReplaceCriteria

Дополнительные условия замены.

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

OfficeExtension.ClientResult<number>

Количество выполненных замен.

Комментарии

Набор API: ExcelApi 1.9

set(properties, options)

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

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

Параметры

properties
Excel.Interfaces.WorksheetUpdateData

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

options
OfficeExtension.UpdateOptions

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

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

void

Примеры

// Set the color and name of the current worksheet.
await Excel.run(async (context) => {
  const activeSheet = context.workbook.worksheets.getActiveWorksheet();
  activeSheet.set({
    tabColor: "yellow",
    name: "MySheet"
  });

  await context.sync();
});

set(properties)

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

set(properties: Excel.Worksheet): void;

Параметры

properties
Excel.Worksheet

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

void

showOutlineLevels(rowLevels, columnLevels)

Показывает группы строк и столбцов по уровням структуры. Структурирование, группировка и обобщение списка данных на листе. Параметры rowLevels и columnLevels определяют, сколько уровней контура будет отображаться. Допустимый диапазон аргументов находится в диапазоне от 0 до 8. Значение 0 не влияет на текущее отображение. Если значение больше текущего количества уровней, отображают все уровни.

showOutlineLevels(rowLevels: number, columnLevels: number): void;

Параметры

rowLevels

number

Количество уровней строк структуры для отображения.

columnLevels

number

Количество уровней столбцов структуры для отображения.

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

void

Комментарии

Набор API: ExcelApi 1.10

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/outline.yaml

Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getActiveWorksheet();

    // This shows the top 3 outline levels; collapsing any additional sublevels.
    sheet.showOutlineLevels(3, 3);
    await context.sync();
});

toJSON()

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

toJSON(): Excel.Interfaces.WorksheetData;

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

Excel.Interfaces.WorksheetData

Сведения о событии

onActivated

Возникает при активации листа.

readonly onActivated: OfficeExtension.EventHandlers<Excel.WorksheetActivatedEventArgs>;

Тип события

OfficeExtension.EventHandlers<Excel.WorksheetActivatedEventArgs>

Комментарии

Набор API: ExcelApi 1.7

Примеры

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    sheet.onActivated.add(function (event) {
        return Excel.run(async (context) => {
            console.log("The activated worksheet ID is: " + event.worksheetId);
            await context.sync();
        });
    });
    await context.sync();
});

onCalculated

Возникает при пересчете листа.

readonly onCalculated: OfficeExtension.EventHandlers<Excel.WorksheetCalculatedEventArgs>;

Тип события

OfficeExtension.EventHandlers<Excel.WorksheetCalculatedEventArgs>

Комментарии

Набор API: ExcelApi 1.8

Примеры

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    sheet.onCalculated.add(function (event) {
        return Excel.run(async (context) => {
            console.log("The worksheet has recalculated.");
            await context.sync();
        });
    });
    await context.sync();
});

onCalculationBusy

Примечание

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

Возникают, когда ячейки на листе вычисляются асинхронно.

Это событие запускается в конце цикла вычислений, аналогично onCalculated самому событию. Обычно, когда завершается вычисление для ячейки, onCalculated запускается событие. Однако если при вычислении в ячейке помещается временное ожидающее значение (например, "#BUSY!"), оно запускается, чтобы показать, onCalculationBusy что состояние ячейки изменилось, хотя вычисление окончательного значения еще не завершено. Когда последующий цикл вычислений завершает вычисление этой ячейки onCalculated , запускается событие.

Функции формул, такие как функции JavaScript User-Defined и формулы =PY, могут вызывать это событие.

readonly onCalculationBusy: OfficeExtension.EventHandlers<Excel.WorksheetCalculationBusyEventArgs>;

Тип события

OfficeExtension.EventHandlers<Excel.WorksheetCalculationBusyEventArgs>

Комментарии

Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ)

onChanged

Возникает при изменении данных на определенном листе.

readonly onChanged: OfficeExtension.EventHandlers<Excel.WorksheetChangedEventArgs>;

Тип события

OfficeExtension.EventHandlers<Excel.WorksheetChangedEventArgs>

Комментарии

Набор API: ExcelApi 1.7

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-worksheet.yaml

await Excel.run(async (context) => {
    let sheet = context.workbook.worksheets.getItem("Sample");
    sheet.onChanged.add(onChange);
    await context.sync();

    console.log("Added a worksheet-level data-changed event handler.");
});

onColumnSorted

Возникает при сортировке одного или нескольких столбцов. Это происходит в результате операции сортировки слева направо.

readonly onColumnSorted: OfficeExtension.EventHandlers<Excel.WorksheetColumnSortedEventArgs>;

Тип события

OfficeExtension.EventHandlers<Excel.WorksheetColumnSortedEventArgs>

Комментарии

Набор API: ExcelApi 1.10

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/event-column-and-row-sort.yaml

await Excel.run(async (context) => {
    console.log("Adding column handler");
    const sheet = context.workbook.worksheets.getActiveWorksheet();

    // This will fire whenever a column has been moved as the result of a sort action.
    sheet.onColumnSorted.add((event) => {
        return Excel.run((context) => {
            console.log("Column sorted: " + event.address);
            const sheet = context.workbook.worksheets.getActiveWorksheet();

            // Clear formatting for section, then highlight the sorted area.
            sheet.getRange("A1:E5").format.fill.clear();
            if (event.address !== "") {
                sheet.getRanges(event.address).format.fill.color = "yellow";
            }

            return context.sync();
        });
    });
});

onDeactivated

Возникает при деактивации листа.

readonly onDeactivated: OfficeExtension.EventHandlers<Excel.WorksheetDeactivatedEventArgs>;

Тип события

OfficeExtension.EventHandlers<Excel.WorksheetDeactivatedEventArgs>

Комментарии

Набор API: ExcelApi 1.7

Примеры

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    sheet.onDeactivated.add(function (event) {
        return Excel.run(async (context) => {
            console.log("The deactivated worksheet is: " + event.worksheetId);
            await context.sync();
        });
    });
    await context.sync();
});

onFiltered

Примечание

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

Возникает при применении фильтра к определенному листу.

readonly onFiltered: OfficeExtension.EventHandlers<Excel.WorksheetFilteredEventArgs>;

Тип события

OfficeExtension.EventHandlers<Excel.WorksheetFilteredEventArgs>

Комментарии

Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ)

onFormatChanged

Возникает, если изменен формат указанного листа.

readonly onFormatChanged: OfficeExtension.EventHandlers<Excel.WorksheetFormatChangedEventArgs>;

Тип события

OfficeExtension.EventHandlers<Excel.WorksheetFormatChangedEventArgs>

Комментарии

Набор API: ExcelApi 1.9

onFormulaChanged

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

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

readonly onFormulaChanged: OfficeExtension.EventHandlers<Excel.WorksheetFormulaChangedEventArgs>;

Тип события

OfficeExtension.EventHandlers<Excel.WorksheetFormulaChangedEventArgs>

Комментарии

Набор API: ExcelApi 1.13

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-formula-changed.yaml

await Excel.run(async (context) => {
  // Retrieve the worksheet named "Sample".
  let sheet = context.workbook.worksheets.getItem("Sample");
  
  // Register the formula changed event handler for this worksheet.
  sheet.onFormulaChanged.add(formulaChangeHandler);
  await context.sync();
  
  console.log("Registered a formula changed event handler for this worksheet.");
});

...

async function formulaChangeHandler(event: Excel.WorksheetFormulaChangedEventArgs) {
  await Excel.run(async (context) => {
    // Retrieve details about the formula change event.
    const cellAddress = event.formulaDetails[0].cellAddress;
    const previousFormula = event.formulaDetails[0].previousFormula;
    const source = event.source;
    
    // Print out the change event details.
    console.log(
      `The formula in cell ${cellAddress} changed. 
      The previous formula was: ${previousFormula}. 
      The source of the change was: ${source}.`
    );
  });
}

onNameChanged

Возникает при изменении имени листа.

readonly onNameChanged: OfficeExtension.EventHandlers<Excel.WorksheetNameChangedEventArgs>;

Тип события

OfficeExtension.EventHandlers<Excel.WorksheetNameChangedEventArgs>

Комментарии

Набор API: ExcelApi 1.17

onProtectionChanged

Возникает при изменении состояния защиты листа.

readonly onProtectionChanged: OfficeExtension.EventHandlers<Excel.WorksheetProtectionChangedEventArgs>;

Тип события

OfficeExtension.EventHandlers<Excel.WorksheetProtectionChangedEventArgs>

Комментарии

Набор API: ExcelApi 1.14

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-worksheet-protection.yaml

// This function registers an event handler for the onProtectionChanged event of a worksheet.
await Excel.run(async (context) => {
    // Set "Sample" as the active worksheet.
    context.workbook.worksheets.getItemOrNullObject("Sample").delete();
    const sheet = context.workbook.worksheets.add("Sample");
    sheet.activate();

    // Register the onProtectionChanged event handler.
    sheet.onProtectionChanged.add(checkProtection);
    await context.sync();
    console.log("Added a worksheet protection change event handler.");
});

...

async function checkProtection(event: Excel.WorksheetProtectionChangedEventArgs) {
    // This function is an event handler that returns the protection status of a worksheet
    // and information about the changed worksheet.
    await Excel.run(async (context) => {
        const protectionStatus = event.isProtected;
        const worksheetId = event.worksheetId;
        const source = event.source;
        console.log("Protection status changed. Protection status is now: " + protectionStatus + ".");
        console.log("    ID of changed worksheet: " + worksheetId + ".");
        console.log("    Source of change event: " + source + ".");
    });
}

onRowHiddenChanged

Возникают, когда на листе изменилось скрытое состояние одной или нескольких строк.

readonly onRowHiddenChanged: OfficeExtension.EventHandlers<Excel.WorksheetRowHiddenChangedEventArgs>;

Тип события

OfficeExtension.EventHandlers<Excel.WorksheetRowHiddenChangedEventArgs>

Комментарии

Набор API: ExcelApi 1.11

Примеры

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getActiveWorksheet();
    sheet.onRowHiddenChanged.add(function (event) {
        return Excel.run(async (context) => {
            console.log(`Row ${event.address} is now ${event.changeType}`);
            await context.sync();
        });
    });
    await context.sync();
});

onRowSorted

Возникает при сортировке одной или нескольких строк. Происходит в результате операции сортировки сверху вниз.

readonly onRowSorted: OfficeExtension.EventHandlers<Excel.WorksheetRowSortedEventArgs>;

Тип события

OfficeExtension.EventHandlers<Excel.WorksheetRowSortedEventArgs>

Комментарии

Набор API: ExcelApi 1.10

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/event-column-and-row-sort.yaml

await Excel.run(async (context) => {
    console.log("Adding row handler");
    const sheet = context.workbook.worksheets.getActiveWorksheet();

    // This will fire whenever a row has been moved as the result of a sort action.
    sheet.onRowSorted.add((event) => {
        return Excel.run((context) => {
            console.log("Row sorted: " + event.address);
            const sheet = context.workbook.worksheets.getActiveWorksheet();

            // Clear formatting for section, then highlight the sorted area.
            sheet.getRange("A1:E5").format.fill.clear();
            if (event.address !== "") {
                sheet.getRanges(event.address).format.fill.color = "yellow";
            }

            return context.sync();
        });
    });
});

onSelectionChanged

Возникает при изменении выделения на определенном листе.

readonly onSelectionChanged: OfficeExtension.EventHandlers<Excel.WorksheetSelectionChangedEventArgs>;

Тип события

OfficeExtension.EventHandlers<Excel.WorksheetSelectionChangedEventArgs>

Комментарии

Набор API: ExcelApi 1.7

Примеры

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    sheet.onSelectionChanged.add(function (event) {
        return Excel.run(async (context) => {
            console.log("The selected range has changed to: " + event.address);
            await context.sync();
        });
    });
    await context.sync();
});

onSingleClicked

Возникает при щелчке левой кнопкой мыши или касании на листе. Это событие не будет запускаться при нажатии в следующих случаях:

  • Пользователь перетаскивает мышь для множественного выбора.

  • Пользователь выбирает ячейку в режиме, в котором выделены аргументы ячейки для ссылок на формулы.

readonly onSingleClicked: OfficeExtension.EventHandlers<Excel.WorksheetSingleClickedEventArgs>;

Тип события

OfficeExtension.EventHandlers<Excel.WorksheetSingleClickedEventArgs>

Комментарии

Набор API: ExcelApi 1.10

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/event-worksheet-single-click.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getActiveWorksheet();
    sheet.onSingleClicked.add((event) => {
        return Excel.run((context) => {
            console.log(`Click detected at ${event.address} (pixel offset from upper-left cell corner: ${event.offsetX}, ${event.offsetY})`);
            return context.sync();
        });
    });

    console.log("The worksheet click handler is registered.");

    await context.sync();
});

onVisibilityChanged

Возникает при изменении видимости листа.

readonly onVisibilityChanged: OfficeExtension.EventHandlers<Excel.WorksheetVisibilityChangedEventArgs>;

Тип события

OfficeExtension.EventHandlers<Excel.WorksheetVisibilityChangedEventArgs>

Комментарии

Набор API: ExcelApi 1.17

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-visibility.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("VisibilitySample");

    // Register an event handler for visibility changes to this worksheet.
    sheet.onVisibilityChanged.add(onWorksheetVisibilityChanged);

    await context.sync();
    console.log("Registered the worksheet visibility changed event handler.");
});

...

async function onWorksheetVisibilityChanged(args: Excel.WorksheetVisibilityChangedEventArgs) {
    console.log(`Worksheet event: Visibility changed from ${args.visibilityBefore} to ${args.visibilityAfter}.`);
}