PowerPoint.Slide class

Extrait l’arrière-plan de la diapositive.

readonly background: PowerPoint.SlideBackground;

Valeur de propriété

Remarques

Jeu d’API : PowerPointApi 1.10

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/get-set-background-fill.yaml

// Gets the background fill type of the first selected slide.
await PowerPoint.run(async (context) => {
  const slide: PowerPoint.Slide = context.presentation.getSelectedSlides().getItemAt(0);
  const fill: PowerPoint.SlideBackgroundFill = slide.background.fill;
  fill.load("type");
  await context.sync();

  const fillType = fill.type as PowerPoint.SlideBackgroundFillType;
  console.log(`Background fill type: ${fillType}`);
});

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Renvoie une collection de parties XML personnalisées dans la diapositive.

readonly customXmlParts: PowerPoint.CustomXmlPartCollection;

Valeur de propriété

Remarques

Jeu d’API : PowerPointApi 1.7

Renvoie un ensemble de liens hypertexte dans la diapositive.

readonly hyperlinks: PowerPoint.HyperlinkCollection;

Valeur de propriété

Remarques

Jeu d’API : PowerPointApi 1.6

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/hyperlinks/manage-hyperlinks.yaml

// Sets a hyperlink on the first selected shape.
await PowerPoint.run(async (context) => {
  const slide: PowerPoint.Slide = context.presentation.getSelectedSlides().getItemAt(0);
  const shape: PowerPoint.Shape = context.presentation.getSelectedShapes().getItemAt(0).load("id,type");
  const hyperlinks: PowerPoint.HyperlinkCollection = slide.hyperlinks;
  const hyperlinkAddOptions: PowerPoint.HyperlinkAddOptions = {
    address: "https://bing.com",
    screenTip: "Screen tip for shape",
  };
  let hyperlink: PowerPoint.Hyperlink = hyperlinks.add(shape, hyperlinkAddOptions).load("address,screenTip");
  try {
    await context.sync();
  } catch {
    console.warn("Confirm that you have at least one slide and you've selected a shape on the active slide.");
    return;
  }

  console.log(
    `Added link "${hyperlink.address}" (screen tip: "${hyperlink.screenTip}") to the first selected shape (ID: ${shape.id}, type: ${shape.type}).`,
  );
});

Obtient l’ID unique de la diapositive.

readonly id: string;

Valeur de propriété

Remarques

Jeu d’API : PowerPointApi 1.2

Renvoie l’index en base zéro de la diapositive qui représente sa position dans la présentation.

readonly index: number;

Valeur de propriété

Remarques

Jeu d’API : PowerPointApi 1.8

Obtient la disposition de la diapositive.

readonly layout: PowerPoint.SlideLayout;

Valeur de propriété

Remarques

Jeu d’API : PowerPointApi 1.3

Renvoie une collection de formes dans la diapositive.

readonly shapes: PowerPoint.ShapeCollection;

Valeur de propriété

Remarques

Jeu d’API : PowerPointApi 1.3

Obtient l’objet SlideMaster qui représente le contenu par défaut de la diapositive.

readonly slideMaster: PowerPoint.SlideMaster;

Valeur de propriété

Remarques

Jeu d’API : PowerPointApi 1.3

Renvoie une collection de balises dans la diapositive.

readonly tags: PowerPoint.TagCollection;

Valeur de propriété

Remarques

Jeu d’API : PowerPointApi 1.3

Retourne la ThemeColorScheme diapositive.

readonly themeColorScheme: PowerPoint.ThemeColorScheme;

Valeur de propriété

Remarques

Jeu d’API : PowerPointApi 1.10

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/get-set-theme-color-scheme.yaml

// Gets the theme color scheme for the first slide and logs all theme color values.
await PowerPoint.run(async (context) => {
  const slide = context.presentation.slides.getItemAt(0);
  const colorScheme: PowerPoint.ThemeColorScheme = slide.themeColorScheme;

  // Queue up getThemeColor calls for each theme color.
  const colorResults = themeColorNames.map((colorName) => colorScheme.getThemeColor(colorName));
  await context.sync();

  // Display the results.
  console.log("Theme colors for slide 1:");
  themeColorNames.forEach((colorName, index) => {
    console.log(`  ${colorName}: ${colorResults[index].value}`);
  });
});

Applique la disposition spécifiée à la diapositive, en modifiant sa conception et sa structure en fonction de la disposition choisie.

applyLayout(slideLayout: PowerPoint.SlideLayout): void;

Paramètres

Retours

Remarques

Jeu d’API : PowerPointApi 1.8

Supprime la diapositive de la présentation. Ne fait rien si la diapositive n’existe pas.

delete(): void;

Retours

Remarques

Jeu d’API : PowerPointApi 1.2

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/get-set-slides.yaml

// Deletes the selected slides.
await PowerPoint.run(async (context) => {
  context.presentation.load("slides");
  await context.sync();
  const slides: PowerPoint.SlideScopedCollection = context.presentation.getSelectedSlides();
  const slideCount = slides.getCount();
  slides.load("items");
  await context.sync();
  slides.items.map((slide) => {
    slide.delete();
  });
});

Exporte la diapositive vers son propre fichier de présentation, renvoyé sous forme de données codées en Base64.

Remarque : cette méthode est optimisée pour l’exportation d’une seule diapositive. L’exportation de plusieurs diapositives peut avoir un impact sur les performances.

exportAsBase64(): OfficeExtension.ClientResult<string>;

Retours

Remarques

Jeu d’API : PowerPointApi 1.8

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/export-import-slide.yaml

// Exports current slide.
await PowerPoint.run(async (context) => {
  const slide = context.presentation.getSelectedSlides().getItemAt(0);
  const slideBase64DataResult = slide.exportAsBase64();
  const imageBase64DataResult = slide.getImageAsBase64({ height: 300 });
  await context.sync();

  localStorage.setItem("exportedSlide", slideBase64DataResult.value);
  localStorage.setItem("exportedSlideImage", imageBase64DataResult.value);

  updateSlideImage(imageBase64DataResult.value);

  console.log("Slide was exported.");
});

Affiche une image de la diapositive. L’image est mise à l’échelle pour s’adapter aux dimensions souhaitées. Si la largeur et la hauteur ne sont pas spécifiées, la taille réelle de la diapositive est utilisée. Si un seul de largeur ou de hauteur est spécifié, l’autre est calculé pour conserver les proportions.

getImageAsBase64(options?: PowerPoint.SlideGetImageOptions): OfficeExtension.ClientResult<string>;

Paramètres

Retours

Chaîne codée en Base64 de l’image de la diapositive au format PNG.

Remarques

Jeu d’API : PowerPointApi 1.8

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/export-import-slide.yaml

// Exports current slide.
await PowerPoint.run(async (context) => {
  const slide = context.presentation.getSelectedSlides().getItemAt(0);
  const slideBase64DataResult = slide.exportAsBase64();
  const imageBase64DataResult = slide.getImageAsBase64({ height: 300 });
  await context.sync();

  localStorage.setItem("exportedSlide", slideBase64DataResult.value);
  localStorage.setItem("exportedSlideImage", imageBase64DataResult.value);

  updateSlideImage(imageBase64DataResult.value);

  console.log("Slide was exported.");
});

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.SlideLoadOptions): PowerPoint.Slide;

Paramètres

Retours

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.Slide;

Paramètres

Retours

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.Slide;

Paramètres

Retours

Déplace la diapositive vers une nouvelle position dans la présentation.

moveTo(slideIndex: number): void;

Paramètres

Retours

Remarques

Jeu d’API : PowerPointApi 1.8

Sélectionne les formes spécifiées. La sélection de forme existante est remplacée par la nouvelle sélection.

setSelectedShapes(shapeIds: string[]): void;

Paramètres

Retours

Remarques

Jeu d’API : PowerPointApi 1.5

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-set-shapes.yaml

// Reselects shapes that were saved previously.
await PowerPoint.run(async (context) => {
  const slide1: PowerPoint.Slide = context.presentation.slides.getItem(savedSlideSelection[0]);
  await context.sync();
  slide1.setSelectedShapes(savedShapeSelection);
  await context.sync();
});

...

// Selects the first two shapes on slide 1.
await PowerPoint.run(async (context) => {
  context.presentation.load("slides");
  await context.sync();
  const slide1 = context.presentation.slides.getItemAt(0);
  slide1.load("shapes/items/type");
  await context.sync();

  const shapes = slide1.shapes.items.filter((item) => item.type === PowerPoint.ShapeType.geometricShape);
  const shape1: PowerPoint.Shape = shapes[0];
  const shape2: PowerPoint.Shape = shapes[1];
  shape1.load("id");
  shape2.load("id");
  await context.sync();

  console.log(`IDs: ${shape1.id}, ${shape2.id}`);
  slide1.setSelectedShapes([shape1.id, shape2.id]);
  await context.sync();
});

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.Slide est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) PowerPoint.Interfaces.SlideDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): PowerPoint.Interfaces.SlideData;

Retours