ExcelScript.ConditionalRangeFormat interface

Um objeto de formato que encapsula a fonte, o preenchimento, as bordas e outras propriedades do intervalo de formatos condicionais.

Comentários

Usada por

Exemplos

/**
 * 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étodos

clearFormat()

Remova as propriedades de formato de uma regra de formato condicional. Isso cria uma regra sem configurações de formatação.

getBorders()

Coleção de objetos de borda que se aplicam ao intervalo de formato condicional geral.

getConditionalRangeBorder(index)

Obtém um objeto Border usando o respectivo nome.

getConditionalRangeBorderBottom()

Obtém a borda inferior.

getConditionalRangeBorderLeft()

Obtém a borda esquerda.

getConditionalRangeBorderRight()

Obtém a borda certa.

getConditionalRangeBorderTop()

Obtém a borda superior.

getFill()

Retorna o objeto de preenchimento definido no intervalo de formato condicional geral.

getFont()

Retorna o objeto de fonte definido no intervalo de formato condicional geral.

getNumberFormat()

Representa o código de formato de número do Excel para determinado intervalo. Desmarcado se null for passado.

setNumberFormat(numberFormat)

Representa o código de formato de número do Excel para determinado intervalo. Desmarcado se null for passado.

Detalhes do método

clearFormat()

Remova as propriedades de formato de uma regra de formato condicional. Isso cria uma regra sem configurações de formatação.

clearFormat(): void;

Retornos

void

getBorders()

Coleção de objetos de borda que se aplicam ao intervalo de formato condicional geral.

getBorders(): ConditionalRangeBorder[];

Retornos

getConditionalRangeBorder(index)

Obtém um objeto Border usando o respectivo nome.

getConditionalRangeBorder(
            index: ConditionalRangeBorderIndex
        ): ConditionalRangeBorder;

Parâmetros

index
ExcelScript.ConditionalRangeBorderIndex

Valor de índice do objeto Border a ser recuperado. Consulte ExcelScript.ConditionalRangeBorderIndex para obter detalhes.

Retornos

getConditionalRangeBorderBottom()

Obtém a borda inferior.

getConditionalRangeBorderBottom(): ConditionalRangeBorder;

Retornos

getConditionalRangeBorderLeft()

Obtém a borda esquerda.

getConditionalRangeBorderLeft(): ConditionalRangeBorder;

Retornos

getConditionalRangeBorderRight()

Obtém a borda certa.

getConditionalRangeBorderRight(): ConditionalRangeBorder;

Retornos

getConditionalRangeBorderTop()

Obtém a borda superior.

getConditionalRangeBorderTop(): ConditionalRangeBorder;

Retornos

getFill()

Retorna o objeto de preenchimento definido no intervalo de formato condicional geral.

getFill(): ConditionalRangeFill;

Retornos

getFont()

Retorna o objeto de fonte definido no intervalo de formato condicional geral.

getFont(): ConditionalRangeFont;

Retornos

getNumberFormat()

Representa o código de formato de número do Excel para determinado intervalo. Desmarcado se null for passado.

getNumberFormat(): string;

Retornos

string

setNumberFormat(numberFormat)

Representa o código de formato de número do Excel para determinado intervalo. Desmarcado se null for passado.

setNumberFormat(numberFormat: string): void;

Parâmetros

numberFormat

string

Retornos

void