Excel.RangeFill class

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é

Remarques

Jeu d’API : ExcelApi 1.1

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é

Le modèle d’une plage. Pour Excel.FillPattern plus de détails. LinearGradient et RectangularGradient ne sont pas pris en charge. Une null valeur indique que toute la plage n’a pas de paramètre de modèle uniforme.

pattern: Excel.FillPattern | "None" | "Solid" | "Gray50" | "Gray75" | "Gray25" | "Horizontal" | "Vertical" | "Down" | "Up" | "Checker" | "SemiGray75" | "LightHorizontal" | "LightVertical" | "LightDown" | "LightUp" | "Grid" | "CrissCross" | "Gray16" | "Gray8" | "LinearGradient" | "RectangularGradient";

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.9

Code de couleur HTML représentant la couleur du modèle de plage, sous la forme #RRGGBB (par exemple, « FFA500 ») ou sous la forme d’une couleur HTML nommée (par exemple, « orange »).

patternColor: string;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.9

Spécifie un double qui éclaircit ou assombrit une couleur de motif pour le remplissage de la plage. La valeur est comprise entre -1 (le plus foncé) et 1 (le plus clair), avec 0 pour la couleur d’origine. Une null valeur indique que la plage ne possède pas de paramètres uniformes patternTintAndShade .

patternTintAndShade: number;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.9

Spécifie un double qui éclaircit ou assombrit une couleur pour le remplissage de la plage. La valeur est comprise entre -1 (le plus foncé) et 1 (le plus clair), avec 0 pour la couleur d’origine. Une null valeur indique que la plage ne possède pas de paramètres uniformes tintAndShade .

tintAndShade: number;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.9

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

clear(): void;

Retours

Remarques

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

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

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

Paramètres

Retours

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

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

Retours

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.

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

Paramètres

Retours

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

Retours

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

toJSON(): Excel.Interfaces.RangeFillData;

Retours