Excel.ConditionalFormatCollection class
Représente un ensemble de toutes les mises en forme conditionnelles qui chevauchent la plage.
- Extends
Remarques
Utilisateur
Propriétés
| context | Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office. |
| items | Obtient l’élément enfant chargé dans cette collection de sites. |
Méthodes
| add(type) | Ajoute une nouvelle mise en forme conditionnelle à la collection au niveau de la première/priorité absolue. |
| add(type) | Ajoute une nouvelle mise en forme conditionnelle à la collection au niveau de la première/priorité absolue. |
| clear |
Efface toutes les mises en forme conditionnelles actives sur la plage spécifiée actuelle. |
| get |
Renvoie le nombre de mises en forme conditionnelles dans le classeur. |
| get |
Renvoie une mise en forme conditionnelle à un ID donné. |
| get |
Renvoie une mise en forme conditionnelle à l’index donné. |
| get |
Renvoie une mise en forme conditionnelle identifiée par son ID. Si l’objet de mise en forme conditionnelle n’existe pas, cette méthode renvoie un objet dont la |
| 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 |
| toJSON() | Remplace la méthode JavaScript |
Détails de la propriété
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é
items
Obtient l’élément enfant chargé dans cette collection de sites.
readonly items: Excel.ConditionalFormat[];Valeur de propriété
Détails de la méthode
add(type)
Ajoute une nouvelle mise en forme conditionnelle à la collection au niveau de la première/priorité absolue.
add(type: Excel.ConditionalFormatType): Excel.ConditionalFormat;Paramètres
Type de mise en forme conditionnelle en cours d’ajout. Pour Excel.ConditionalFormatType plus de détails.
Retours
Remarques
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
const range = sheet.getRange("B2:M5");
const conditionalFormat = range.conditionalFormats
.add(Excel.ConditionalFormatType.colorScale);
const criteria = {
minimum: { formula: null, type: Excel.ConditionalFormatColorCriterionType.lowestValue, color: "blue" },
midpoint: { formula: "50", type: Excel.ConditionalFormatColorCriterionType.percent, color: "yellow" },
maximum: { formula: null, type: Excel.ConditionalFormatColorCriterionType.highestValue, color: "red" }
};
conditionalFormat.colorScale.criteria = criteria;
await context.sync();
});
add(type)
Ajoute une nouvelle mise en forme conditionnelle à la collection au niveau de la première/priorité absolue.
add(type: "Custom" | "DataBar" | "ColorScale" | "IconSet" | "TopBottom" | "PresetCriteria" | "ContainsText" | "CellValue"): Excel.ConditionalFormat;Paramètres
- type
-
"Custom" | "DataBar" | "ColorScale" | "IconSet" | "TopBottom" | "PresetCriteria" | "ContainsText" | "CellValue"
Type de mise en forme conditionnelle en cours d’ajout. Pour Excel.ConditionalFormatType plus de détails.
Retours
Remarques
clearAll()
Efface toutes les mises en forme conditionnelles actives sur la plage spécifiée actuelle.
clearAll(): void;Retours
void
Remarques
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
const range = sheet.getRange();
range.conditionalFormats.clearAll();
await context.sync();
});
getCount()
Renvoie le nombre de mises en forme conditionnelles dans le classeur.
getCount(): OfficeExtension.ClientResult<number>;Retours
OfficeExtension.ClientResult<number>
Remarques
Exemples
await Excel.run(async (context) => {
const sheetName = "Sheet1";
const rangeAddress = "A1:C3";
const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
const conditionalFormat = range.conditionalFormats.add(Excel.ConditionalFormatType.iconSet);
conditionalFormat.iconSetOrNullObject.style = Excel.IconSet.fourTrafficLights;
const cfCount = range.conditionalFormats.getCount();
await context.sync()
console.log("Count: " + cfCount.value);
});
getItem(id)
Renvoie une mise en forme conditionnelle à un ID donné.
getItem(id: string): Excel.ConditionalFormat;Paramètres
- id
-
string
ID de la mise en forme conditionnelle.
Retours
Objet de format conditionnel.
Remarques
Exemples
await Excel.run(async (context) => {
const sheetName = "Sheet1";
const rangeAddress = "A1:C3";
const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
const conditionalFormats = range.conditionalFormats;
const conditionalFormat = conditionalFormats.getItemAt(3);
await context.sync()
console.log("Conditional Format at Item 3 Loaded");
});
getItemAt(index)
Renvoie une mise en forme conditionnelle à l’index donné.
getItemAt(index: number): Excel.ConditionalFormat;Paramètres
- index
-
number
Index des formats conditionnels à récupérer.
Retours
Remarques
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
const worksheetRange = sheet.getRange();
worksheetRange.conditionalFormats.load("type");
await context.sync();
let cfRangePairs: { cf: Excel.ConditionalFormat, range: Excel.Range }[] = [];
worksheetRange.conditionalFormats.items.forEach(item => {
cfRangePairs.push({
cf: item,
range: item.getRange().load("address")
});
});
await context.sync();
if (cfRangePairs.length > 0) {
cfRangePairs.forEach(item => {
console.log(item.cf.type);
});
} else {
console.log("No conditional formats applied.");
}
});
getItemOrNullObject(id)
Renvoie une mise en forme conditionnelle identifiée par son ID. Si l’objet de mise en forme conditionnelle n’existe pas, cette méthode renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.
getItemOrNullObject(id: string): Excel.ConditionalFormat;Paramètres
- id
-
string
ID de la mise en forme conditionnelle.
Retours
Remarques
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.ConditionalFormatCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ConditionalFormatCollection;Paramètres
- options
-
Excel.Interfaces.ConditionalFormatCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions
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.ConditionalFormatCollection;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
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?: OfficeExtension.LoadOption): Excel.ConditionalFormatCollection;Paramètres
- propertyNamesAndPaths
- OfficeExtension.LoadOption
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
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.ConditionalFormatCollection est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.ConditionalFormatCollectionDataqui contient un tableau « items » avec des copies superficielles de toutes les propriétés chargées à partir des éléments de la collection.
toJSON(): Excel.Interfaces.ConditionalFormatCollectionData;