Набор требований API JavaScript Excel только для веб-служб

Набор ExcelApiOnline требований — это особый набор требований, включающий функции, доступные только в Excel в Интернете. API в этом наборе требований считаются рабочими API (не подверженными недокументированным поведенческим или структурным изменениям) для приложения "Excel в Интернете". ExcelApiOnline API считаются "предварительными" API для других платформ (Windows, Mac, iOS) и могут не поддерживаться ни одной из этих платформ.

Если API в наборе ExcelApiOnline требований поддерживаются на всех платформах, они будут добавлены в следующий выпущенный набор требований (ExcelApi 1.[NEXT]). Как только этот новый набор требований станет общедоступным, эти API будут удалены из ExcelApiOnline. Думайте об этом как о процессе продвижения API, переходящего от предварительной версии к выпуску.

Важно!

ExcelApiOnline является надмножеством последнего пронумерованного набора требований.

Важно!

ExcelApiOnline 1.1 — единственная версия API, доступных только через Интернет. Это связано с тем, что пользователям всегда будет доступна одна версия Excel в Интернете, которая является последней версией.

В следующей таблице представлена краткая сводка API, а в следующей таблице со списком API — подробный список текущих ExcelApiOnline API.

Функциональная область Описание Соответствующие объекты
Связанные книги Управление связями между книгами, включая поддержку обновления и разрыва связей между книгами. LinkedWorkbook, LinkedWorkbookCollection
Представления именованных листов Обеспечивает программное управление представлениями листа для отдельных пользователей. NamedSheetView, NamedSheetViewCollection
События перемещения листа Определять, когда листы перемещаются в коллекции, положение листа и источник изменений. WorksheetCollection, WorksheetMovedEventArgs
Защита листа Не позволяет неавторизованным пользователям изменять указанные диапазоны на листе. WorksheetProtection, AllowEditRange, AllowEditRangeCollection, AllowEditRangeOptions

Поскольку ExcelApiOnline API поддерживаются только Excel в Интернете, ваша надстройка должна проверка, поддерживается ли набор требований, прежде чем вызывать эти API. Это позволяет избежать вызова API, доступного только в сети, на другой платформе.

if (Office.context.requirements.isSetSupported("ExcelApiOnline", "1.1")) {
   // Any API exclusive to the ExcelApiOnline requirement set.
}

После того как API будет включен в набор кроссплатформенных требований, необходимо удалить или изменить isSetSupported проверку. Это позволит включить функцию вашей надстройки на других платформах. Обязательно протестируйте эту функцию на этих платформах при внесении этого изменения.

Важно!

Манифест нельзя указать ExcelApiOnline 1.1 в качестве требования активации. Недопустимое значение для элемента Set.

Список API

В следующей таблице перечислены API JavaScript Excel, которые в настоящее время включены в ExcelApiOnline набор требований. Полный список всех API JavaScript для Excel (включая ExcelApiOnline API и ранее выпущенные API) см. в разделе "Все API JavaScript для Excel".

Класс Поля Описание
Объект AllowEditRange address Указывает диапазон, связанный с объектом.
delete() Удаляет объект из AllowEditRangeCollectionфайла .
isPasswordProtected Указывает, защищен ли объект паролем.
pauseProtection(password?: string) Приостанавливает защиту листа для объекта для пользователя в текущем сеансе.
setPassword(password?:string) Изменяет пароль, связанный с объектом.
заголовок Задает название объекта.
AllowEditRangeCollection add(title: string, rangeAddress: string, options?: Excel.AllowEditRangeOptions) Добавление AllowEditRange объекта на лист.
getCount() Возвращает количество AllowEditRange объектов в семействе.
getItem(key: string) Получает AllowEditRange объект по его имени.
getItemAt(index: number) Возвращает AllowEditRange объект по его индексу в коллекции.
getItemOrNullObject(key: string) Получает AllowEditRange объект по его имени.
items Получает загруженные дочерние элементы в этой коллекции.
pauseProtection(пароль: строка) Приостанавливает защиту листа для всех AllowEditRange найденных на этом листе объектов с заданным паролем для пользователя в текущем сеансе.
AllowEditRangeOptions password Пароль, связанный с доменом AllowEditRange.
LinkedWorkbook breakLinks() Создает запрос на разрыв ссылок, указывающих на связанную книгу.
id Исходный URL-адрес, указывающий на связанную книгу.
refresh() Создает запрос на обновление данных, полученных из связанной книги.
LinkedWorkbookCollection breakAllLinks() Разрывает все ссылки на связанные книги.
getItem(key: string) Получает сведения о связанной книге по ее URL-адресу.
getItemOrNullObject(key: string) Получает сведения о связанной книге по ее URL-адресу.
items Получает загруженные дочерние элементы в этой коллекции.
refreshAll() Создает запрос на обновление всех ссылок в книге.
workbookLinksRefreshMode Представляет режим обновления ссылок книги.
NamedSheetView activate() Активирует представление листа.
delete() Удаляет с листа представление листа.
Duplicate(name?:string) Создает копию этого представления листа.
name Указывает имя представления листа.
NamedSheetViewCollection add(name: string) Создает новое представление листа с заданным именем.
enterTemporary() Создание и активация нового временного представления листа.
exit() Завершает активное представление листа.
getActive() Получение активного в данный момент представления листа на листе.
getCount() Получает количество представлений листов на этом листе.
getItem(key: string) Получение представления листа с его именем.
getItemAt(index: number) Получение представления листа по его индексу в коллекции.
items Получает загруженные дочерние элементы в этой коллекции.
TableRowCollection deleteRows(rows: number[] | Строка таблицы[]) Удаление нескольких строк из таблицы.
deleteRowsAt(index: number, number?: number) Удаление указанного количества строк из таблицы, начиная с заданного индекса.
Workbook linkedКниги Возвращает коллекцию связанных книг.
Worksheet namedSheetViews Возвращает набор представлений листов, присутствующих на листе.
WorksheetProtection allowEditRanges Обозначает объект, найденный AllowEditRangeCollection на этом листе.
canPauseProtection Указывает, можно ли приостановить защиту для этого листа.
checkPassword(password?:string) Указывает, можно ли использовать пароль для снятия защиты листа.
isPasswordProtected Указывает, защищен ли лист паролем.
isPaused Указывает, приостановлена ли защита листа.
pauseProtection(password?: string) Приостанавливает защиту листа для указанного объекта листа для пользователя в текущем сеансе.
resumeProtection() Возобновляет защиту листа для данного объекта листа для пользователя в данном сеансе.
savedOptions Определяет параметры защиты, сохраненные на листе.
setPassword(password?:string) Изменяет пароль, связанный с объектом WorksheetProtection .
updateOptions(options: Excel.WorksheetProtectionOptions) Изменение параметров защиты листа, связанных с объектом WorksheetProtection .
WorksheetProtectionChangedEventArgs allowEditRangesChanged Указывает, AllowEditRange изменился ли какой-либо из объектов.
protectionOptionsChanged Указывает, изменились ли они WorksheetProtectionOptions .
sheetPasswordChanged Указывает, изменился ли пароль листа.

См. также

  • Last updated on