Excel.Workbook class
Книга — это объект верхнего уровня, содержащий связанные объекты, такие как листы, таблицы и диапазоны. Дополнительные сведения об объектной модели книги см. в статье "Работа с книгами с помощью API JavaScript в Excel".
- Extends
Комментарии
Используется
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/workbook-get-active-cell.yaml
await Excel.run(async (context) => {
let myWorkbook = context.workbook;
let activeCell = myWorkbook.getActiveCell();
activeCell.load("address");
await context.sync();
console.log("The active cell is " + activeCell.address);
});
Свойства
| application | Представляет экземпляр приложения Excel, который содержит книгу. |
| auto |
Указывает, находится ли книга в режиме автосохранения. |
| bindings | Представляет коллекцию привязок, включенных в книгу. |
| calculation |
Возвращает номер версии модуля вычислений Excel. |
| chart |
Значение true, если все диаграммы в книге отслеживают точки фактических данных, с которыми они связаны. Значение False, если диаграммы отслеживают индекс точек данных. |
| comments | Представляет коллекцию примечаний, связанных с книгой. |
| context | Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office. |
| custom |
Представляет коллекцию пользовательских фрагментов XML, содержащихся в книге. |
| data |
Представляет все подключения к данным в книге. |
| external |
Указывает максимальный промежуток времени (в секундах), отведенного для формулы, который зависит от выполнения внешней службы кода. Допустимый диапазон — от 1 до 86400 включительно. |
| functions | Представляет набор функций листа, которые можно использовать в вычислениях. |
| is |
Указывает, были ли внесены изменения с момента последнего сохранения книги. Это свойство можно задать, |
| linked |
Возвращает коллекцию доменов данных связанных сущностей, доступных в книге. |
| linked |
Возвращает коллекцию связанных книг. С помощью ссылок в формулах можно ссылаться на данные (значения и имена ячеек) за пределами текущей книги. |
| local |
Возвращает объект, |
| name | Получает имя книги. |
| names | Представляет коллекцию именованных элементов в области книги (именованные диапазоны и константы). |
| notes | Возвращает коллекцию всех объектов заметок в книге. |
| pivot |
Представляет коллекцию сводных таблиц, сопоставленных с книгой. |
| pivot |
Представляет коллекцию объектов PivotTableStyles, связанных с книгой. |
| previously |
Указывает, где сохранена книга: локально или в Интернете. |
| properties | Получает свойства книги. |
| protection | Возвращает объект защиты книги. |
| queries | Возвращает коллекцию запросов Power Query, являющихся частью книги. |
| read |
Возвращает значение |
| sensitivity |
Возвращает метку конфиденциальности книги. |
| settings | Представляет набор параметров, связанных с книгой. |
| show |
Указывает, отображается ли область списка полей сводной таблицы на уровне книги. |
| slicers | Представляет коллекцию срезов, связанных с книгой. |
| slicer |
Представляет коллекцию объектов SlicerStyles, связанных с книгой. |
| styles | Представляет коллекцию стилей, связанных с книгой. |
| tables | Представляет коллекцию таблиц, сопоставленных с книгой. |
| table |
Представляет коллекцию объектов TableStyles, связанных с книгой. |
| tasks | Возвращает набор задач, присутствующих в книге. |
| timeline |
Представляет коллекцию объектов TimelineStyles, связанных с книгой. |
| use1904Date |
Значение true, если в книге используется система дат 1904. |
| use |
Значение true, если вычисления в книге выполняются только с той точностью чисел, с которой они отображаются. Точность данных будет безвозвратно потеряна при переключении этого свойства с |
| worksheets | Представляет коллекцию листов, сопоставленных с книгой. |
Методы
| autorun |
Уведомляет ведущее приложение о завершении выполнения кода надстройки в событии автозапуска. |
| close(close |
Закрывает текущую книгу. |
| close(close |
Закрывает текущую книгу. |
| focus() | Устанавливает фокус на книге. Это приводит к тому, что сетка Excel или активный в данный момент объект получают события клавиатуры. |
| get |
Получает текущую активную ячейку из книги. |
| get |
Получает текущую активную диаграмму в книге. Если активного графика нет, |
| get |
Получает текущую активную диаграмму в книге. Если активного графика нет, то этот метод возвращает объект со свойством |
| get |
Получение активной фигуры в книге. Если активная фигура отсутствует, возникает |
| get |
Получение активной фигуры в книге. Если активной фигуры нет, этот метод возвращает объект со свойством |
| get |
Получает текущий активный срез в книге. Если активного среза нет, |
| get |
Получает текущий активный срез в книге. Если активного среза нет, то этот метод возвращает объект со свойством |
| get |
Возвращает результат |
| get |
Возвращает переменную на |
| get |
Получает выбранный в текущий момент диапазон из книги. Если выбрано несколько диапазонов, этот метод выдаст ошибку. |
| get |
Получает текущий выделенный диапазон (один или несколько) в книге. В отличие от , |
| in |
Возвращает, находится ли книга в режиме предварительного просмотра. |
| insert |
Вставляет указанные листы из исходной книги в текущую книгу. Раздел реестра |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| save(save |
Сохраняет текущую книгу. |
| save(save |
Сохраняет текущую книгу. |
| set(properties, options) | Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа. |
| set(properties) | Одновременно задает несколько свойств объекта на основе существующего загруженного объекта. |
| toJSON() | Переопределяет метод JavaScript |
События
| on |
Возникает при активации книги. Примечание. Это событие не срабатывает при открытии книги. |
| on |
Возникает при изменении параметра автосохранения книги. |
| on |
Происходит при изменении выбора в документе. |
Сведения о свойстве
application
Представляет экземпляр приложения Excel, который содержит книгу.
readonly application: Excel.Application;Значение свойства
Комментарии
autoSave
Указывает, находится ли книга в режиме автосохранения.
readonly autoSave: boolean;Значение свойства
boolean
Комментарии
bindings
Представляет коллекцию привязок, включенных в книгу.
readonly bindings: Excel.BindingCollection;Значение свойства
Комментарии
calculationEngineVersion
Возвращает номер версии модуля вычислений Excel.
readonly calculationEngineVersion: number;Значение свойства
number
Комментарии
chartDataPointTrack
Значение true, если все диаграммы в книге отслеживают точки фактических данных, с которыми они связаны. Значение False, если диаграммы отслеживают индекс точек данных.
chartDataPointTrack: boolean;Значение свойства
boolean
Комментарии
comments
Представляет коллекцию примечаний, связанных с книгой.
readonly comments: Excel.CommentCollection;Значение свойства
Комментарии
Примеры
// 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) => {
context.workbook.comments.getItemByCell("Comments!A1").delete();
await context.sync();
});
context
Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
context: RequestContext;Значение свойства
customXmlParts
Представляет коллекцию пользовательских фрагментов XML, содержащихся в книге.
readonly customXmlParts: Excel.CustomXmlPartCollection;Значение свойства
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/18-custom-xml-parts/test-xml-for-unique-namespace.yaml
await Excel.run(async (context) => {
document.getElementById("display-xml").textContent = "";
const customXmlParts = context.workbook.customXmlParts;
customXmlParts.load("items");
await context.sync();
for (let i = 0; i < customXmlParts.items.length; i++) {
customXmlParts.items[i].delete();
}
await context.sync();
});
dataConnections
Представляет все подключения к данным в книге.
readonly dataConnections: Excel.DataConnectionCollection;Значение свойства
Комментарии
externalCodeServiceTimeout
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Указывает максимальный промежуток времени (в секундах), отведенного для формулы, который зависит от выполнения внешней службы кода. Допустимый диапазон — от 1 до 86400 включительно.
externalCodeServiceTimeout: number;Значение свойства
number
Комментарии
functions
Представляет набор функций листа, которые можно использовать в вычислениях.
readonly functions: Excel.Functions;Значение свойства
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/workbook-built-in-functions.yaml
await Excel.run(async (context) => {
// This function uses VLOOKUP to find data in the "Wrench" row
// on the worksheet, and then it uses SUM to combine the values.
let range = context.workbook.worksheets.getItem("Sample").getRange("A1:D4");
// Get the values in the second, third, and fourth columns in the "Wrench" row,
// and combine those values with SUM.
let sumOfTwoLookups = context.workbook.functions.sum(
context.workbook.functions.vlookup("Wrench", range, 2, false),
context.workbook.functions.vlookup("Wrench", range, 3, false),
context.workbook.functions.vlookup("Wrench", range, 4, false)
);
sumOfTwoLookups.load("value");
await context.sync();
console.log(" Number of wrenches sold in November, December, and January = " + sumOfTwoLookups.value);
});
isDirty
Указывает, были ли внесены изменения с момента последнего сохранения книги. Это свойство можно задать, true если требуется закрыть измененную книгу без сохранения или запроса на сохранение.
isDirty: boolean;Значение свойства
boolean
Комментарии
linkedEntityDataDomains
Возвращает коллекцию доменов данных связанных сущностей, доступных в книге.
readonly linkedEntityDataDomains: Excel.LinkedEntityDataDomainCollection;Значение свойства
Комментарии
linkedWorkbooks
Возвращает коллекцию связанных книг. С помощью ссылок в формулах можно ссылаться на данные (значения и имена ячеек) за пределами текущей книги.
readonly linkedWorkbooks: Excel.LinkedWorkbookCollection;Значение свойства
Комментарии
localImage
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Возвращает объект, LocalImage связанный с книгой.
readonly localImage: Excel.LocalImage;Значение свойства
Комментарии
name
Получает имя книги.
readonly name: string;Значение свойства
string
Комментарии
names
Представляет коллекцию именованных элементов в области книги (именованные диапазоны и константы).
readonly names: Excel.NamedItemCollection;Значение свойства
Комментарии
notes
Возвращает коллекцию всех объектов заметок в книге.
readonly notes: Excel.NoteCollection;Значение свойства
Комментарии
pivotTables
Представляет коллекцию сводных таблиц, сопоставленных с книгой.
readonly pivotTables: Excel.PivotTableCollection;Значение свойства
Комментарии
Примеры
// 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 workbook.
const pivotTables = context.workbook.pivotTables;
pivotTables.load("name");
await context.sync();
// Display the names in the console.
console.log("PivotTables in the workbook:")
pivotTables.items.forEach((pivotTable) => {
console.log(`\t${pivotTable.name}`);
});
});
pivotTableStyles
Представляет коллекцию объектов PivotTableStyles, связанных с книгой.
readonly pivotTableStyles: Excel.PivotTableStyleCollection;Значение свойства
Комментарии
previouslySaved
Указывает, где сохранена книга: локально или в Интернете.
readonly previouslySaved: boolean;Значение свойства
boolean
Комментарии
properties
Получает свойства книги.
readonly properties: Excel.DocumentProperties;Значение свойства
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/26-document/properties.yaml
await Excel.run(async (context) => {
let titleValue = "Excel document properties API";
let subjectValue = "Set and get document properties";
let keywordsValue = "Set and get operations";
let commentsValue = "This is an Excel document properties API code sample";
let categoryValue = "Office Add-ins";
let managerValue = "John";
let companyValue = "Microsoft";
let docProperties = context.workbook.properties;
// Set the writeable document properties.
docProperties.title = titleValue;
docProperties.subject = subjectValue;
docProperties.keywords = keywordsValue;
docProperties.comments = commentsValue;
docProperties.category = categoryValue;
docProperties.manager = managerValue;
docProperties.company = companyValue;
await context.sync();
console.log("Set the following document properties: title, subject, keywords, comments, category, manager, company.");
});
protection
Возвращает объект защиты книги.
readonly protection: Excel.WorkbookProtection;Значение свойства
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/data-protection.yaml
await Excel.run(async (context) => {
const workbook: Excel.Workbook = context.workbook;
workbook.protection.unprotect();
});
queries
Возвращает коллекцию запросов Power Query, являющихся частью книги.
readonly queries: Excel.QueryCollection;Значение свойства
Комментарии
readOnly
Возвращает значение true , если книга открыта в режиме только для чтения.
readonly readOnly: boolean;Значение свойства
boolean
Комментарии
sensitivityLabel
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Возвращает метку конфиденциальности книги.
readonly sensitivityLabel: Excel.SensitivityLabel;Значение свойства
Комментарии
settings
Представляет набор параметров, связанных с книгой.
readonly settings: Excel.SettingCollection;Значение свойства
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-workbook-and-worksheet-collection.yaml
await Excel.run(async (context) => {
const settings: Excel.SettingCollection = context.workbook.settings;
settings.onSettingsChanged.add(onChangedSetting);
await context.sync();
console.log("Settings changed handler registered.");
});
showPivotFieldList
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Указывает, отображается ли область списка полей сводной таблицы на уровне книги.
showPivotFieldList: boolean;Значение свойства
boolean
Комментарии
slicers
Представляет коллекцию срезов, связанных с книгой.
readonly slicers: Excel.SlicerCollection;Значение свойства
Комментарии
slicerStyles
Представляет коллекцию объектов SlicerStyles, связанных с книгой.
readonly slicerStyles: Excel.SlicerStyleCollection;Значение свойства
Комментарии
styles
Представляет коллекцию стилей, связанных с книгой.
readonly styles: Excel.StyleCollection;Значение свойства
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/style.yaml
await Excel.run(async (context) => {
let styles = context.workbook.styles;
// Add a new style to the style collection.
// Styles is in the Home tab ribbon.
styles.add("Diagonal Orientation Style");
let newStyle = styles.getItem("Diagonal Orientation Style");
// The "Diagonal Orientation Style" properties.
newStyle.textOrientation = 38;
newStyle.autoIndent = true;
newStyle.includeProtection = true;
newStyle.shrinkToFit = true;
newStyle.locked = false;
await context.sync();
console.log("Successfully added a new style with diagonal orientation to the Home tab ribbon.");
});
tables
Представляет коллекцию таблиц, сопоставленных с книгой.
readonly tables: Excel.TableCollection;Значение свойства
Комментарии
tableStyles
Представляет коллекцию объектов TableStyles, связанных с книгой.
readonly tableStyles: Excel.TableStyleCollection;Значение свойства
Комментарии
tasks
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Возвращает набор задач, присутствующих в книге.
readonly tasks: Excel.DocumentTaskCollection;Значение свойства
Комментарии
timelineStyles
Представляет коллекцию объектов TimelineStyles, связанных с книгой.
readonly timelineStyles: Excel.TimelineStyleCollection;Значение свойства
Комментарии
use1904DateSystem
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Значение true, если в книге используется система дат 1904.
use1904DateSystem: boolean;Значение свойства
boolean
Комментарии
usePrecisionAsDisplayed
Значение true, если вычисления в книге выполняются только с той точностью чисел, с которой они отображаются. Точность данных будет безвозвратно потеряна при переключении этого свойства с false на true.
usePrecisionAsDisplayed: boolean;Значение свойства
boolean
Комментарии
worksheets
Представляет коллекцию листов, сопоставленных с книгой.
readonly worksheets: Excel.WorksheetCollection;Значение свойства
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/list-worksheets.yaml
await Excel.run(async (context) => {
const sheets: Excel.WorksheetCollection = context.workbook.worksheets;
sheets.load("items/name");
await context.sync();
if (sheets.items.length > 1) {
console.log(`There are ${sheets.items.length} worksheets in the workbook:`);
} else {
console.log(`There is one worksheet in the workbook:`);
}
for (let i in sheets.items) {
console.log(sheets.items[i].name);
}
});
Сведения о методе
autorunEventCompleted(AutorunEventCompletedOptions)
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Уведомляет ведущее приложение о завершении выполнения кода надстройки в событии автозапуска.
autorunEventCompleted(AutorunEventCompletedOptions: Excel.AutorunEventCompletedOptions): void;Параметры
- AutorunEventCompletedOptions
- Excel.AutorunEventCompletedOptions
Обязательно. Параметры для завершения события автозапуска.
Возвращаемое значение
void
Комментарии
close(closeBehavior)
Закрывает текущую книгу.
close(closeBehavior?: Excel.CloseBehavior): void;Параметры
- closeBehavior
- Excel.CloseBehavior
Поведение при закрытии книги.
Возвращаемое значение
void
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/workbook-save-and-close.yaml
await Excel.run(async (context) => {
context.workbook.close(Excel.CloseBehavior.save);
});
close(closeBehavior)
Закрывает текущую книгу.
close(closeBehavior?: "Save" | "SkipSave"): void;Параметры
- closeBehavior
-
"Save" | "SkipSave"
Поведение при закрытии книги.
Возвращаемое значение
void
Комментарии
focus()
Устанавливает фокус на книге. Это приводит к тому, что сетка Excel или активный в данный момент объект получают события клавиатуры.
focus(): void;Возвращаемое значение
void
Комментарии
getActiveCell()
Получает текущую активную ячейку из книги.
getActiveCell(): Excel.Range;Возвращаемое значение
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/workbook-get-active-cell.yaml
await Excel.run(async (context) => {
let myWorkbook = context.workbook;
let activeCell = myWorkbook.getActiveCell();
activeCell.load("address");
await context.sync();
console.log("The active cell is " + activeCell.address);
});
getActiveChart()
Получает текущую активную диаграмму в книге. Если активного графика нет, ItemNotFound создается исключение.
getActiveChart(): Excel.Chart;Возвращаемое значение
Комментарии
getActiveChartOrNullObject()
Получает текущую активную диаграмму в книге. Если активного графика нет, то этот метод возвращает объект со свойством isNullObject , установленным в trueзначение . Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getActiveChartOrNullObject(): Excel.Chart;Возвращаемое значение
Комментарии
getActiveShape()
Получение активной фигуры в книге. Если активная фигура отсутствует, возникает ItemNotFound ошибка.
getActiveShape(): Excel.Shape;Возвращаемое значение
Комментарии
getActiveShapeOrNullObject()
Получение активной фигуры в книге. Если активной фигуры нет, этот метод возвращает объект со свойством isNullObject , установленным в true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getActiveShapeOrNullObject(): Excel.Shape;Возвращаемое значение
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-get-active.yaml
// This method gets the active shape and displays it as an image in the task pane.
await Excel.run(async (context) => {
// Get the currently active shape, if any.
const activeShape = context.workbook.getActiveShapeOrNullObject();
if (activeShape) {
// Convert the active shape to an image.
const shapeImage = activeShape.getAsImage(Excel.PictureFormat.png);
await context.sync();
// Display the image in the task pane.
const imageContainer = document.getElementById("image");
imageContainer.innerHTML = ''; // Clear the container before adding a new image.
const imageElement = document.createElement("img");
imageElement.src = "data:image/png;base64," + shapeImage.value;
imageContainer.appendChild(imageElement);
} else {
console.log("No active shape");
}
});
getActiveSlicer()
Получает текущий активный срез в книге. Если активного среза нет, ItemNotFound создается исключение.
getActiveSlicer(): Excel.Slicer;Возвращаемое значение
Комментарии
getActiveSlicerOrNullObject()
Получает текущий активный срез в книге. Если активного среза нет, то этот метод возвращает объект со свойством isNullObject , установленным в trueзначение . Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getActiveSlicerOrNullObject(): Excel.Slicer;Возвращаемое значение
Комментарии
getIsActiveCollabSession()
Возвращает результат true , если книга редактируется несколькими пользователями (путем совместного редактирования). Имейте в виду, что между изменением состояния книги и отражением изменений в результате метода может быть некоторая задержка.
getIsActiveCollabSession(): OfficeExtension.ClientResult<boolean>;Возвращаемое значение
OfficeExtension.ClientResult<boolean>
Комментарии
getLinkedEntityCellValue(linkedEntityCellValueId)
Возвращает переменную на LinkedEntityCellValue основе указанного LinkedEntityId.
getLinkedEntityCellValue(linkedEntityCellValueId: LinkedEntityId): OfficeExtension.ClientResult<LinkedEntityCellValue>;Параметры
- linkedEntityCellValueId
- Excel.LinkedEntityId
Идентификатор, определяющий человека LinkedEntityCellValue.
Возвращаемое значение
Комментарии
getSelectedRange()
Получает выбранный в текущий момент диапазон из книги. Если выбрано несколько диапазонов, этот метод выдаст ошибку.
getSelectedRange(): Excel.Range;Возвращаемое значение
Комментарии
Примеры
await Excel.run(async (context) => {
const selectedRange = context.workbook.getSelectedRange();
selectedRange.load('address');
await context.sync();
console.log(selectedRange.address);
});
getSelectedRanges()
Получает текущий выделенный диапазон (один или несколько) в книге. В отличие от , getSelectedRange()этот метод возвращает RangeAreas объект, представляющий все выбранные диапазоны.
getSelectedRanges(): Excel.RangeAreas;Возвращаемое значение
Комментарии
Примеры
// 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 selectedRanges = context.workbook.getSelectedRanges();
selectedRanges.format.fill.color = "lightblue";
await context.sync();
})
inPreviewMode()
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Возвращает, находится ли книга в режиме предварительного просмотра.
inPreviewMode(): OfficeExtension.ClientResult<boolean>;Возвращаемое значение
OfficeExtension.ClientResult<boolean>
Комментарии
insertWorksheetsFromBase64(base64File, options)
Вставляет указанные листы из исходной книги в текущую книгу.
Раздел реестра extensionHardening Windows влияет на этот API. Расширение файла, определенное параметром base64File , должно соответствовать реальному типу вставленного файла. Если extensionHardening установлено ограничение несоответствий, а расширение файла не соответствует реальному типу файла, этот API выдает следующую ошибку: "Эта операция не разрешена из-за политики усиления защиты".
insertWorksheetsFromBase64(base64File: string, options?: Excel.InsertWorksheetOptions): OfficeExtension.ClientResult<string[]>;Параметры
- base64File
-
string
Обязательно. Строка в кодировке Base64, представляющая исходный файл книги.
- options
- Excel.InsertWorksheetOptions
Необязательный параметр. параметры, определяющие, какие листы необходимо вставить, а также место в книге, в которое будут вставлены новые листы. По умолчанию все листы исходной книги вставляются в конец текущей книги.
Возвращаемое значение
OfficeExtension.ClientResult<string[]>
Массив идентификаторов, соответствующих каждому вставленному листу.
Комментарии
Этот API в настоящее время поддерживается только для Office в Windows, Mac и в Интернете. В Excel в Интернете этот API не поддерживает вставку диаграмм, комментариев, сводных таблиц или срезов.
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/workbook-insert-external-worksheets.yaml
// Retrieve the file and set up an HTML FileReader element.
const myFile = document.getElementById("file") as HTMLInputElement;
const reader = new FileReader();
reader.onload = (event) => {
// Remove the metadata before the Base64-encoded string.
const startIndex = reader.result.toString().indexOf("base64,");
externalWorkbook = reader.result.toString().substr(startIndex + 7);
};
// Read the file as a data URL so that we can parse the Base64-encoded string.
reader.readAsDataURL(myFile.files[0]);
...
await Excel.run(async (context) => {
// Retrieve the source workbook.
const workbook = context.workbook;
// Set up the insert options.
const options = {
sheetNamesToInsert: [], // Insert all the worksheets from the source workbook.
positionType: Excel.WorksheetPositionType.after, // Insert after the `relativeTo` sheet.
relativeTo: "Sheet1" // The sheet relative to which the other worksheets will be inserted. Used with `positionType`.
};
// Insert the new worksheets.
workbook.insertWorksheetsFromBase64(externalWorkbook, options);
await context.sync();
});
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Excel.Interfaces.WorkbookLoadOptions): Excel.Workbook;Параметры
Предоставляет параметры для загружаемых свойств объекта.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Excel.Workbook;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.Workbook;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.
Возвращаемое значение
save(saveBehavior)
Сохраняет текущую книгу.
save(saveBehavior?: Excel.SaveBehavior): void;Параметры
- saveBehavior
- Excel.SaveBehavior
Поведение сохранения должно быть "Сохранение" или "Запрос". Значение по умолчанию: "Сохранить".
Возвращаемое значение
void
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/workbook-save-and-close.yaml
await Excel.run(async (context) => {
context.workbook.save(Excel.SaveBehavior.save);
});
save(saveBehavior)
Сохраняет текущую книгу.
save(saveBehavior?: "Save" | "Prompt"): void;Параметры
- saveBehavior
-
"Save" | "Prompt"
Поведение сохранения должно быть "Сохранение" или "Запрос". Значение по умолчанию: "Сохранить".
Возвращаемое значение
void
Комментарии
set(properties, options)
Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.
set(properties: Interfaces.WorkbookUpdateData, options?: OfficeExtension.UpdateOptions): void;Параметры
- properties
- Excel.Interfaces.WorkbookUpdateData
Объект JavaScript со свойствами, структурированными изоморфно свойствам объекта, для которого вызывается метод.
- options
- OfficeExtension.UpdateOptions
Предоставляет возможность подавления ошибок, если объект properties пытается задать какие-либо свойства только для чтения.
Возвращаемое значение
void
set(properties)
Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.
set(properties: Excel.Workbook): void;Параметры
- properties
- Excel.Workbook
Возвращаемое значение
void
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.Workbook объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Excel.Interfaces.WorkbookData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.
toJSON(): Excel.Interfaces.WorkbookData;Возвращаемое значение
Сведения о событии
onActivated
Возникает при активации книги. Примечание. Это событие не срабатывает при открытии книги.
readonly onActivated: OfficeExtension.EventHandlers<Excel.WorkbookActivatedEventArgs>;Тип события
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-workbook-activated.yaml
async function workbookActivated(event: Excel.WorkbookActivatedEventArgs) {
await Excel.run(async (context) => {
// Callback function for when the workbook is activated.
console.log("The workbook was activated.");
});
}
...
await Excel.run(async (context) => {
const workbook = context.workbook;
// Register the workbook activated event handler.
workbook.onActivated.add(workbookActivated);
await context.sync();
console.log("Added event handler for workbook activated.");
});
onAutoSaveSettingChanged
Возникает при изменении параметра автосохранения книги.
readonly onAutoSaveSettingChanged: OfficeExtension.EventHandlers<Excel.WorkbookAutoSaveSettingChangedEventArgs>;Тип события
Комментарии
onSelectionChanged
Происходит при изменении выбора в документе.
readonly onSelectionChanged: OfficeExtension.EventHandlers<Excel.SelectionChangedEventArgs>;