PowerPoint.ThemeColorScheme class

Paquet:
powerpoint

Représente un jeu de couleurs de thème.

Extends
OfficeExtension.ClientObject

Remarques

Jeu d’API : PowerPointApi 1.10

Utilisateur

Exemples

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

// Resets accent colors on the first slide to default Office theme values and updates swatches if present.
await PowerPoint.run(async (context) => {
  const slide = context.presentation.slides.getItemAt(0);
  const colorScheme: PowerPoint.ThemeColorScheme = slide.themeColorScheme;

  colorScheme.setThemeColor(PowerPoint.ThemeColor.accent1, "#4472C4");
  colorScheme.setThemeColor(PowerPoint.ThemeColor.accent2, "#ED7D31");
  colorScheme.setThemeColor(PowerPoint.ThemeColor.accent3, "#A9D18E");
  colorScheme.setThemeColor(PowerPoint.ThemeColor.accent4, "#FFC000");
  colorScheme.setThemeColor(PowerPoint.ThemeColor.accent5, "#5B9BD5");
  colorScheme.setThemeColor(PowerPoint.ThemeColor.accent6, "#70AD47");
  await context.sync();

  await updateSwatches(context, slide);
  console.log("Accent colors reset to default Office theme values on slide 1.");
});

Propriétés

context

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

Méthodes

getThemeColor(color)

Obtient la valeur de couleur pour le ThemeColorfichier .
getThemeColor(color)

Obtient la valeur de couleur pour le ThemeColorfichier .
setThemeColor(color, rgbColor)

Définit la valeur de couleur pour le fichier spécifié ThemeColor.
setThemeColor(color, rgbColor)

Définit la valeur de couleur pour le fichier spécifié ThemeColor.
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.ThemeColorScheme est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) PowerPoint.Interfaces.ThemeColorSchemeDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

Détails de la propriété

context

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é

PowerPoint.RequestContext

Détails de la méthode

getThemeColor(color)

Obtient la valeur de couleur pour le ThemeColorfichier .

getThemeColor(color: PowerPoint.ThemeColor): OfficeExtension.ClientResult<string>;

Paramètres

color
PowerPoint.ThemeColor

Couleur du thème. Les valeurs none et mixed ne sont pas valides pour cette API.

Retours

OfficeExtension.ClientResult<string>

Valeur de couleur au format #RRGGBB (par exemple, « FFA500 »).

Remarques

Jeu d’API : PowerPointApi 1.10

getThemeColor(color)

Obtient la valeur de couleur pour le ThemeColorfichier .

getThemeColor(color: "Mixed" | "None" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Dark1" | "Dark2" | "FollowedHyperlink" | "Hyperlink" | "Light1" | "Light2"): OfficeExtension.ClientResult<string>;

Paramètres

color

"Mixed" | "None" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Dark1" | "Dark2" | "FollowedHyperlink" | "Hyperlink" | "Light1" | "Light2"

Couleur du thème. Les valeurs none et mixed ne sont pas valides pour cette API.

Retours

OfficeExtension.ClientResult<string>

Valeur de couleur au format #RRGGBB (par exemple, « FFA500 »).

Remarques

Jeu d’API : PowerPointApi 1.10

setThemeColor(color, rgbColor)

Définit la valeur de couleur pour le fichier spécifié ThemeColor.

setThemeColor(color: PowerPoint.ThemeColor, rgbColor: string): void;

Paramètres

color
PowerPoint.ThemeColor

Couleur du thème. Les valeurs none et mixed ne sont pas valides pour cette API.

rgbColor

string

Valeur de couleur au format #RRGGBB (par exemple, « FFA500 ») ou sous la forme d’une couleur HTML nommée (par exemple, « orange »).

Retours

void

Remarques

Jeu d’API : PowerPointApi 1.10

setThemeColor(color, rgbColor)

Définit la valeur de couleur pour le fichier spécifié ThemeColor.

setThemeColor(color: "Mixed" | "None" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Dark1" | "Dark2" | "FollowedHyperlink" | "Hyperlink" | "Light1" | "Light2", rgbColor: string): void;

Paramètres

color

"Mixed" | "None" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Dark1" | "Dark2" | "FollowedHyperlink" | "Hyperlink" | "Light1" | "Light2"

Couleur du thème. Les valeurs none et mixed ne sont pas valides pour cette API.

rgbColor

string

Valeur de couleur au format #RRGGBB (par exemple, « FFA500 ») ou sous la forme d’une couleur HTML nommée (par exemple, « orange »).

Retours

void

Remarques

Jeu d’API : PowerPointApi 1.10

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

toJSON(): {
            [key: string]: string;
        };

Retours

{ [key: string]: string; }