Excel.Workbook class
Workbook — это объект верхнего уровня, содержащий связанные объекты книги, такие как листы, таблицы и диапазоны. Дополнительные сведения об объектной модели книг см. в статье Работа с книгами с помощью API JavaScript для Excel.
- Extends
Комментарии
Свойства
| application | Представляет экземпляр приложения Excel, содержащий эту книгу. |
| bindings | Представляет коллекцию привязок, включенных в книгу. |
| context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
| custom |
Представляет коллекцию настраиваемых XML-частей, содержащихся в этой книге. |
| data |
Представляет все подключения к данным в книге. |
| functions | Представляет коллекцию функций листа, которые можно использовать для вычислений. |
| name | Получает имя книги. |
| names | Представляет коллекцию именованных элементов с областью книги (именованные диапазоны и константы). |
| pivot |
Представляет коллекцию сводных таблиц, сопоставленных с книгой. |
| properties | Получает свойства книги. |
| protection | Возвращает объект защиты для книги. |
| read |
Возвращает значение |
| settings | Представляет коллекцию параметров, связанных с книгой. |
| styles | Представляет коллекцию стилей, связанных с книгой. |
| tables | Представляет коллекцию таблиц, сопоставленных с книгой. |
| worksheets | Представляет коллекцию листов, сопоставленных с книгой. |
Методы
| get |
Получает текущую активную ячейку из книги. |
| get |
Возвращает выбранный в данный момент один диапазон из книги. Если выбрано несколько диапазонов, этот метод вызовет ошибку. |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| set(properties, options) | Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа. |
| set(properties) | Задает несколько свойств объекта одновременно на основе существующего загруженного объекта. |
| toJSON() | Переопределяет метод JavaScript |
События
| on |
Происходит при изменении выбора в документе. |
Сведения о свойстве
application
Представляет экземпляр приложения Excel, содержащий эту книгу.
readonly application: Excel.Application;Значение свойства
Комментарии
bindings
Представляет коллекцию привязок, включенных в книгу.
readonly bindings: Excel.BindingCollection;Значение свойства
Комментарии
context
Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
context: RequestContext;Значение свойства
customXmlParts
Представляет коллекцию настраиваемых XML-частей, содержащихся в этой книге.
readonly customXmlParts: Excel.CustomXmlPartCollection;Значение свойства
Комментарии
dataConnections
Представляет все подключения к данным в книге.
readonly dataConnections: Excel.DataConnectionCollection;Значение свойства
Комментарии
functions
Представляет коллекцию функций листа, которые можно использовать для вычислений.
readonly functions: Excel.Functions;Значение свойства
Комментарии
name
Получает имя книги.
readonly name: string;Значение свойства
string
Комментарии
names
Представляет коллекцию именованных элементов с областью книги (именованные диапазоны и константы).
readonly names: Excel.NamedItemCollection;Значение свойства
Комментарии
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}`);
});
});
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;Значение свойства
Комментарии
readOnly
Возвращает значение true , если книга открыта в режиме только для чтения.
readonly readOnly: boolean;Значение свойства
boolean
Комментарии
settings
Представляет коллекцию параметров, связанных с книгой.
readonly settings: Excel.SettingCollection;Значение свойства
Комментарии
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;Значение свойства
Комментарии
worksheets
Представляет коллекцию листов, сопоставленных с книгой.
readonly worksheets: Excel.WorksheetCollection;Значение свойства
Комментарии
Сведения о методе
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);
});
getSelectedRange()
Возвращает выбранный в данный момент один диапазон из книги. Если выбрано несколько диапазонов, этот метод вызовет ошибку.
getSelectedRange(): Excel.Range;Возвращаемое значение
Комментарии
Примеры
await Excel.run(async (context) => {
const selectedRange = context.workbook.getSelectedRange();
selectedRange.load('address');
await context.sync();
console.log(selectedRange.address);
});
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 строка с разделителями-запятыми, указывающая загружаемые свойства навигации.
Возвращаемое значение
set(properties, options)
Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties: Interfaces.WorkbookUpdateData, options?: OfficeExtension.UpdateOptions): void;Параметры
- properties
- Excel.Interfaces.WorkbookUpdateData
Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .
- options
- OfficeExtension.UpdateOptions
Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.
Возвращаемое значение
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;Возвращаемое значение
Сведения о событии
onSelectionChanged
Происходит при изменении выбора в документе.
readonly onSelectionChanged: OfficeExtension.EventHandlers<Excel.SelectionChangedEventArgs>;Тип события
Комментарии
Office Add-ins
Обратная связь
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделе https://aka.ms/ContentUserFeedback.
Отправить и просмотреть отзыв по