PowerPoint.ShapeFill class

  • Référence
Paquet:
powerpoint

Représente la mise en forme de remplissage d’un objet shape.

Extends
OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : PowerPointApi 1.4 ]

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.
foregroundColor

Représente la couleur de premier plan de remplissage de la forme au format HTML, au format #RRGGBB (par exemple, « FFA500 ») ou sous la forme d’une couleur HTML nommée (par exemple, « orange »).
transparency

Spécifie le pourcentage de transparence du remplissage sous la forme d’une valeur comprise entre 0,0 (opaque) et 1,0 (clair). Renvoie null si le type de forme ne prend pas en charge la transparence ou si le remplissage de la forme présente une transparence incohérente, par exemple avec un type de remplissage dégradé.
type

Renvoie le type de remplissage de la forme. Pour plus d’informations , voir PowerPoint.ShapeFillType .

Méthodes

clear()

Renvoie la mise en forme de remplissage de cette forme.
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(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(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.
setSolidColor(color)

Définit le format de remplissage d’un élément de graphique sur une couleur unie. Cela remplace le type de remplissage par Solid.
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.ShapeFill d’origine est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant PowerPoint.Interfaces.ShapeFillDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

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é

PowerPoint.RequestContext

foregroundColor

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

foregroundColor: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : PowerPointApi 1.4 ]

transparency

Spécifie le pourcentage de transparence du remplissage sous la forme d’une valeur comprise entre 0,0 (opaque) et 1,0 (clair). Renvoie null si le type de forme ne prend pas en charge la transparence ou si le remplissage de la forme présente une transparence incohérente, par exemple avec un type de remplissage dégradé.

transparency: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : PowerPointApi 1.4 ]

type

Renvoie le type de remplissage de la forme. Pour plus d’informations , voir PowerPoint.ShapeFillType .

readonly type: PowerPoint.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "SlideBackground";

Valeur de propriété

PowerPoint.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "SlideBackground"

Remarques

[ Ensemble d’API : PowerPointApi 1.4 ]

Détails de la méthode

clear()

Renvoie la mise en forme de remplissage de cette forme.

clear(): void;

Retours

void

Remarques

[ Ensemble d’API : PowerPointApi 1.4 ]

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.ShapeFillLoadOptions): PowerPoint.ShapeFill;

Paramètres

options
PowerPoint.Interfaces.ShapeFillLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

PowerPoint.ShapeFill

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

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

PowerPoint.ShapeFill

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

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

PowerPoint.ShapeFill

setSolidColor(color)

Définit le format de remplissage d’un élément de graphique sur une couleur unie. Cela remplace le type de remplissage par Solid.

setSolidColor(color: string): void;

Paramètres

color

string

Chaîne qui spécifie la couleur de remplissage au format HTML, au format #RRGGBB (par exemple, « FFA500 ») ou en tant que couleur HTML nommée (par exemple, « orange »).

Retours

void

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();
});

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.ShapeFill d’origine est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant PowerPoint.Interfaces.ShapeFillDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): PowerPoint.Interfaces.ShapeFillData;

Retours

PowerPoint.Interfaces.ShapeFillData