ExcelScript.ConditionalFormat interface

Altere o tipo de regra de formato condicional para valor de célula.

changeRuleToCellValue(properties: ConditionalCellValueRule): void;

Parâmetros

Retornos

Altere o tipo de regra de formato condicional para escala de cores.

changeRuleToColorScale(): void;

Retornos

Altere o tipo de regra de formato condicional para comparação de texto.

changeRuleToContainsText(
            properties: ConditionalTextComparisonRule
        ): void;

Parâmetros

Retornos

Altere o tipo de regra de formato condicional para personalizado.

changeRuleToCustom(formula: string): void;

Parâmetros

Retornos

Altere o tipo de regra de formato condicional para barra de dados.

changeRuleToDataBar(): void;

Retornos

Altere o tipo de regra de formato condicional para conjunto de ícones.

changeRuleToIconSet(): void;

Retornos

Altere o tipo de regra de formato condicional para critérios predefinidos.

changeRuleToPresetCriteria(
            properties: ConditionalPresetCriteriaRule
        ): void;

Parâmetros

Retornos

Altere o tipo de regra de formato condicional para superior/inferior.

changeRuleToTopBottom(properties: ConditionalTopBottomRule): void;

Parâmetros

Retornos

Exclui esse formato condicional.

delete(): void;

Retornos

Retorna as propriedades de formato condicional do valor da célula se o formato condicional atual é um CellValue tipo.

getCellValue(): CellValueConditionalFormat | undefined;

Retornos

Exemplos

/**
 * 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);

}

Retorna as propriedades de formato condicional da escala de cores se o formato condicional atual for um ColorScale tipo.

getColorScale(): ColorScaleConditionalFormat | undefined;

Retornos

Exemplos

/**
 * 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
    }
  });
}

Retorna as propriedades de formato condicional personalizadas se o formato condicional atual for um tipo personalizado.

getCustom(): CustomConditionalFormat | undefined;

Retornos

Exemplos

/**
 * 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()}`);
}

Retorna as propriedades da barra de dados se o formato condicional atual for uma barra de dados.

getDataBar(): DataBarConditionalFormat | undefined;

Retornos

Exemplos

/**
 * 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);
}

Retorna as propriedades de formato condicional do conjunto de ícones se o formato condicional atual for um IconSet tipo.

getIconSet(): IconSetConditionalFormat | undefined;

Retornos

Exemplos

/**
 * 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
    }]);
}

A prioridade do formato condicional no arquivo .ConditionalFormatCollection

getId(): string;

Retornos

Retorna o formato condicional dos critérios predefinidos. Veja ExcelScript.PresetCriteriaConditionalFormat para obter detalhes.

getPreset(): PresetCriteriaConditionalFormat | undefined;

Retornos

Exemplos

/**
 * 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);
}

A prioridade (ou índice) dentro da coleção de formato condicional em que esse formato condicional existe atualmente. Alterar isso também altera as prioridades de outros formatos condicionais, para permitir uma ordem de prioridade contígua. Use uma prioridade negativa para começar de trás. Prioridades maiores que os limites serão obtidas e definidas como prioridade máxima (ou mínima, se negativa). Observe também que, se você alterar a prioridade, precisará buscar novamente uma nova cópia do objeto nesse novo local de prioridade se quiser fazer mais alterações nele.

getPriority(): number;

Retornos

Retorna o intervalo ao qual o formato condicional é aplicado. Se o formato condicional for aplicado a vários intervalos, esse método retornará undefined.

getRange(): Range;

Retornos

Retorna o RangeAreas, que compreende um ou mais intervalos retangulares, ao qual o formato condicional é aplicado.

getRanges(): RangeAreas;

Retornos

Se as condições desse formato condicional forem atendidas, nenhum formato de prioridade mais baixa terá efeito nessa célula. O valor está null nas barras de dados, conjuntos de ícones e escalas de cores, pois não há conceito para StopIfTrue eles.

getStopIfTrue(): boolean;

Retornos

Retorna as propriedades de formato condicional de texto específicas se o formato condicional atual for um tipo de texto. Por exemplo, para formatar células correspondentes à palavra "Texto".

getTextComparison(): TextConditionalFormat | undefined;

Retornos

Exemplos

/**
 * 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);
}

Retorna as propriedades de formato condicional superior/inferior se o formato condicional atual for um TopBottom tipo. Por exemplo, para formatar os 10% principais ou os 10 itens inferiores.

getTopBottom(): TopBottomConditionalFormat | undefined;

Retornos

Exemplos

/**
 * 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. */
  });
}

Um tipo de formato condicional. Somente um pode ser definido por vez.

getType(): ConditionalFormatType;

Retornos

A prioridade (ou índice) dentro da coleção de formato condicional em que esse formato condicional existe atualmente. Alterar isso também altera as prioridades de outros formatos condicionais, para permitir uma ordem de prioridade contígua. Use uma prioridade negativa para começar de trás. Prioridades maiores que os limites serão obtidas e definidas como prioridade máxima (ou mínima, se negativa). Observe também que, se você alterar a prioridade, precisará buscar novamente uma nova cópia do objeto nesse novo local de prioridade se quiser fazer mais alterações nele.

setPriority(priority: number): void;

Parâmetros

Retornos

Defina os intervalos aos quais a regra de formato condicional é aplicada.

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

Parâmetros

Retornos

Se as condições desse formato condicional forem atendidas, nenhum formato de prioridade mais baixa terá efeito nessa célula. O valor está null nas barras de dados, conjuntos de ícones e escalas de cores, pois não há conceito para StopIfTrue eles.

setStopIfTrue(stopIfTrue: boolean): void;

Parâmetros

Retornos