Excel.ConditionalFormat class

Objet encapsulant la plage, la mise en forme, la règle et d’autres propriétés d’une mise en forme conditionnelle. Pour en savoir plus sur le modèle objet de mise en forme conditionnelle, lire Appliquer une mise en forme conditionnelle aux plages Excel.

Extends

Remarques

[Jeu d’API : ExcelApi 1.6]

Propriétés

cellValue

Renvoie les propriétés de mise en forme conditionnelle de la valeur de la cellule si la mise en forme conditionnelle actuelle est un CellValue type.

cellValueOrNullObject

Renvoie les propriétés de mise en forme conditionnelle de la valeur de la cellule si la mise en forme conditionnelle actuelle est un CellValue type.

colorScale

Renvoie les propriétés de mise en forme conditionnelle de l’échelle de couleurs si la mise en forme conditionnelle actuelle est un ColorScale type.

colorScaleOrNullObject

Renvoie les propriétés de mise en forme conditionnelle de l’échelle de couleurs si la mise en forme conditionnelle actuelle est un ColorScale type.

context

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

custom

Renvoie les propriétés de mise en forme conditionnelle personnalisée si la mise en forme conditionnelle actuelle est de type personnalisé.

customOrNullObject

Renvoie les propriétés de mise en forme conditionnelle personnalisée si la mise en forme conditionnelle actuelle est de type personnalisé.

dataBar

Renvoie les propriétés de la barre de données si la mise en forme conditionnelle actuelle est une barre de données.

dataBarOrNullObject

Renvoie les propriétés de la barre de données si la mise en forme conditionnelle actuelle est une barre de données.

iconSet

Renvoie les propriétés de mise en forme conditionnelle du jeu d’icônes si la mise en forme conditionnelle actuelle est un IconSet type.

iconSetOrNullObject

Renvoie les propriétés de mise en forme conditionnelle du jeu d’icônes si la mise en forme conditionnelle actuelle est un IconSet type.

id

Priorité de la mise en forme conditionnelle dans le ConditionalFormatCollectionfichier .

preset

Renvoie la mise en forme conditionnelle de critères prédéfinis. Pour plus d’informations, consultez l’article Excel.PresetCriteriaConditionalFormat.

presetOrNullObject

Renvoie la mise en forme conditionnelle de critères prédéfinis. Pour plus d’informations, consultez l’article Excel.PresetCriteriaConditionalFormat.

priority

Priorité (ou index) dans la collection de mise en forme conditionnelle dans laquelle cette mise en forme conditionnelle existe actuellement. La modification de cette option modifie également les priorités des autres formats conditionnels afin de tenir compte d’un ordre de priorité contigu. Utilisez une priorité négative pour commencer par l’arrière. Les priorités supérieures aux limites sont obtenues et définies sur la priorité maximale (ou minimale si négative). Notez également que si vous modifiez la priorité, vous devez récupérer une nouvelle copie de l’objet à ce nouvel emplacement prioritaire si vous souhaitez y apporter d’autres modifications.

stopIfTrue

Si les conditions de cette mise en forme conditionnelle sont remplies, aucun format de priorité inférieure ne doit prendre effet sur cette cellule. La valeur se trouve null sur les barres de données, les jeux d’icônes et les échelles de couleurs, car il n’y a pas de concept pour StopIfTrue ceux-ci.

textComparison

Renvoie les propriétés de mise en forme conditionnelle de texte spécifiques si la mise en forme conditionnelle actuelle est un type de texte. Par exemple, pour mettre en forme les cellules correspondant au mot « Texte ».

textComparisonOrNullObject

Renvoie les propriétés de mise en forme conditionnelle de texte spécifiques si la mise en forme conditionnelle actuelle est un type de texte. Par exemple, pour mettre en forme les cellules correspondant au mot « Texte ».

topBottom

Renvoie les propriétés de mise en forme conditionnelle haut/bas si la mise en forme conditionnelle actuelle est un TopBottom type. Par exemple, pour mettre en forme les 10 % supérieurs ou les 10 éléments inférieurs.

topBottomOrNullObject

Renvoie les propriétés de mise en forme conditionnelle haut/bas si la mise en forme conditionnelle actuelle est un TopBottom type. Par exemple, pour mettre en forme les 10 % supérieurs ou les 10 éléments inférieurs.

type

Type de mise en forme conditionnelle. Un seul peut être défini à la fois.

Méthodes

changeRuleToCellValue(properties)

Modifiez le type de règle de mise en forme conditionnelle par valeur de cellule.

changeRuleToColorScale()

Remplacer le type de règle de mise en forme conditionnelle par Échelle de couleurs.

changeRuleToContainsText(properties)

Remplacer le type de règle de mise en forme conditionnelle par comparaison de texte.

changeRuleToCustom(formula)

Modifiez le type de règle de format conditionnel sur personnalisé.

changeRuleToDataBar()

Remplacer le type de règle de mise en forme conditionnelle par barre de données.

changeRuleToIconSet()

Remplacez le type de règle de format conditionnel par jeu d’icônes.

changeRuleToPresetCriteria(properties)

Modifiez le type de règle de mise en forme conditionnelle en fonction de critères prédéfinis.

changeRuleToTopBottom(properties)

Remplacez le type de règle de format conditionnel par haut/bas.

delete()

Supprime cette mise en forme conditionnelle.

getRange()

Renvoie la plage à laquelle s’applique la mise en forme conditionnelle. Génère une erreur si la mise en forme conditionnelle est appliquée à plusieurs plages.

getRangeOrNullObject()

Renvoie la plage à laquelle la mise en forme conditionnelle est appliquée. Si la mise en forme conditionnelle est appliquée à plusieurs plages, 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.

getRanges()

Renvoie la RangeAreas, composée d’une ou plusieurs plages rectangulaires, à laquelle la mise en forme conditionnelle est appliquée.

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

setRanges(ranges)

Définir les plages auxquelles la règle de mise en forme conditionnelle est appliquée.

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

Détails de la propriété

cellValue

Renvoie les propriétés de mise en forme conditionnelle de la valeur de la cellule si la mise en forme conditionnelle actuelle est un CellValue type.

readonly cellValue: Excel.CellValueConditionalFormat;

Valeur de propriété

Remarques

[Jeu d’API : ExcelApi 1.6]

cellValueOrNullObject

Renvoie les propriétés de mise en forme conditionnelle de la valeur de la cellule si la mise en forme conditionnelle actuelle est un CellValue type.

readonly cellValueOrNullObject: Excel.CellValueConditionalFormat;

Valeur de propriété

Remarques

[Jeu d’API : ExcelApi 1.6]

colorScale

Renvoie les propriétés de mise en forme conditionnelle de l’échelle de couleurs si la mise en forme conditionnelle actuelle est un ColorScale type.

readonly colorScale: Excel.ColorScaleConditionalFormat;

Valeur de propriété

Remarques

[Jeu d’API : ExcelApi 1.6]

colorScaleOrNullObject

Renvoie les propriétés de mise en forme conditionnelle de l’échelle de couleurs si la mise en forme conditionnelle actuelle est un ColorScale type.

readonly colorScaleOrNullObject: Excel.ColorScaleConditionalFormat;

Valeur de propriété

Remarques

[Jeu d’API : ExcelApi 1.6]

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é

custom

Renvoie les propriétés de mise en forme conditionnelle personnalisée si la mise en forme conditionnelle actuelle est de type personnalisé.

readonly custom: Excel.CustomConditionalFormat;

Valeur de propriété

Remarques

[Jeu d’API : ExcelApi 1.6]

customOrNullObject

Renvoie les propriétés de mise en forme conditionnelle personnalisée si la mise en forme conditionnelle actuelle est de type personnalisé.

readonly customOrNullObject: Excel.CustomConditionalFormat;

Valeur de propriété

Remarques

[Jeu d’API : ExcelApi 1.6]

dataBar

Renvoie les propriétés de la barre de données si la mise en forme conditionnelle actuelle est une barre de données.

readonly dataBar: Excel.DataBarConditionalFormat;

Valeur de propriété

Remarques

[Jeu d’API : ExcelApi 1.6]

dataBarOrNullObject

Renvoie les propriétés de la barre de données si la mise en forme conditionnelle actuelle est une barre de données.

readonly dataBarOrNullObject: Excel.DataBarConditionalFormat;

Valeur de propriété

Remarques

[Jeu d’API : ExcelApi 1.6]

iconSet

Renvoie les propriétés de mise en forme conditionnelle du jeu d’icônes si la mise en forme conditionnelle actuelle est un IconSet type.

readonly iconSet: Excel.IconSetConditionalFormat;

Valeur de propriété

Remarques

[Jeu d’API : ExcelApi 1.6]

iconSetOrNullObject

Renvoie les propriétés de mise en forme conditionnelle du jeu d’icônes si la mise en forme conditionnelle actuelle est un IconSet type.

readonly iconSetOrNullObject: Excel.IconSetConditionalFormat;

Valeur de propriété

Remarques

[Jeu d’API : ExcelApi 1.6]

id

Priorité de la mise en forme conditionnelle dans le ConditionalFormatCollectionfichier .

readonly id: string;

Valeur de propriété

string

Remarques

[Jeu d’API : ExcelApi 1.6]

preset

Renvoie la mise en forme conditionnelle de critères prédéfinis. Pour plus d’informations, consultez l’article Excel.PresetCriteriaConditionalFormat.

readonly preset: Excel.PresetCriteriaConditionalFormat;

Valeur de propriété

Remarques

[Jeu d’API : ExcelApi 1.6]

presetOrNullObject

Renvoie la mise en forme conditionnelle de critères prédéfinis. Pour plus d’informations, consultez l’article Excel.PresetCriteriaConditionalFormat.

readonly presetOrNullObject: Excel.PresetCriteriaConditionalFormat;

Valeur de propriété

Remarques

[Jeu d’API : ExcelApi 1.6]

priority

Priorité (ou index) dans la collection de mise en forme conditionnelle dans laquelle cette mise en forme conditionnelle existe actuellement. La modification de cette option modifie également les priorités des autres formats conditionnels afin de tenir compte d’un ordre de priorité contigu. Utilisez une priorité négative pour commencer par l’arrière. Les priorités supérieures aux limites sont obtenues et définies sur la priorité maximale (ou minimale si négative). Notez également que si vous modifiez la priorité, vous devez récupérer une nouvelle copie de l’objet à ce nouvel emplacement prioritaire si vous souhaitez y apporter d’autres modifications.

priority: number;

Valeur de propriété

number

Remarques

[Jeu d’API : ExcelApi 1.6]

stopIfTrue

Si les conditions de cette mise en forme conditionnelle sont remplies, aucun format de priorité inférieure ne doit prendre effet sur cette cellule. La valeur se trouve null sur les barres de données, les jeux d’icônes et les échelles de couleurs, car il n’y a pas de concept pour StopIfTrue ceux-ci.

stopIfTrue: boolean;

Valeur de propriété

boolean

Remarques

[Jeu d’API : ExcelApi 1.6]

textComparison

Renvoie les propriétés de mise en forme conditionnelle de texte spécifiques si la mise en forme conditionnelle actuelle est un type de texte. Par exemple, pour mettre en forme les cellules correspondant au mot « Texte ».

readonly textComparison: Excel.TextConditionalFormat;

Valeur de propriété

Remarques

[Jeu d’API : ExcelApi 1.6]

textComparisonOrNullObject

Renvoie les propriétés de mise en forme conditionnelle de texte spécifiques si la mise en forme conditionnelle actuelle est un type de texte. Par exemple, pour mettre en forme les cellules correspondant au mot « Texte ».

readonly textComparisonOrNullObject: Excel.TextConditionalFormat;

Valeur de propriété

Remarques

[Jeu d’API : ExcelApi 1.6]

topBottom

Renvoie les propriétés de mise en forme conditionnelle haut/bas si la mise en forme conditionnelle actuelle est un TopBottom type. Par exemple, pour mettre en forme les 10 % supérieurs ou les 10 éléments inférieurs.

readonly topBottom: Excel.TopBottomConditionalFormat;

Valeur de propriété

Remarques

[Jeu d’API : ExcelApi 1.6]

topBottomOrNullObject

Renvoie les propriétés de mise en forme conditionnelle haut/bas si la mise en forme conditionnelle actuelle est un TopBottom type. Par exemple, pour mettre en forme les 10 % supérieurs ou les 10 éléments inférieurs.

readonly topBottomOrNullObject: Excel.TopBottomConditionalFormat;

Valeur de propriété

Remarques

[Jeu d’API : ExcelApi 1.6]

type

Type de mise en forme conditionnelle. Un seul peut être défini à la fois.

readonly type: Excel.ConditionalFormatType | "Custom" | "DataBar" | "ColorScale" | "IconSet" | "TopBottom" | "PresetCriteria" | "ContainsText" | "CellValue";

Valeur de propriété

Excel.ConditionalFormatType | "Custom" | "DataBar" | "ColorScale" | "IconSet" | "TopBottom" | "PresetCriteria" | "ContainsText" | "CellValue"

Remarques

[Jeu d’API : ExcelApi 1.6]

Détails de la méthode

changeRuleToCellValue(properties)

Modifiez le type de règle de mise en forme conditionnelle par valeur de cellule.

changeRuleToCellValue(properties: Excel.ConditionalCellValueRule): void;

Paramètres

properties
Excel.ConditionalCellValueRule

Propriétés à définir pour la règle de mise en forme conditionnelle de la valeur d’une cellule.

Retours

void

Remarques

[Jeu d’API : ExcelApi 1.17]

changeRuleToColorScale()

Remplacer le type de règle de mise en forme conditionnelle par Échelle de couleurs.

changeRuleToColorScale(): void;

Retours

void

Remarques

[Jeu d’API : ExcelApi 1.17]

changeRuleToContainsText(properties)

Remplacer le type de règle de mise en forme conditionnelle par comparaison de texte.

changeRuleToContainsText(properties: Excel.ConditionalTextComparisonRule): void;

Paramètres

properties
Excel.ConditionalTextComparisonRule

Les propriétés à définir pour la règle de mise en forme conditionnelle de comparaison de texte.

Retours

void

Remarques

[Jeu d’API : ExcelApi 1.17]

changeRuleToCustom(formula)

Modifiez le type de règle de format conditionnel sur personnalisé.

changeRuleToCustom(formula: string): void;

Paramètres

formula

string

Formule à définir pour la règle de mise en forme conditionnelle personnalisée.

Retours

void

Remarques

[Jeu d’API : ExcelApi 1.17]

changeRuleToDataBar()

Remplacer le type de règle de mise en forme conditionnelle par barre de données.

changeRuleToDataBar(): void;

Retours

void

Remarques

[Jeu d’API : ExcelApi 1.17]

changeRuleToIconSet()

Remplacez le type de règle de format conditionnel par jeu d’icônes.

changeRuleToIconSet(): void;

Retours

void

Remarques

[Jeu d’API : ExcelApi 1.17]

changeRuleToPresetCriteria(properties)

Modifiez le type de règle de mise en forme conditionnelle en fonction de critères prédéfinis.

changeRuleToPresetCriteria(properties: Excel.ConditionalPresetCriteriaRule): void;

Paramètres

properties
Excel.ConditionalPresetCriteriaRule

Les propriétés à définir pour les critères prédéfinis règle de format conditionnel.

Retours

void

Remarques

[Jeu d’API : ExcelApi 1.17]

changeRuleToTopBottom(properties)

Remplacez le type de règle de format conditionnel par haut/bas.

changeRuleToTopBottom(properties: Excel.ConditionalTopBottomRule): void;

Paramètres

properties
Excel.ConditionalTopBottomRule

Propriétés à définir pour la règle de mise en forme conditionnelle haut/minimum.

Retours

void

Remarques

[Jeu d’API : ExcelApi 1.17]

delete()

Supprime cette mise en forme conditionnelle.

delete(): void;

Retours

void

Remarques

[Jeu d’API : ExcelApi 1.6]

getRange()

Renvoie la plage à laquelle s’applique la mise en forme conditionnelle. Génère une erreur si la mise en forme conditionnelle est appliquée à plusieurs plages.

getRange(): Excel.Range;

Retours

Remarques

[Jeu d’API : ExcelApi 1.6]

getRangeOrNullObject()

Renvoie la plage à laquelle la mise en forme conditionnelle est appliquée. Si la mise en forme conditionnelle est appliquée à plusieurs plages, 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.

getRangeOrNullObject(): Excel.Range;

Retours

Remarques

[Jeu d’API : ExcelApi 1.6]

getRanges()

Renvoie la RangeAreas, composée d’une ou plusieurs plages rectangulaires, à laquelle la mise en forme conditionnelle est appliquée.

getRanges(): Excel.RangeAreas;

Retours

Remarques

[Jeu 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.ConditionalFormatLoadOptions): Excel.ConditionalFormat;

Paramètres

options
Excel.Interfaces.ConditionalFormatLoadOptions

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

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?: {
            select?: string;
            expand?: string;
        }): Excel.ConditionalFormat;

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

Paramètres

properties
Excel.Interfaces.ConditionalFormatUpdateData

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

Paramètres

Retours

void

setRanges(ranges)

Définir les plages auxquelles la règle de mise en forme conditionnelle est appliquée.

setRanges(ranges: Range | RangeAreas | string): void;

Paramètres

ranges

Excel.Range | Excel.RangeAreas | string

Collection d’une ou plusieurs plages auxquelles cette règle doit s’appliquer.

Retours

void

Remarques

[Jeu d’API : ExcelApi 1.17]

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

toJSON(): Excel.Interfaces.ConditionalFormatData;

Retours