ExcelScript.ConditionalFormat interface

Colis:: ExcelScript

Objet qui encapsule la plage, le format, la règle et d’autres propriétés d’un format conditionnel.

Méthode

changeRuleToCellValue(properties)	Remplacez le type de règle de format conditionnel par la valeur de cellule.
changeRuleToColorScale()	Modifiez le type de règle de format conditionnel en échelle de couleurs.
changeRuleToContainsText(properties)	Remplacez le type de règle de format conditionnel par comparaison de texte.
changeRuleToCustom(formula)	Remplacez le type de règle de format conditionnel par personnalisé.
changeRuleToDataBar()	Remplacez le type de règle de format conditionnel par barre de données.
changeRuleToIconSet()	Remplacez le type de règle de format conditionnel par jeu d’icônes.
changeRuleToPresetCriteria(properties)	Remplacez le type de règle de format conditionnel par critères prédéfinis.
changeRuleToTopBottom(properties)	Modifiez le type de règle de format conditionnel en haut/bas.
delete()	Supprime cette mise en forme conditionnelle.
getCellValue()	Retourne les propriétés de format conditionnel de la valeur de cellule si le format conditionnel actuel est un `CellValue` type.
getColorScale()	Retourne les propriétés de format conditionnel de l’échelle de couleurs si le format conditionnel actuel est un `ColorScale` type.
getCustom()	Retourne les propriétés de format conditionnel personnalisé si le format conditionnel actuel est un type personnalisé.
getDataBar()	Retourne les propriétés de la barre de données si le format conditionnel actuel est une barre de données.
getIconSet()	Retourne les propriétés de mise en forme conditionnelle du jeu d’icônes si le format conditionnel actuel est un `IconSet` type.
getId()	Priorité du format conditionnel dans le actuel `ConditionalFormatCollection`.
getPreset()	Retourne le format conditionnel des critères prédéfinis. Pour plus d’informations, consultez l’article `ExcelScript.PresetCriteriaConditionalFormat`.
getPriority()	Priorité (ou index) dans la collection de formats conditionnels dans laquelle ce format conditionnel existe actuellement. La modification de cela modifie également les priorités des autres formats conditionnels, afin de permettre un ordre de priorité contigu. Utilisez une priorité négative pour commencer à partir de l’arrière. Les priorités supérieures aux limites obtiennent et définissent la priorité maximale (ou minimale si négative). Notez également que si vous modifiez la priorité, vous devez récupérer à nouveau une nouvelle copie de l’objet à cet emplacement de priorité si vous souhaitez y apporter d’autres modifications.
getRange()	Retourne la plage à laquelle le format conditionnel est appliqué. Si le format conditionnel est appliqué à plusieurs plages, cette méthode retourne `undefined`.
getRanges()	Retourne le `RangeAreas`, comprenant une ou plusieurs plages rectangulaires auxquelles le format conditionnel est appliqué.
getStopIfTrue()	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’existe aucun concept de `StopIfTrue` pour ces.
getTextComparison()	Retourne les propriétés de mise en forme conditionnelle de texte spécifiques si le format conditionnel actuel est un type de texte. Par exemple, pour mettre en forme les cellules correspondant au mot « Texte ».
getTopBottom()	Retourne les propriétés de format conditionnel haut/bas si le format conditionnel actuel est un `TopBottom` type. Par exemple, pour mettre en forme les 10 % du haut ou les 10 éléments du bas.
getType()	Type de format conditionnel. Un seul peut être défini à la fois.
setPriority(priority)	Priorité (ou index) dans la collection de formats conditionnels dans laquelle ce format conditionnel existe actuellement. La modification de cela modifie également les priorités des autres formats conditionnels, afin de permettre un ordre de priorité contigu. Utilisez une priorité négative pour commencer à partir de l’arrière. Les priorités supérieures aux limites obtiennent et définissent la priorité maximale (ou minimale si négative). Notez également que si vous modifiez la priorité, vous devez récupérer à nouveau une nouvelle copie de l’objet à cet emplacement de priorité si vous souhaitez y apporter d’autres modifications.
setRanges(ranges)	Définissez les plages auxquelles la règle de mise en forme conditionnelle est appliquée.
setStopIfTrue(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’existe aucun concept de `StopIfTrue` pour ces.

Détails de la méthode

changeRuleToCellValue(properties)

Remplacez le type de règle de format conditionnel par la valeur de cellule.

changeRuleToCellValue(properties: ConditionalCellValueRule): void;

Paramètres

properties: ExcelScript.ConditionalCellValueRule

Propriétés à définir pour la règle de format conditionnel de valeur de cellule.

Retourne

void

changeRuleToColorScale()

Modifiez le type de règle de format conditionnel en échelle de couleurs.

changeRuleToColorScale(): void;

Retourne

void

changeRuleToContainsText(properties)

Remplacez le type de règle de format conditionnel par comparaison de texte.

changeRuleToContainsText(
            properties: ConditionalTextComparisonRule
        ): void;

Paramètres

properties: ExcelScript.ConditionalTextComparisonRule

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

Retourne

void

changeRuleToCustom(formula)

Remplacez le type de règle de format conditionnel par personnalisé.

changeRuleToCustom(formula: string): void;

Paramètres

formula: string

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

Retourne

void

changeRuleToDataBar()

Remplacez le type de règle de format conditionnel par barre de données.

changeRuleToDataBar(): void;

Retourne

void

changeRuleToIconSet()

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

changeRuleToIconSet(): void;

Retourne

void

changeRuleToPresetCriteria(properties)

Remplacez le type de règle de format conditionnel par critères prédéfinis.

changeRuleToPresetCriteria(
            properties: ConditionalPresetCriteriaRule
        ): void;

Paramètres

properties: ExcelScript.ConditionalPresetCriteriaRule

Propriétés à définir pour la règle de mise en forme conditionnelle des critères prédéfinis.

Retourne

void

changeRuleToTopBottom(properties)

Modifiez le type de règle de format conditionnel en haut/bas.

changeRuleToTopBottom(properties: ConditionalTopBottomRule): void;

Paramètres

properties: ExcelScript.ConditionalTopBottomRule

Propriétés à définir pour la règle de mise en forme conditionnelle supérieure/inférieure.

Retourne

void

delete()

Supprime cette mise en forme conditionnelle.

delete(): void;

Retourne

void

getCellValue()

Retourne les propriétés de format conditionnel de la valeur de cellule si le format conditionnel actuel est un CellValue type.

getCellValue(): CellValueConditionalFormat | undefined;

Retourne

ExcelScript.CellValueConditionalFormat | undefined

Exemples

/**
 * This script applies conditional formatting to a range.
 * That formatting is conditional upon the cell's numerical value.
 * Any value between 50 and 75 will have the cell fill color changed and the font made italic.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the range to format.
  const sheet = workbook.getActiveWorksheet();
  const ratingColumn = sheet.getRange("D2:D20");

  // Add cell value conditional formatting.
  const cellValueConditionalFormatting =
    ratingColumn.addConditionalFormat(ExcelScript.ConditionalFormatType.cellValue).getCellValue();
  
  // Create the condition, in this case when the cell value is between 50 and 75.
  let rule: ExcelScript.ConditionalCellValueRule = {
    formula1: "50",
    formula2: "75",
    operator: ExcelScript.ConditionalCellValueOperator.between
  };
  cellValueConditionalFormatting.setRule(rule);

  // Set the format to apply when the condition is met.
  let format = cellValueConditionalFormatting.getFormat();
  format.getFill().setColor("yellow");
  format.getFont().setItalic(true);

}

getColorScale()

Retourne les propriétés de format conditionnel de l’échelle de couleurs si le format conditionnel actuel est un ColorScale type.

getColorScale(): ColorScaleConditionalFormat | undefined;

Retourne

ExcelScript.ColorScaleConditionalFormat | undefined

Exemples

/**
 * This script applies a red, white, and blue color scale to the selected range.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the selected range.
  let selectedRange = workbook.getSelectedRange();

  // Create a new conditional formatting object by adding one to the range.
  let conditionalFormatting = selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.colorScale);

  // Set the colors for the three parts of the scale: minimum, midpoint, and maximum.
  conditionalFormatting.getColorScale().setCriteria({
    minimum: {
      color:"#F8696B", /* A pale red. */
      type:ExcelScript.ConditionalFormatColorCriterionType.lowestValue
    },
    midpoint: {
      color: "#FCFCFF", /* Slightly off-white. */
      formula:'=50',type:ExcelScript.ConditionalFormatColorCriterionType.percentile
    },
    maximum: {
      color: "#5A8AC6", /* A pale blue. */
      type:ExcelScript.ConditionalFormatColorCriterionType.highestValue
    }
  });
}

getCustom()

Retourne les propriétés de format conditionnel personnalisé si le format conditionnel actuel est un type personnalisé.

getCustom(): CustomConditionalFormat | undefined;

Retourne

ExcelScript.CustomConditionalFormat | undefined

Exemples

/**
 * This script applies a custom conditional formatting to the selected range.
 * A light-green fill is applied to a cell if the value is larger than the value in the row's previous column.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the selected cells.
  let selectedRange = workbook.getSelectedRange();

  // Apply a rule for positive change from the previous column.
  let positiveChange = selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.custom);
  positiveChange.getCustom().getFormat().getFill().setColor("lightgreen");
  positiveChange.getCustom().getRule().setFormula(`=${selectedRange.getCell(0, 0).getAddress()}>${selectedRange.getOffsetRange(0, -1).getCell(0, 0).getAddress()}`);
}

getDataBar()

Retourne les propriétés de la barre de données si le format conditionnel actuel est une barre de données.

getDataBar(): DataBarConditionalFormat | undefined;

Retourne

ExcelScript.DataBarConditionalFormat | undefined

Exemples

/**
 * This script creates data bar conditional formatting on the selected range.
 * The scale of the data bar goes from 0 to 1000.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the selected range.
  const selected = workbook.getSelectedRange();
  
  // Create new conditional formatting on the range.
  const format = selected.addConditionalFormat(ExcelScript.ConditionalFormatType.dataBar);
  const dataBarFormat = format.getDataBar();

  // Set the lower bound of the data bar formatting to be 0.
  const lowerBound: ExcelScript.ConditionalDataBarRule = {
    type: ExcelScript.ConditionalFormatRuleType.number,
    formula: "0"
  };
  dataBarFormat.setLowerBoundRule(lowerBound);

  // Set the upper bound of the data bar formatting to be 1000.
  const upperBound: ExcelScript.ConditionalDataBarRule = {
    type: ExcelScript.ConditionalFormatRuleType.number,
    formula: "1000"
  };
  dataBarFormat.setUpperBoundRule(upperBound);
}

getIconSet()

Retourne les propriétés de mise en forme conditionnelle du jeu d’icônes si le format conditionnel actuel est un IconSet type.

getIconSet(): IconSetConditionalFormat | undefined;

Retourne

ExcelScript.IconSetConditionalFormat | undefined

Exemples

/**
 * This script applies icon set conditional formatting to a range.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the range "A1:A5" on the current worksheet.
  const sheet = workbook.getActiveWorksheet();
  const range = sheet.getRange("A1:A5");

  // Create icon set conditional formatting on the range.
  const conditionalFormatting = range.addConditionalFormat(ExcelScript.ConditionalFormatType.iconSet);

  // Use the "3 Traffic Lights (Unrimmed)" set.
  conditionalFormatting.getIconSet().setStyle(ExcelScript.IconSet.threeTrafficLights1);

  // Set the criteria to use a different icon for the bottom, middle, and top thirds of the values in the range.
  conditionalFormatting.getIconSet().setCriteria([
    {
      formula:'=0',operator:ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
      type:ExcelScript.ConditionalFormatIconRuleType.percent
    },
    {
      formula:'=33',operator:ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
      type:ExcelScript.ConditionalFormatIconRuleType.percent},
    {
      formula:'=67',operator:ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
      type:ExcelScript.ConditionalFormatIconRuleType.percent
    }]);
}

getId()

Priorité du format conditionnel dans le actuel ConditionalFormatCollection.

getId(): string;

Retourne

string

getPreset()

Retourne le format conditionnel des critères prédéfinis. Pour plus d’informations, consultez l’article ExcelScript.PresetCriteriaConditionalFormat.

getPreset(): PresetCriteriaConditionalFormat | undefined;

Retourne

ExcelScript.PresetCriteriaConditionalFormat | undefined

Exemples

/**
 * This script applies a conditional format that uses a preset criterion.
 * Any cell in row 1 will have the color fill set to green if it is a duplicate value
 * (of anything else in row 1).
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the range for row 1.
  const sheet = workbook.getActiveWorksheet();
  const formattedRange = sheet.getRange("1:1");

  // Add new conditional formatting to that range.
  const conditionalFormat = formattedRange.addConditionalFormat(
    ExcelScript.ConditionalFormatType.presetCriteria);

  // Set the conditional formatting to apply a green fill.
  const presetFormat = conditionalFormat.getPreset();
  presetFormat.getFormat().getFill().setColor("green");

  // Set a rule to apply the conditional format when values are duplicated in the range.
  const duplicateRule: ExcelScript.ConditionalPresetCriteriaRule = {
    criterion: ExcelScript.ConditionalFormatPresetCriterion.duplicateValues
  };
  presetFormat.setRule(duplicateRule);
}

getPriority()

Priorité (ou index) dans la collection de formats conditionnels dans laquelle ce format conditionnel existe actuellement. La modification de cela modifie également les priorités des autres formats conditionnels, afin de permettre un ordre de priorité contigu. Utilisez une priorité négative pour commencer à partir de l’arrière. Les priorités supérieures aux limites obtiennent et définissent la priorité maximale (ou minimale si négative). Notez également que si vous modifiez la priorité, vous devez récupérer à nouveau une nouvelle copie de l’objet à cet emplacement de priorité si vous souhaitez y apporter d’autres modifications.

getPriority(): number;

Retourne

number

getRange()

Retourne la plage à laquelle le format conditionnel est appliqué. Si le format conditionnel est appliqué à plusieurs plages, cette méthode retourne undefined.

getRange(): Range;

Retourne

ExcelScript.Range

getRanges()

Retourne le RangeAreas, comprenant une ou plusieurs plages rectangulaires auxquelles le format conditionnel est appliqué.

getRanges(): RangeAreas;

Retourne

ExcelScript.RangeAreas

getStopIfTrue()

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’existe aucun concept de StopIfTrue pour ces.

getStopIfTrue(): boolean;

Retourne

boolean

getTextComparison()

Retourne les propriétés de mise en forme conditionnelle de texte spécifiques si le format conditionnel actuel est un type de texte. Par exemple, pour mettre en forme les cellules correspondant au mot « Texte ».

getTextComparison(): TextConditionalFormat | undefined;

Retourne

ExcelScript.TextConditionalFormat | undefined

Exemples

/**
 * This script adds conditional formatting to the first column in the worksheet.
 * This formatting gives the cells a green fill if they have text starting with "Excel".
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first column in the current worksheet.
  const currentSheet = workbook.getActiveWorksheet();
  const firstColumn = currentSheet.getRange("A:A");

  // Add conditional formatting based on the text in the cells.
  const textConditionFormat = 
    firstColumn.addConditionalFormat(ExcelScript.ConditionalFormatType.containsText).getTextComparison();

  // Set the conditional format to provide a green fill.
  textConditionFormat.getFormat().getFill().setColor("green");

  // Apply the condition rule that the text begins with "Excel".
  const textRule: ExcelScript.ConditionalTextComparisonRule = {
    operator: ExcelScript.ConditionalTextOperator.beginsWith,
    text: "Excel"
  };
  textConditionFormat.setRule(textRule);
}

getTopBottom()

Retourne les propriétés de format conditionnel haut/bas si le format conditionnel actuel est un TopBottom type. Par exemple, pour mettre en forme les 10 % du haut ou les 10 éléments du bas.

getTopBottom(): TopBottomConditionalFormat | undefined;

Retourne

ExcelScript.TopBottomConditionalFormat | undefined

Exemples

/**
 * This script applies top/bottom conditional formatting to a range.
 * The top 2 values in the range will have the cell fill color changed to green.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the range to format.
  const sheet = workbook.getWorksheet("TopBottom");
  const dataRange = sheet.getRange("B2:D5");

  // Set the fill color to green for the top 2 values in the range.
  const topBottomFormat = dataRange.addConditionalFormat(
    ExcelScript.ConditionalFormatType.topBottom).getTopBottom();
  topBottomFormat.getFormat().getFill().setColor("green");
  topBottomFormat.setRule({
    rank: 2, /* The numeric threshold. */
    type: ExcelScript.ConditionalTopBottomCriterionType.topItems /* The type of the top/bottom condition. */
  });
}

getType()

Type de format conditionnel. Un seul peut être défini à la fois.

getType(): ConditionalFormatType;

Retourne

ExcelScript.ConditionalFormatType

setPriority(priority)

setPriority(priority: number): void;

Paramètres

priority: number

Retourne

void

setRanges(ranges)

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

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

Paramètres

ranges: ExcelScript.Range | ExcelScript.RangeAreas | string

Collection d’une ou plusieurs plages à appliquer à cette règle.

Retourne

void

setStopIfTrue(stopIfTrue)

setStopIfTrue(stopIfTrue: boolean): void;

Paramètres

stopIfTrue: boolean

Retourne

void

Commentaires

Cette page a-t-elle été utile ?

Partager via

ExcelScript.ConditionalFormat interface

Méthode

Détails de la méthode

changeRuleToCellValue(properties)

Paramètres

Retourne

changeRuleToColorScale()

Retourne

changeRuleToContainsText(properties)

Paramètres

Retourne

changeRuleToCustom(formula)

Paramètres

Retourne

changeRuleToDataBar()

Retourne

changeRuleToIconSet()

Retourne

changeRuleToPresetCriteria(properties)

Paramètres

Retourne

changeRuleToTopBottom(properties)

Paramètres

Retourne

delete()

Retourne

getCellValue()

Retourne

Exemples

getColorScale()

Retourne

Exemples

getCustom()

Retourne

Exemples

getDataBar()

Retourne

Exemples

getIconSet()

Retourne

Exemples

getId()

Retourne

getPreset()

Retourne

Exemples

getPriority()

Retourne

getRange()

Retourne

getRanges()

Retourne

getStopIfTrue()

Retourne

getTextComparison()

Retourne

Exemples

getTopBottom()

Retourne

Exemples

getType()

Retourne

setPriority(priority)

Paramètres

Retourne

setRanges(ranges)

Paramètres

Retourne

setStopIfTrue(stopIfTrue)

Paramètres

Retourne

Commentaires