ExcelScript.RangeFill interface

Paquete:

ExcelScript

Representa el fondo de un objeto de intervalo.

Comentarios

Ejemplos

/**
 * 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()	Restablece el fondo del intervalo.
getColor()	Código de color HTML que representa el color del fondo, con el formato #RRGGBB (por ejemplo, "FFA500") o como un color HTML con nombre (por ejemplo, "naranja")
getPattern()	Patrón de un intervalo. Vea ExcelScript.FillPattern para más información. LinearGradient y RectangularGradient no son compatibles. Un null valor indica que todo el intervalo no tiene una configuración de patrón uniforme.
getPatternColor()	Código de color HTML que representa el color del patrón de intervalo, en el formulario #RRGGBB (por ejemplo, "FFA500"), o como un color HTML con nombre (por ejemplo, "naranja").
getPatternTintAndShade()	Especifica un doble que aclara u oscurece un color de patrón para el relleno del intervalo. El valor está entre -1 (más oscuro) y 1 (más brillante), con 0 para el color original. Un null valor indica que el intervalo no tiene una configuración uniforme patternTintAndShade .
getTintAndShade()	Especifica un doble que aclara u oscurece un color para el relleno del intervalo. El valor está entre -1 (más oscuro) y 1 (más brillante), con 0 para el color original. Un null valor indica que el intervalo no tiene una configuración uniforme tintAndShade .
setColor(color)	Código de color HTML que representa el color del fondo, con el formato #RRGGBB (por ejemplo, "FFA500") o como un color HTML con nombre (por ejemplo, "naranja")
setPattern(pattern)	Patrón de un intervalo. Vea ExcelScript.FillPattern para más información. LinearGradient y RectangularGradient no son compatibles. Un null valor indica que todo el intervalo no tiene una configuración de patrón uniforme.
setPatternColor(patternColor)	Código de color HTML que representa el color del patrón de intervalo, en el formulario #RRGGBB (por ejemplo, "FFA500"), o como un color HTML con nombre (por ejemplo, "naranja").
setPatternTintAndShade(patternTintAndShade)	Especifica un doble que aclara u oscurece un color de patrón para el relleno del intervalo. El valor está entre -1 (más oscuro) y 1 (más brillante), con 0 para el color original. Un null valor indica que el intervalo no tiene una configuración uniforme patternTintAndShade .
setTintAndShade(tintAndShade)	Especifica un doble que aclara u oscurece un color para el relleno del intervalo. El valor está entre -1 (más oscuro) y 1 (más brillante), con 0 para el color original. Un null valor indica que el intervalo no tiene una configuración uniforme tintAndShade .

Detalles del método

clear()

Restablece el fondo del intervalo.

clear(): void;

Devoluciones

void

Ejemplos

/**
 * 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 color HTML que representa el color del fondo, con el formato #RRGGBB (por ejemplo, "FFA500") o como un color HTML con nombre (por ejemplo, "naranja")

getColor(): string;

Devoluciones

string

getPattern()

Patrón de un intervalo. Vea ExcelScript.FillPattern para más información. LinearGradient y RectangularGradient no son compatibles. Un null valor indica que todo el intervalo no tiene una configuración de patrón uniforme.

getPattern(): FillPattern;

Devoluciones

ExcelScript.FillPattern

getPatternColor()

Código de color HTML que representa el color del patrón de intervalo, en el formulario #RRGGBB (por ejemplo, "FFA500"), o como un color HTML con nombre (por ejemplo, "naranja").

getPatternColor(): string;

Devoluciones

string

getPatternTintAndShade()

Especifica un doble que aclara u oscurece un color de patrón para el relleno del intervalo. El valor está entre -1 (más oscuro) y 1 (más brillante), con 0 para el color original. Un null valor indica que el intervalo no tiene una configuración uniforme patternTintAndShade .

getPatternTintAndShade(): number;

Devoluciones

number

getTintAndShade()

Especifica un doble que aclara u oscurece un color para el relleno del intervalo. El valor está entre -1 (más oscuro) y 1 (más brillante), con 0 para el color original. Un null valor indica que el intervalo no tiene una configuración uniforme tintAndShade .

getTintAndShade(): number;

Devoluciones

number

setColor(color)

Código de color HTML que representa el color del fondo, con el formato #RRGGBB (por ejemplo, "FFA500") o como un color HTML con nombre (por ejemplo, "naranja")

setColor(color: string): void;

Parámetros

color

string

Devoluciones

void

Ejemplos

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

Patrón de un intervalo. Vea ExcelScript.FillPattern para más información. LinearGradient y RectangularGradient no son compatibles. Un null valor indica que todo el intervalo no tiene una configuración de patrón uniforme.

setPattern(pattern: FillPattern): void;

Parámetros

pattern

ExcelScript.FillPattern

Devoluciones

void

Ejemplos

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

Código de color HTML que representa el color del patrón de intervalo, en el formulario #RRGGBB (por ejemplo, "FFA500"), o como un color HTML con nombre (por ejemplo, "naranja").

setPatternColor(patternColor: string): void;

Parámetros

patternColor

string

Devoluciones

void

setPatternTintAndShade(patternTintAndShade)

Especifica un doble que aclara u oscurece un color de patrón para el relleno del intervalo. El valor está entre -1 (más oscuro) y 1 (más brillante), con 0 para el color original. Un null valor indica que el intervalo no tiene una configuración uniforme patternTintAndShade .

setPatternTintAndShade(patternTintAndShade: number): void;

Parámetros

patternTintAndShade

number

Devoluciones

void

setTintAndShade(tintAndShade)

Especifica un doble que aclara u oscurece un color para el relleno del intervalo. El valor está entre -1 (más oscuro) y 1 (más brillante), con 0 para el color original. Un null valor indica que el intervalo no tiene una configuración uniforme tintAndShade .

setTintAndShade(tintAndShade: number): void;

Parámetros

tintAndShade

number

Devoluciones

void