ExcelScript.TopBottomConditionalFormat interface

Representa um formato condicional superior/inferior.

Métodos

getFormat()

Retorna um objeto Format, encapsulando a fonte, o preenchimento, as bordas e outras propriedades do formato condicional.

getRule()

Os critérios do formato condicional superior/inferior.

setRule(rule)

Os critérios do formato condicional superior/inferior.

Detalhes do método

getFormat()

Retorna um objeto Format, encapsulando a fonte, o preenchimento, as bordas e outras propriedades do formato condicional.

getFormat(): ConditionalRangeFormat;

Retornos

getRule()

Os critérios do formato condicional superior/inferior.

getRule(): ConditionalTopBottomRule;

Retornos

setRule(rule)

Os critérios do formato condicional superior/inferior.

setRule(rule: ConditionalTopBottomRule): void;

Parâmetros

Retornos

void

Exemplos

/**
 * This sample applies conditional formatting to the currently used range in the worksheet. 
 * The conditional formatting is a green fill for the top 10% of values.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Get the used range in the worksheet.
  let range = selectedSheet.getUsedRange();

  // Set the fill color to green for the top 10% of values in the range.
  let conditionalFormat = range.addConditionalFormat(ExcelScript.ConditionalFormatType.topBottom)
  conditionalFormat.getTopBottom().getFormat().getFill().setColor("green");
  conditionalFormat.getTopBottom().setRule({
    rank: 10, // The percentage threshold.
    type: ExcelScript.ConditionalTopBottomCriterionType.topPercent // The type of the top/bottom condition.
  });
}