PowerPoint.Shape class
Représente une forme unique dans la diapositive.
- Extends
Remarques
[ Ensemble d’API : PowerPointApi 1.3 ]
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. |
| fill | Renvoie la mise en forme de remplissage de cette forme. |
| height | Spécifie la hauteur, en points, de la forme. Lève une exception lorsqu’elle |
| id | Obtient l’ID unique de la forme. |
| left | Distance, en points, entre le côté gauche de la forme et le côté gauche de la diapositive. |
| line |
Renvoie la mise en forme de ligne de cette forme. |
| name | Spécifie le nom de cette forme. |
| tags | Retourne une collection de balises dans la forme. |
| text |
Renvoie l’objet textFrame d’une forme. |
| top | Distance, en points, entre le bord supérieur de la forme et le bord supérieur de la diapositive. |
| type | Renvoie le type de cette forme. Pour plus d’informations , voir PowerPoint.ShapeType . |
| width | Spécifie la largeur, en points, de la forme. Lève une exception lorsqu’elle |
Méthodes
| delete() | Supprime la forme de la collection de formes. Ne fait rien si la forme n’existe pas. |
| get |
Retourne l’objet PowerPoint.Slide parent qui contient ce |
| get |
Renvoie l’objet Parent PowerPoint.SlideLayout qui contient ce |
| get |
Renvoie l’objet Parent PowerPoint.SlideLayout qui contient ce |
| get |
Renvoie l’objet PowerPoint.SlideMaster parent qui contient ce |
| get |
Renvoie l’objet PowerPoint.SlideMaster parent qui contient ce |
| get |
Retourne l’objet PowerPoint.Slide parent qui contient ce |
| 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é
fill
Renvoie la mise en forme de remplissage de cette forme.
readonly fill: PowerPoint.ShapeFill;Valeur de propriété
Remarques
[ Ensemble d’API : PowerPointApi 1.4 ]
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-set-shapes.yaml
// Changes the selected shapes fill color to red.
await PowerPoint.run(async (context) => {
const shapes = context.presentation.getSelectedShapes();
const shapeCount = shapes.getCount();
shapes.load("items");
await context.sync();
shapes.items.map((shape) => {
shape.fill.setSolidColor("red");
});
await context.sync();
});
height
Spécifie la hauteur, en points, de la forme. Lève une exception lorsqu’elle InvalidArgument est définie avec une valeur négative.
height: number;Valeur de propriété
number
Remarques
[ Ensemble d’API : PowerPointApi 1.4 ]
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-set-shapes.yaml
// Arranges the selected shapes in a line from left to right.
await PowerPoint.run(async (context) => {
const shapes = context.presentation.getSelectedShapes();
const shapeCount = shapes.getCount();
shapes.load("items");
await context.sync();
let maxHeight = 0;
shapes.items.map((shape) => {
shape.load("width,height");
});
await context.sync();
shapes.items.map((shape) => {
shape.left = currentLeft;
shape.top = currentTop;
currentLeft += shape.width;
if (shape.height > maxHeight) maxHeight = shape.height;
});
await context.sync();
currentLeft = 0;
if (currentTop > slideHeight - 200) currentTop = 0;
});
id
Obtient l’ID unique de la forme.
readonly id: string;Valeur de propriété
string
Remarques
left
Distance, en points, entre le côté gauche de la forme et le côté gauche de la diapositive.
left: number;Valeur de propriété
number
Remarques
[ Ensemble d’API : PowerPointApi 1.4 ]
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-set-shapes.yaml
// Arranges the selected shapes in a line from left to right.
await PowerPoint.run(async (context) => {
const shapes = context.presentation.getSelectedShapes();
const shapeCount = shapes.getCount();
shapes.load("items");
await context.sync();
let maxHeight = 0;
shapes.items.map((shape) => {
shape.load("width,height");
});
await context.sync();
shapes.items.map((shape) => {
shape.left = currentLeft;
shape.top = currentTop;
currentLeft += shape.width;
if (shape.height > maxHeight) maxHeight = shape.height;
});
await context.sync();
currentLeft = 0;
if (currentTop > slideHeight - 200) currentTop = 0;
});
lineFormat
Renvoie la mise en forme de ligne de cette forme.
readonly lineFormat: PowerPoint.ShapeLineFormat;Valeur de propriété
Remarques
name
Spécifie le nom de cette forme.
name: string;Valeur de propriété
string
Remarques
tags
Retourne une collection de balises dans la forme.
readonly tags: PowerPoint.TagCollection;Valeur de propriété
Remarques
textFrame
Renvoie l’objet textFrame d’une forme.
readonly textFrame: PowerPoint.TextFrame;Valeur de propriété
Remarques
top
Distance, en points, entre le bord supérieur de la forme et le bord supérieur de la diapositive.
top: number;Valeur de propriété
number
Remarques
[ Ensemble d’API : PowerPointApi 1.4 ]
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-set-shapes.yaml
// Arranges the selected shapes in a line from left to right.
await PowerPoint.run(async (context) => {
const shapes = context.presentation.getSelectedShapes();
const shapeCount = shapes.getCount();
shapes.load("items");
await context.sync();
let maxHeight = 0;
shapes.items.map((shape) => {
shape.load("width,height");
});
await context.sync();
shapes.items.map((shape) => {
shape.left = currentLeft;
shape.top = currentTop;
currentLeft += shape.width;
if (shape.height > maxHeight) maxHeight = shape.height;
});
await context.sync();
currentLeft = 0;
if (currentTop > slideHeight - 200) currentTop = 0;
});
type
Renvoie le type de cette forme. Pour plus d’informations , voir PowerPoint.ShapeType .
readonly type: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table";Valeur de propriété
PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table"
Remarques
width
Spécifie la largeur, en points, de la forme. Lève une exception lorsqu’elle InvalidArgument est définie avec une valeur négative.
width: number;Valeur de propriété
number
Remarques
[ Ensemble d’API : PowerPointApi 1.4 ]
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-set-shapes.yaml
// Arranges the selected shapes in a line from left to right.
await PowerPoint.run(async (context) => {
const shapes = context.presentation.getSelectedShapes();
const shapeCount = shapes.getCount();
shapes.load("items");
await context.sync();
let maxHeight = 0;
shapes.items.map((shape) => {
shape.load("width,height");
});
await context.sync();
shapes.items.map((shape) => {
shape.left = currentLeft;
shape.top = currentTop;
currentLeft += shape.width;
if (shape.height > maxHeight) maxHeight = shape.height;
});
await context.sync();
currentLeft = 0;
if (currentTop > slideHeight - 200) currentTop = 0;
});
Détails de la méthode
delete()
Supprime la forme de la collection de formes. Ne fait rien si la forme n’existe pas.
delete(): void;Retours
void
Remarques
getParentSlide()
Retourne l’objet PowerPoint.Slide parent qui contient ce Shape. Lève une exception si cette forme n’appartient pas à un Slide.
getParentSlide(): PowerPoint.Slide;Retours
Remarques
getParentSlideLayout()
Renvoie l’objet Parent PowerPoint.SlideLayout qui contient ce Shape. Lève une exception si cette forme n’appartient pas à un SlideLayout.
getParentSlideLayout(): PowerPoint.SlideLayout;Retours
Remarques
getParentSlideLayoutOrNullObject()
Renvoie l’objet Parent PowerPoint.SlideLayout qui contient ce Shape. Si cette forme n’appartient pas à , SlideLayoutun objet avec une isNullObject propriété définie sur true est retourné.
getParentSlideLayoutOrNullObject(): PowerPoint.SlideLayout;Retours
Remarques
getParentSlideMaster()
Renvoie l’objet PowerPoint.SlideMaster parent qui contient ce Shape. Lève une exception si cette forme n’appartient pas à un SlideMaster.
getParentSlideMaster(): PowerPoint.SlideMaster;Retours
Remarques
getParentSlideMasterOrNullObject()
Renvoie l’objet PowerPoint.SlideMaster parent qui contient ce Shape. Si cette forme n’appartient pas à , SlideMasterun objet avec une isNullObject propriété définie sur true est retourné.
getParentSlideMasterOrNullObject(): PowerPoint.SlideMaster;Retours
Remarques
getParentSlideOrNullObject()
Retourne l’objet PowerPoint.Slide parent qui contient ce Shape. Si cette forme n’appartient pas à , Slideun objet avec une isNullObject propriété définie sur true est retourné.
getParentSlideOrNullObject(): PowerPoint.Slide;Retours
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.ShapeLoadOptions): PowerPoint.Shape;Paramètres
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.Shape;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
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?: {
select?: string;
expand?: string;
}): PowerPoint.Shape;Paramètres
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
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.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet PowerPoint.Shape d’origine est un objet API, la toJSON méthode renvoie un objet JavaScript brut (tapé en tant PowerPoint.Interfaces.ShapeDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.
toJSON(): PowerPoint.Interfaces.ShapeData;Retours
Commentaires
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultez https://aka.ms/ContentUserFeedback.
Envoyer et afficher des commentaires pour