PowerPoint.SlideMaster class
Представляет образец слайда.
- Extends
Комментарии
Используется
- PowerPoint.Shape: getParentSlideMaster, getParentSlideMasterOrNullObject
- PowerPoint.Слайд: SlideMaster
- PowerPoint.SlideMasterCollection: getItem, getItemAt, getItemOrNullObject, items
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/add-slides.yaml
await PowerPoint.run(async function(context) {
// Load information about all the slide masters and associated layouts.
const slideMasters: PowerPoint.SlideMasterCollection = context.presentation.slideMasters.load("id, name, layouts/items/name, layouts/items/id");
await context.sync();
// Log the name and ID of each slide master.
for (let i = 0; i < slideMasters.items.length; i++) {
console.log("Master name: " + slideMasters.items[i].name);
console.log("Master ID: " + slideMasters.items[i].id);
// Log the name and ID of each slide layout in the slide master.
const layoutsInMaster: PowerPoint.SlideLayoutCollection = slideMasters.items[i].layouts;
for (let j = 0; j < layoutsInMaster.items.length; j++) {
console.log(" Layout name: " + layoutsInMaster.items[j].name + " Layout ID: " + layoutsInMaster.items[j].id);
}
}
});
Свойства
| background | Получение фона образца слайдов. |
| context | Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office. |
| custom |
Возвращает коллекцию пользовательских фрагментов XML в образце слайдов. |
| id | Получает уникальный идентификатор образца слайдов. |
| layouts | Получает коллекцию макетов, предоставленную образцом слайдов для слайдов. |
| name | Получает уникальное имя образца слайдов. |
| shapes | Возвращает коллекцию фигур в образце слайдов. |
| theme |
Возвращает |
Методы
| delete() | Удаляет master слайдов и все дочерние макеты из презентации. Ничего не делает, если master слайда не существует. Выдает ошибку, |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
background
Получение фона образца слайдов.
readonly background: PowerPoint.SlideMasterBackground;Значение свойства
Комментарии
context
Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
context: RequestContext;Значение свойства
customXmlParts
Возвращает коллекцию пользовательских фрагментов XML в образце слайдов.
readonly customXmlParts: PowerPoint.CustomXmlPartCollection;Значение свойства
Комментарии
id
Получает уникальный идентификатор образца слайдов.
readonly id: string;Значение свойства
string
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/add-slides.yaml
await PowerPoint.run(async function(context) {
// Load information about all the slide masters and associated layouts.
const slideMasters: PowerPoint.SlideMasterCollection = context.presentation.slideMasters.load("id, name, layouts/items/name, layouts/items/id");
await context.sync();
// Log the name and ID of each slide master.
for (let i = 0; i < slideMasters.items.length; i++) {
console.log("Master name: " + slideMasters.items[i].name);
console.log("Master ID: " + slideMasters.items[i].id);
// Log the name and ID of each slide layout in the slide master.
const layoutsInMaster: PowerPoint.SlideLayoutCollection = slideMasters.items[i].layouts;
for (let j = 0; j < layoutsInMaster.items.length; j++) {
console.log(" Layout name: " + layoutsInMaster.items[j].name + " Layout ID: " + layoutsInMaster.items[j].id);
}
}
});
layouts
Получает коллекцию макетов, предоставленную образцом слайдов для слайдов.
readonly layouts: PowerPoint.SlideLayoutCollection;Значение свойства
Комментарии
name
Получает уникальное имя образца слайдов.
readonly name: string;Значение свойства
string
Комментарии
shapes
Возвращает коллекцию фигур в образце слайдов.
readonly shapes: PowerPoint.ShapeCollection;Значение свойства
Комментарии
themeColorScheme
Возвращает ThemeColorScheme образец слайдов.
readonly themeColorScheme: PowerPoint.ThemeColorScheme;Значение свойства
Комментарии
Сведения о методе
delete()
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Удаляет master слайдов и все дочерние макеты из презентации. Ничего не делает, если master слайда не существует. Выдает ошибку, GeneralException если используется master слайда.
delete(): void;Возвращаемое значение
void
Комментарии
Набор API: PowerPointApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ)
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: PowerPoint.Interfaces.SlideMasterLoadOptions): PowerPoint.SlideMaster;Параметры
Предоставляет параметры для загружаемых свойств объекта.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): PowerPoint.SlideMaster;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): PowerPoint.SlideMaster;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.
Возвращаемое значение
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный PowerPoint.SlideMaster объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как PowerPoint.Interfaces.SlideMasterData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.
toJSON(): PowerPoint.Interfaces.SlideMasterData;