Excel.RangeFill class

Paquet:

excel

Représente l’arrière-plan d’un objet de plage.

Extends

OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

Propriétés

color	Code de couleur HTML représentant la couleur de l’arrière-plan, sous la forme #RRGGBB (par exemple, « FFA500 ») ou sous la forme d’une couleur HTML nommée (par exemple, « orange »)
context	Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

Méthodes

clear()	Réinitialise l’arrière-plan de la plage.
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.
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 d’origine Excel.RangeFill est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.RangeFillDataque ) 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é

color

Code de couleur HTML représentant la couleur de l’arrière-plan, sous la forme #RRGGBB (par exemple, « FFA500 ») ou sous la forme d’une couleur HTML nommée (par exemple, « orange »)

color: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

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

Détails de la méthode

clear()

Réinitialise l’arrière-plan de la plage.

clear(): void;

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

Exemples

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "F:G";
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const range = worksheet.getRange(rangeAddress);
    const rangeFill = range.format.fill;
    rangeFill.clear();
    await context.sync(); 
});

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

Paramètres

options

Excel.Interfaces.RangeFillLoadOptions

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

Retours

Excel.RangeFill

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

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

Exemples

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "F:G";
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const range = worksheet.getRange(rangeAddress);
    const rangeFill = range.format.fill;
    rangeFill.load('color');
    await context.sync();
    console.log(rangeFill.color);
});

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

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

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.RangeFillUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

properties

Excel.Interfaces.RangeFillUpdateData

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.RangeFill): void;

Paramètres

properties

Excel.RangeFill

Retours

void

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

toJSON(): Excel.Interfaces.RangeFillData;

Retours

Excel.Interfaces.RangeFillData