Compartilhar via

ExcelScript.RangeFill interface

  • Referência
Pacote:
ExcelScript

Representa a tela de fundo de um objeto Range.

Comentários

Exemplos

/**
 * This script sets the fill color of the used range to green.
 */
function main(workbook: ExcelScript.Workbook)
{
  // Get the used range of the current worksheet.
  let currentSheet = workbook.getActiveWorksheet();
  let usedRange = currentSheet.getUsedRange();

  // Get the RangeFill object.
  let fill = usedRange.getFormat().getFill();

  // Set the fill color to green.
  fill.setColor("green");
}

Métodos

clear()

Redefine a tela de fundo do intervalo.
getColor()

Código de cores HTML que representa a cor do fundo, no formulário #RRGGBB (por exemplo, "FFA500" ou como uma cor HTML nomeada (por exemplo, "laranja")
getPattern()

O padrão de um intervalo. Veja ExcelScript.FillPattern para obter detalhes. LinearGradient e RectangularGradient não são compatíveis. Um null valor indica que todo o intervalo não tem uma definição de padrão uniforme.
getPatternColor()

O código de cores HTML que representa a cor do padrão de intervalo, na forma #RRGGBB (por exemplo, "FFA500") ou como uma cor HTML nomeada (por exemplo, "laranja").
getPatternTintAndShade()

Especifica um duplo que ilumina ou escurece uma cor de padrão para o preenchimento do intervalo. O valor é entre -1 (mais escuro) e 1 (mais brilhante), com 0 para a cor original. Um null valor indica que o intervalo não tem definições uniformes patternTintAndShade .
getTintAndShade()

Especifica um duplo que ilumina ou escurece uma cor para o preenchimento do intervalo. O valor é entre -1 (mais escuro) e 1 (mais brilhante), com 0 para a cor original. Um null valor indica que o intervalo não tem definições uniformes tintAndShade .
setColor(color)

Código de cores HTML que representa a cor do fundo, no formulário #RRGGBB (por exemplo, "FFA500" ou como uma cor HTML nomeada (por exemplo, "laranja")
setPattern(pattern)

O padrão de um intervalo. Veja ExcelScript.FillPattern para obter detalhes. LinearGradient e RectangularGradient não são compatíveis. Um null valor indica que todo o intervalo não tem uma definição de padrão uniforme.
setPatternColor(patternColor)

O código de cores HTML que representa a cor do padrão de intervalo, na forma #RRGGBB (por exemplo, "FFA500") ou como uma cor HTML nomeada (por exemplo, "laranja").
setPatternTintAndShade(patternTintAndShade)

Especifica um duplo que ilumina ou escurece uma cor de padrão para o preenchimento do intervalo. O valor é entre -1 (mais escuro) e 1 (mais brilhante), com 0 para a cor original. Um null valor indica que o intervalo não tem definições uniformes patternTintAndShade .
setTintAndShade(tintAndShade)

Especifica um duplo que ilumina ou escurece uma cor para o preenchimento do intervalo. O valor é entre -1 (mais escuro) e 1 (mais brilhante), com 0 para a cor original. Um null valor indica que o intervalo não tem definições uniformes tintAndShade .

Detalhes do método

clear()

Redefine a tela de fundo do intervalo.

clear(): void;

Retornos

void

Exemplos

/**
 * This script removes all fill color and styles from the used range.
 */
function main(workbook: ExcelScript.Workbook)
{
  // Get the used range of the current worksheet.
  let currentSheet = workbook.getActiveWorksheet();
  let usedRange = currentSheet.getUsedRange();

  // Clear the fill from the entire range.
  usedRange.getFormat().getFill().clear();
}

getColor()

Código de cores HTML que representa a cor do fundo, no formulário #RRGGBB (por exemplo, "FFA500" ou como uma cor HTML nomeada (por exemplo, "laranja")

getColor(): string;

Retornos

string

getPattern()

O padrão de um intervalo. Veja ExcelScript.FillPattern para obter detalhes. LinearGradient e RectangularGradient não são compatíveis. Um null valor indica que todo o intervalo não tem uma definição de padrão uniforme.

getPattern(): FillPattern;

Retornos

ExcelScript.FillPattern

getPatternColor()

O código de cores HTML que representa a cor do padrão de intervalo, na forma #RRGGBB (por exemplo, "FFA500") ou como uma cor HTML nomeada (por exemplo, "laranja").

getPatternColor(): string;

Retornos

string

getPatternTintAndShade()

Especifica um duplo que ilumina ou escurece uma cor de padrão para o preenchimento do intervalo. O valor é entre -1 (mais escuro) e 1 (mais brilhante), com 0 para a cor original. Um null valor indica que o intervalo não tem definições uniformes patternTintAndShade .

getPatternTintAndShade(): number;

Retornos

number

getTintAndShade()

Especifica um duplo que ilumina ou escurece uma cor para o preenchimento do intervalo. O valor é entre -1 (mais escuro) e 1 (mais brilhante), com 0 para a cor original. Um null valor indica que o intervalo não tem definições uniformes tintAndShade .

getTintAndShade(): number;

Retornos

number

setColor(color)

Código de cores HTML que representa a cor do fundo, no formulário #RRGGBB (por exemplo, "FFA500" ou como uma cor HTML nomeada (por exemplo, "laranja")

setColor(color: string): void;

Parâmetros

color

string

Retornos

void

Exemplos

/**
 * This script sets the fill color of cell A2 to blue.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the range representing cell A2 from the current worksheet.
  let cell = workbook.getActiveWorksheet().getRange("A2");

  // Set the fill color to blue.
  cell.getFormat().getFill().setColor("blue");
}

setPattern(pattern)

O padrão de um intervalo. Veja ExcelScript.FillPattern para obter detalhes. LinearGradient e RectangularGradient não são compatíveis. Um null valor indica que todo o intervalo não tem uma definição de padrão uniforme.

setPattern(pattern: FillPattern): void;

Parâmetros

pattern
ExcelScript.FillPattern

Retornos

void

Exemplos

/**
 * This script sets a black-checkered fill on the selected range.
 */
function main(workbook: ExcelScript.Workbook) {
  const selected = workbook.getSelectedRange();
  selected.getFormat().getFill().setPattern(ExcelScript.FillPattern.checker);
  selected.getFormat().getFill().setPatternColor("black");
}

setPatternColor(patternColor)

O código de cores HTML que representa a cor do padrão de intervalo, na forma #RRGGBB (por exemplo, "FFA500") ou como uma cor HTML nomeada (por exemplo, "laranja").

setPatternColor(patternColor: string): void;

Parâmetros

patternColor

string

Retornos

void

setPatternTintAndShade(patternTintAndShade)

Especifica um duplo que ilumina ou escurece uma cor de padrão para o preenchimento do intervalo. O valor é entre -1 (mais escuro) e 1 (mais brilhante), com 0 para a cor original. Um null valor indica que o intervalo não tem definições uniformes patternTintAndShade .

setPatternTintAndShade(patternTintAndShade: number): void;

Parâmetros

patternTintAndShade

number

Retornos

void

setTintAndShade(tintAndShade)

Especifica um duplo que ilumina ou escurece uma cor para o preenchimento do intervalo. O valor é entre -1 (mais escuro) e 1 (mais brilhante), com 0 para a cor original. Um null valor indica que o intervalo não tem definições uniformes tintAndShade .

setTintAndShade(tintAndShade: number): void;

Parâmetros

tintAndShade

number

Retornos

void