Excel.ShapeFill class

  • Référence
Paquet:
excel

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

Extends
OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

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 forme au format DE couleur HTML, au format #RRGGBB (par exemple, « FFA500 ») ou en tant que 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, consultez Excel.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.
set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.
set(properties)

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.
setSolidColor(color)

Définit le format de remplissage d’un élément de graphique sur une couleur unie. Cette opération modifie le type de remplissage à « Unie ».
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 Excel.ShapeFill d’origine est un objet API, la toJSON méthode renvoie un objet JavaScript brut (tapé en tant Excel.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é

Excel.RequestContext

foregroundColor

Représente la couleur de premier plan de remplissage de forme au format DE couleur HTML, au format #RRGGBB (par exemple, « FFA500 ») ou en tant que couleur HTML nommée (par exemple, « orange »)

foregroundColor: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

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 : ExcelApi 1.9 ]

type

Renvoie le type de remplissage de la forme. Pour plus d’informations, consultez Excel.ShapeFillType .

readonly type: Excel.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "Mixed";

Valeur de propriété

Excel.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "Mixed"

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

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 : ExcelApi 1.9 ]

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?: Excel.Interfaces.ShapeFillLoadOptions): Excel.ShapeFill;

Paramètres

options
Excel.Interfaces.ShapeFillLoadOptions

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

Retours

Excel.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[]): Excel.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

Excel.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;
        }): Excel.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

Excel.ShapeFill

set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.

set(properties: Interfaces.ShapeFillUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

properties
Excel.Interfaces.ShapeFillUpdateData

Objet JavaScript avec des propriétés qui sont structurées isomorphes en fonction des propriétés de l’objet sur lequel la méthode est appelée.

options
OfficeExtension.UpdateOptions

Fournit une option permettant de supprimer les erreurs si l’objet properties tente de définir des propriétés en lecture seule.

Retours

void

set(properties)

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

set(properties: Excel.ShapeFill): void;

Paramètres

properties
Excel.ShapeFill

Retours

void

setSolidColor(color)

Définit le format de remplissage d’un élément de graphique sur une couleur unie. Cette opération modifie le type de remplissage à « Unie ».

setSolidColor(color: string): void;

Paramètres

color

string

Chaîne qui représente la couleur de remplissage au format de couleur HTML, au format #RRGGBB (par exemple, « FFA500 ») ou sous la forme d’une couleur HTML nommée (par exemple, « orange »).

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

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

toJSON(): Excel.Interfaces.ShapeFillData;

Retours

Excel.Interfaces.ShapeFillData