Compartilhar via

ExcelScript.ConditionalRangeFormat interface

Pacote:
ExcelScript

Um objeto de formato que encapsula o tipo de letra, o preenchimento, os limites e outras propriedades do intervalo de formatos condicionais.

Comentários

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. Esta ação cria uma regra sem definições de formato.
getBorders()

Coleção de objetos de limite que se aplicam ao intervalo de formato condicional geral.
getConditionalRangeBorder(index)

Obtém um objeto Border usando o respectivo nome.
getConditionalRangeBorderBottom()

Obtém o limite inferior.
getConditionalRangeBorderLeft()

Obtém o limite esquerdo.
getConditionalRangeBorderRight()

Obtém o limite certo.
getConditionalRangeBorderTop()

Obtém o limite superior.
getFill()

Devolve o objeto de preenchimento definido no intervalo de formato condicional geral.
getFont()

Devolve o objeto de tipo de letra definido no intervalo de formato condicional geral.
getNumberFormat()

Representa o código de formato de número do Excel para o intervalo especificado. Desmarcado se null for transmitido.
setNumberFormat(numberFormat)

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

Detalhes do método

clearFormat()

Remova as propriedades de formato de uma regra de formato condicional. Esta ação cria uma regra sem definições de formato.

clearFormat(): void;

Retornos

void

getBorders()

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

getBorders(): ConditionalRangeBorder[];

Retornos

ExcelScript.ConditionalRangeBorder[]

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. Veja ExcelScript.ConditionalRangeBorderIndex para obter detalhes.

Retornos

ExcelScript.ConditionalRangeBorder

getConditionalRangeBorderBottom()

Obtém o limite inferior.

getConditionalRangeBorderBottom(): ConditionalRangeBorder;

Retornos

ExcelScript.ConditionalRangeBorder

getConditionalRangeBorderLeft()

Obtém o limite esquerdo.

getConditionalRangeBorderLeft(): ConditionalRangeBorder;

Retornos

ExcelScript.ConditionalRangeBorder

getConditionalRangeBorderRight()

Obtém o limite certo.

getConditionalRangeBorderRight(): ConditionalRangeBorder;

Retornos

ExcelScript.ConditionalRangeBorder

getConditionalRangeBorderTop()

Obtém o limite superior.

getConditionalRangeBorderTop(): ConditionalRangeBorder;

Retornos

ExcelScript.ConditionalRangeBorder

getFill()

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

getFill(): ConditionalRangeFill;

Retornos

ExcelScript.ConditionalRangeFill

getFont()

Devolve o objeto de tipo de letra definido no intervalo de formato condicional geral.

getFont(): ConditionalRangeFont;

Retornos

ExcelScript.ConditionalRangeFont

getNumberFormat()

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

getNumberFormat(): string;

Retornos

string

setNumberFormat(numberFormat)

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

setNumberFormat(numberFormat: string): void;

Parâmetros

numberFormat

string

Retornos

void