Excel.RangeFill class
Représente l’arrière-plan d’un objet de plage.
- Extends
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. Cette opération connecte le processus du complément à celui de l’application hôte Office. |
| pattern | Le modèle d’une plage. Pour |
| pattern |
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 »). |
| pattern |
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 |
| tint |
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 |
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 |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| set(properties, options) | 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) | 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 |
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
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é
pattern
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é
Excel.FillPattern | "None" | "Solid" | "Gray50" | "Gray75" | "Gray25" | "Horizontal" | "Vertical" | "Down" | "Up" | "Checker" | "SemiGray75" | "LightHorizontal" | "LightVertical" | "LightDown" | "LightUp" | "Grid" | "CrissCross" | "Gray16" | "Gray8" | "LinearGradient" | "RectangularGradient"
Remarques
patternColor
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é
string
Remarques
patternTintAndShade
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é
number
Remarques
tintAndShade
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é
number
Remarques
Détails de la méthode
clear()
Réinitialise l’arrière-plan de la plage.
clear(): void;Retours
void
Remarques
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
Fournit des options pour les propriétés de l’objet à charger.
Retours
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 spécifiant les propriétés à charger.
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);
});
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
set(properties, options)
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
- properties
- Excel.Interfaces.RangeFillUpdateData
Objet JavaScript dont les propriétés sont structurées de façon isomorphe par rapport aux 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 de propriétés 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.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;