PowerPoint.SlideMasterCollection class
Représente la collection de masque des diapositives dans la présentation.
- Extends
Remarques
[ Ensemble d’API : PowerPointApi 1.3 ]
Exemples
// 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);
}
}
});
Propriétés
context | Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office. |
items | Obtient l’élément enfant chargé dans cette collection de sites. |
Méthodes
get |
Obtient le nombre de masque des diapositives dans la collection. |
get |
Obtient un masque des diapositives à l’aide de son ID unique. |
get |
Obtient un masque des diapositives à l’aide de son index de base zéro dans la collection. |
get |
Obtient un masque des diapositives à l’aide de son ID unique. S’il n’existe pas de masque des diapositives, un objet avec une |
load(options) | Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
toJSON() | Remplace la méthode JavaScript |
Détails de la propriété
context
Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
context: RequestContext;
Valeur de propriété
items
Obtient l’élément enfant chargé dans cette collection de sites.
readonly items: PowerPoint.SlideMaster[];
Valeur de propriété
Détails de la méthode
getCount()
Obtient le nombre de masque des diapositives dans la collection.
getCount(): OfficeExtension.ClientResult<number>;
Retours
OfficeExtension.ClientResult<number>
Nombre de masque des diapositives dans la collection.
Remarques
getItem(key)
Obtient un masque des diapositives à l’aide de son ID unique.
getItem(key: string): PowerPoint.SlideMaster;
Paramètres
- key
-
string
ID du masque des diapositives.
Retours
Masque des diapositives avec l’ID unique. Si un tel masque des diapositives n’existe pas, une erreur est générée.
Remarques
getItemAt(index)
Obtient un masque des diapositives à l’aide de son index de base zéro dans la collection.
getItemAt(index: number): PowerPoint.SlideMaster;
Paramètres
- index
-
number
Index du masque des diapositives dans la collection.
Retours
Masque des diapositives à l’index donné. Une erreur est générée si l’index est hors limites.
Remarques
getItemOrNullObject(id)
Obtient un masque des diapositives à l’aide de son ID unique. S’il n’existe pas de masque des diapositives, un objet avec une isNullObject
propriété définie sur true est retourné. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject. »
getItemOrNullObject(id: string): PowerPoint.SlideMaster;
Paramètres
- id
-
string
ID du masque des diapositives.
Retours
Masque des diapositives avec l’ID unique.
Remarques
load(options)
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync()
avant de lire les propriétés.
load(options?: PowerPoint.Interfaces.SlideMasterCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.SlideMasterCollection;
Paramètres
- options
-
PowerPoint.Interfaces.SlideMasterCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions
Fournit des options pour les propriétés de l’objet à charger.
Retours
load(propertyNames)
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync()
avant de lire les propriétés.
load(propertyNames?: string | string[]): PowerPoint.SlideMasterCollection;
Paramètres
- propertyNames
-
string | string[]
Chaîne délimitée par des virgules ou tableau de chaînes qui spécifient les propriétés à charger.
Retours
Exemples
// 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);
}
}
});
load(propertyNamesAndPaths)
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync()
avant de lire les propriétés.
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.SlideMasterCollection;
Paramètres
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select
est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand
est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.
Retours
toJSON()
Remplace la méthode JavaScript toJSON()
afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify()
. (JSON.stringify
, à son tour, appelle la toJSON
méthode de l’objet qui lui est passé.) Alors que l’objet d’origine PowerPoint.SlideMasterCollection
est un objet API, la toJSON
méthode renvoie un objet JavaScript brut (typé en tant PowerPoint.Interfaces.SlideMasterCollectionData
que ) qui contient un tableau « items » avec des copies superficielles de toutes les propriétés chargées à partir des éléments de la collection.
toJSON(): PowerPoint.Interfaces.SlideMasterCollectionData;