PowerPoint.SlideLayout class
Представляет макет слайда.
- Extends
Комментарии
Используется
- PowerPoint.Shape: getParentSlideLayout, getParentSlideLayoutOrNullObject
- PowerPoint.Slide: applyLayout, layout
- PowerPoint.SlideLayoutCollection: 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 | Получает уникальный идентификатор макета слайда. |
| name | Получает имя макета слайда. |
| shapes | Возвращает коллекцию фигур в макете слайда. |
| theme |
Возвращает макет слайда |
| type | Возвращает тип макета слайда. |
Методы
| delete() | Удаляет макет слайда из презентации. Ничего не делает, если макета слайда не существует. Выводит ошибку, |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
background
Получение фона макета слайда.
readonly background: PowerPoint.SlideLayoutBackground;Значение свойства
Комментарии
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);
}
}
});
name
Получает имя макета слайда.
readonly name: string;Значение свойства
string
Комментарии
shapes
Возвращает коллекцию фигур в макете слайда.
readonly shapes: PowerPoint.ShapeCollection;Значение свойства
Комментарии
themeColorScheme
Возвращает макет слайда ThemeColorScheme .
readonly themeColorScheme: PowerPoint.ThemeColorScheme;Значение свойства
Комментарии
type
Возвращает тип макета слайда.
readonly type: PowerPoint.SlideLayoutType | "Blank" | "Chart" | "ChartAndText" | "ClipArtAndText" | "ClipArtAndVerticalText" | "Comparison" | "ContentWithCaption" | "Custom" | "FourObjects" | "LargeObject" | "MediaClipAndText" | "Mixed" | "Object" | "ObjectAndText" | "ObjectAndTwoObjects" | "ObjectOverText" | "OrganizationChart" | "PictureWithCaption" | "SectionHeader" | "Table" | "Text" | "TextAndChart" | "TextAndClipArt" | "TextAndMediaClip" | "TextAndObject" | "TextAndTwoObjects" | "TextOverObject" | "Title" | "TitleOnly" | "TwoColumnText" | "TwoObjects" | "TwoObjectsAndObject" | "TwoObjectsAndText" | "TwoObjectsOverText" | "VerticalText" | "VerticalTitleAndText" | "VerticalTitleAndTextOverChart";Значение свойства
PowerPoint.SlideLayoutType | "Blank" | "Chart" | "ChartAndText" | "ClipArtAndText" | "ClipArtAndVerticalText" | "Comparison" | "ContentWithCaption" | "Custom" | "FourObjects" | "LargeObject" | "MediaClipAndText" | "Mixed" | "Object" | "ObjectAndText" | "ObjectAndTwoObjects" | "ObjectOverText" | "OrganizationChart" | "PictureWithCaption" | "SectionHeader" | "Table" | "Text" | "TextAndChart" | "TextAndClipArt" | "TextAndMediaClip" | "TextAndObject" | "TextAndTwoObjects" | "TextOverObject" | "Title" | "TitleOnly" | "TwoColumnText" | "TwoObjects" | "TwoObjectsAndObject" | "TwoObjectsAndText" | "TwoObjectsOverText" | "VerticalText" | "VerticalTitleAndText" | "VerticalTitleAndTextOverChart"
Комментарии
Сведения о методе
delete()
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Удаляет макет слайда из презентации. Ничего не делает, если макета слайда не существует. Выводит ошибку, GeneralException если используется макет слайда.
delete(): void;Возвращаемое значение
void
Комментарии
Набор API: PowerPointApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ)
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: PowerPoint.Interfaces.SlideLayoutLoadOptions): PowerPoint.SlideLayout;Параметры
Предоставляет параметры для загружаемых свойств объекта.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): PowerPoint.SlideLayout;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): PowerPoint.SlideLayout;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.
Возвращаемое значение
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный PowerPoint.SlideLayout объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как PowerPoint.Interfaces.SlideLayoutData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.
toJSON(): PowerPoint.Interfaces.SlideLayoutData;