Excel JavaScript API только для классического приложения — набор требований 1.1

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

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

Важно!

ExcelApiDesktop 1.1 предназначен только для настольных компьютеров. Это надмножество ExcelApi 1.21.

ExcelApiDesktop 1.1 Поскольку API поддерживаются только Excel для Windows и Mac, ваша надстройка должна проверка, поддерживается ли набор требований, прежде чем вызывать эти API. Это позволяет избежать любых попыток использовать API-интерфейсы только для настольных компьютеров на неподдерживаемой платформе.

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

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

Важно!

Манифест только для надстроек (XML) не может указывать наборы требований только для настольных компьютеров или только через Интернет в качестве требований к активации. Недопустимое значение для элемента Set. Унифицированный манифест поддерживает в свойстве "requirements.capabilities" наборы требований только для настольных компьютеров.

Список API

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

Класс Поля Описание
Application activeWindow Возвращает объект, window представляющий активное окно (окно сверху).
checkSpelling(word:string, options?: Excel.CheckSpellingOptions) Проверяет орфографию в отдельном слове.
enterEditingMode() Переход в режим редактирования для выделенного диапазона активного листа.
union(firstRange: Range | RangeAreas, secondRange: Диапазон | RangeAreas, ... additionalRanges: (Диапазон | RangeAreas)[]) Возвращает объект, RangeAreas представляющий объединение двух или более Range объектов RangeAreas .
Windows Возвращает все открытые окна Excel.
CheckSpellingOptions customDictionary Необязательный параметр.
ignoreUppercase Необязательный параметр.
HeaderFooter centerFooterPicture Получает HeaderFooterPicture объект, представляющий рисунок для центральной части нижнего колонтитула.
centerHeaderPicture Получает HeaderFooterPicture объект, представляющий рисунок для центральной части верхнего колонтитула.
leftFooterPicture Получает объект, HeaderFooterPicture представляющий рисунок для левой части нижнего колонтитула.
leftHeaderPicture Получает объект, HeaderFooterPicture который представляет рисунок для левой части верхнего колонтитула.
rightFooterPicture Получает объект, HeaderFooterPicture представляющий рисунок для правой части нижнего колонтитула.
rightHeaderPicture Получает объект, HeaderFooterPicture который представляет рисунок для правой части верхнего колонтитула.
ЗаголовокFooterPicture яркость Определяет яркость рисунка.
colorType Определяет тип цветового преобразования рисунка.
контрастность Определяет контрастность рисунка.
кропВнизу Количество точек, обрезаемых в нижней части рисунка.
обрезать слева Определяет количество точек, обрезаемых в левой части рисунка.
кропРайт Количество точек, обрезаемых в правой части рисунка.
cropTop Указывает количество точек, обрезаемых в верхней части рисунка.
имя файла Указывает URL-адрес (в интрасети или в Интернете) или путь (локальный или сетевый) к расположению, в котором сохранен исходный объект.
height Указывает высоту рисунка в точках.
lockAspectRatio Указывает, сохраняет ли рисунок исходные пропорции при изменении размера.
width Ширина рисунка в точках.
Image яркость Определяет яркость изображения.
colorType Определяет тип преобразования цвета, примененный к изображению.
контрастность Определяет контрастность изображения.
кропВнизу Указывает количество точек, обрезаемых в нижней части изображения.
обрезать слева Указывает количество точек, обрезаемых в левой части изображения.
кропРайт Указывает количество точек, обрезаемых в правой части изображения.
cropTop Указывает количество точек, обрезаемых в верхней части изображения.
incrementBrightness(increment: число) Увеличение яркости изображения на указанную величину.
incrementContrast(increment: число) Увеличение контрастности изображения на указанную величину.
PageLayout alignMarginsHeaderFooter Выравнивает ли Excel верхний и нижний колонтитулы по полям, заданным в параметрах параметры страницы.
printQuality Указывает двухэлементный массив, содержащий значения качества печати по горизонтали и по вертикали.
Панель index Возвращает индекс области.
PaneCollection getCount() Возвращает количество областей в коллекции.
getItemAt(index: number) Получение области в коллекции по индексу.
items Получает загруженные дочерние элементы в этой коллекции.
Range checkSpelling(options?: Excel.CheckSpellingOptions) Проверяет орфографию в словах в этом диапазоне.
formulaArray Определяет формулу массива диапазона.
showDependents(удалить?: логический) Выводит стрелки трассировки на прямые зависимые от диапазона объекты.
showPrecedents(удалить?: логический) Проводит стрелки трассировки к непосредственным предшественникам диапазона.
Window activate() Активирует окно.
activateNext() Активация следующего окна.
activatePrevious() Активация предыдущего окна.
activeCell Получение активной ячейки в окне.
activePane Получение активной области в окне.
activeWorksheet Получение активного листа в окне.
autoFilterDateGroupingEnabled Указывает, включена ли в окне группировка по дате с помощью автофильтра.
close() Закрытие окна.
enableResize Указывает, включено ли изменение размера для окна.
freezepanes Указывает, закреплены ли панели в окне.
height Указывает высоту окна.
index Получает индекс окна.
isVisible Указывает, отображается ли окно.
largeScroll(Вниз: число, Вверх: число, ToRight: число, ToLeft: число) Прокрутка окна на несколько страниц.
left Указывает расстояние в точках от левого края экрана компьютера до левого края окна.
name Указывает имя окна.
newWindow() Открытие нового окна Excel.
области Получает коллекцию областей, связанных с окном.
pointsToScreenPixelsX(точки: число) Преобразует горизонтальные точки в пиксели экрана.
pointsToScreenPixelsY(баллы: число) Преобразует вертикальные точки в пиксели экрана.
scrollColumn Указывает столбец прокрутки окна.
scrollIntoView(Left: число, Top: число, Width: число, Height: number, Start?: boolean) Прокручивает окно, чтобы увидеть указанный диапазон.
scrollRow Указывает строку прокрутки окна.
scrollWorkbookTabs(Sheets?: number, Position?: Excel.ScrollWorkbookTabPosition) Прокрутка вкладок книги.
showFormulas Указывает, отображаются ли формулы в окне.
показатьСеткаЛинии Указывает, отображаются ли линии сетки в окне.
showHeadings Указывает, отображаются ли заголовки в окне.
showHorizontalScrollBar Указывает, отображается ли горизонтальная полоса прокрутки в окне.
показатьКонтур Указывает, отображается ли контур в окне.
showRightToLeft Получает значение направления "справа налево" для окна.
Линейка showRuler Указывает, отображается ли линейка в окне.
showVerticalScrollBar Определяет, отображается ли вертикальная полоса прокрутки в окне.
показатьПустое пространство Указывает, отображается ли пробел в окне.
showWorkbookTabs Определяет, отображаются ли вкладки книги в окне.
showZeros Указывает, отображаются ли нули в окне.
smallScroll(Вниз: число, Вверх: число, ToRight: число, ToLeft: число) Прокрутка окна на несколько строк или столбцов.
разделить Указывает разделенное состояние окна.
splitColumn Указывает разделенный столбец окна.
splitHorizontal Определяет горизонтальное разделение окна.
splitRow Указывает разделенную строку окна.
splitVertical Определяет вертикальное разделение окна.
tabRatio Задает соотношение табуляции окна.
top Указывает расстояние в точках от верхнего края окна до верхнего края используемой области (под меню, любыми панелями инструментов, закрепленными вверху, и строкой формул).
type Указывает тип окна.
usableHeight Получает полезную высоту окна.
usableWidth Получает используемую ширину окна.
представление Определяет вид окна.
Видимый диапазон Получает видимый диапазон окна.
width Определяет ширину отображения окна.
НомерОкна Получает номер окна.
windowState Указывает состояние окна.
zoom Указывает целочисленное значение, представляющее размер отображения окна.
WindowCollection breakSideBySide() Нарушает параллельный вид окон.
compareCurrentSideBySideWith(windowName: string) Сравнивает текущее окно рядом с указанным окном.
getCount() Получает количество окон в коллекции.
getItemAt(index: number) Получает окно в коллекции по индексу.
items Получает загруженные дочерние элементы в этой коллекции.
resetPositionsSideBySide() Сбрасывает расположение окон в параллельном представлении.
Workbook focus() Устанавливает фокус на книге.
Worksheet checkSpelling(options?: Excel.CheckSpellingOptions) Проверяет орфографию в словах на этом листе.
clearArrows() Удаление стрелок трассировки с листа.
evaluate(имя: строка) Возвращает результат вычисления строки формулы.

См. также

  • Last updated on