ExcelScript.ConditionalRangeFormat interface

Paquet:

ExcelScript

Objet de format qui encapsule la police, le remplissage, les bordures et d’autres propriétés de la plage de formats conditionnels.

Remarques

Exemples

/**
 * This script applies cell value conditional formatting to a range.
 * Any value less than 60 will have the cell's fill color changed and the font made italic.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the range to format.
  const selectedRange = workbook.getSelectedRange();

  // Add cell value conditional formatting.
  const cellValueConditionalFormatting =
    selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.cellValue).getCellValue();

  // Create the condition, in this case when the cell value is less than 60.
  const rule: ExcelScript.ConditionalCellValueRule = {
    formula1: "60",
    operator: ExcelScript.ConditionalCellValueOperator.lessThan
  };
  cellValueConditionalFormatting.setRule(rule);

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

Méthodes

getBorders()	Collection d’objets de bordure qui s’appliquent à la plage de format conditionnel globale.
getConditionalRangeBorder(index)	Obtient un objet de bordure à l’aide de son nom.
getConditionalRangeBorderBottom()	Obtient la bordure inférieure.
getConditionalRangeBorderLeft()	Obtient la bordure gauche.
getConditionalRangeBorderRight()	Obtient la bordure droite.
getConditionalRangeBorderTop()	Obtient la bordure supérieure.
getFill()	Renvoie l’objet de remplissage défini sur la plage de format conditionnel globale.
getFont()	Retourne l’objet de police défini sur la plage de format conditionnel globale.
getNumberFormat()	Représente le code de format numérique d’Excel pour la plage donnée. Effacé si null est transmis.
setNumberFormat(numberFormat)	Représente le code de format numérique d’Excel pour la plage donnée. Effacé si null est transmis.

Détails de la méthode

getBorders()

Collection d’objets de bordure qui s’appliquent à la plage de format conditionnel globale.

getBorders(): ConditionalRangeBorder[];

Retours

ExcelScript.ConditionalRangeBorder[]

getConditionalRangeBorder(index)

Obtient un objet de bordure à l’aide de son nom.

getConditionalRangeBorder(
            index: ConditionalRangeBorderIndex
        ): ConditionalRangeBorder;

Paramètres

index

ExcelScript.ConditionalRangeBorderIndex

Valeur d’indice de l’objet de bordure à récupérer. Pour plus d’informations, consultez ExcelScript.ConditionalRangeBorderIndex .

Retours

ExcelScript.ConditionalRangeBorder

getConditionalRangeBorderBottom()

Obtient la bordure inférieure.

getConditionalRangeBorderBottom(): ConditionalRangeBorder;

Retours

ExcelScript.ConditionalRangeBorder

getConditionalRangeBorderLeft()

Obtient la bordure gauche.

getConditionalRangeBorderLeft(): ConditionalRangeBorder;

Retours

ExcelScript.ConditionalRangeBorder

getConditionalRangeBorderRight()

Obtient la bordure droite.

getConditionalRangeBorderRight(): ConditionalRangeBorder;

Retours

ExcelScript.ConditionalRangeBorder

getConditionalRangeBorderTop()

Obtient la bordure supérieure.

getConditionalRangeBorderTop(): ConditionalRangeBorder;

Retours

ExcelScript.ConditionalRangeBorder

getFill()

Renvoie l’objet de remplissage défini sur la plage de format conditionnel globale.

getFill(): ConditionalRangeFill;

Retours

ExcelScript.ConditionalRangeFill

getFont()

Retourne l’objet de police défini sur la plage de format conditionnel globale.

getFont(): ConditionalRangeFont;

Retours

ExcelScript.ConditionalRangeFont

getNumberFormat()

Représente le code de format numérique d’Excel pour la plage donnée. Effacé si null est transmis.

getNumberFormat(): string;

Retours

string

setNumberFormat(numberFormat)

Représente le code de format numérique d’Excel pour la plage donnée. Effacé si null est transmis.

setNumberFormat(numberFormat: string): void;

Paramètres

numberFormat

string

Retours

void