Поделиться через

Набор обязательных требований 1.1 для API JavaScript для Excel только для классических приложений

Набор 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.20.

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 проверка. Это позволит включить функцию надстройки на других платформах. Обязательно протестируйте функцию на этих платформах при внесении этого изменения.

Важно!

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

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

См. также

  • Last updated on