ExcelScript.RangeFill interface

  • Referenz
Paket:
ExcelScript

Stellt den Hintergrund eines Bereichsobjekts dar.

Hinweise

Beispiele

/**
 * 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");
}

Methoden

clear()

Setzt den Hintergrund des Bereichs zurück.
getColor()

HTML-Farbcode, der die Farbe des Hintergrunds in form #RRGGBB (z. B. "FFA500") oder als benannte HTML-Farbe (z. B. "orange") darstellt
getPattern()

Das Muster eines Bereichs. Weitere Informationen finden Sie unter ExcelScript.FillPattern . LinearGradient und RectangularGradient werden nicht unterstützt. Ein null -Wert gibt an, dass der gesamte Bereich keine einheitliche Mustereinstellung aufweist.
getPatternColor()

Der HTML-Farbcode, der die Farbe des Bereichsmusters in form #RRGGBB (z. B. "FFA500") oder als benannte HTML-Farbe (z. B. "orange") darstellt.
getPatternTintAndShade()

Gibt ein Double an, das eine Musterfarbe für die Bereichsfüllung aufhellt oder abdunknet. Der Wert liegt zwischen -1 (dunkelster) und 1 (hellste), mit 0 für die ursprüngliche Farbe. Ein null -Wert gibt an, dass der Bereich keine einheitlichen patternTintAndShade Einstellungen aufweist.
getTintAndShade()

Gibt ein Double an, das eine Farbe für die Bereichsfüllung aufhellt oder abdunknet. Der Wert liegt zwischen -1 (dunkelster) und 1 (hellste), mit 0 für die ursprüngliche Farbe. Ein null -Wert gibt an, dass der Bereich keine einheitlichen tintAndShade Einstellungen aufweist.
setColor(color)

HTML-Farbcode, der die Farbe des Hintergrunds in form #RRGGBB (z. B. "FFA500") oder als benannte HTML-Farbe (z. B. "orange") darstellt
setPattern(pattern)

Das Muster eines Bereichs. Weitere Informationen finden Sie unter ExcelScript.FillPattern . LinearGradient und RectangularGradient werden nicht unterstützt. Ein null -Wert gibt an, dass der gesamte Bereich keine einheitliche Mustereinstellung aufweist.
setPatternColor(patternColor)

Der HTML-Farbcode, der die Farbe des Bereichsmusters in form #RRGGBB (z. B. "FFA500") oder als benannte HTML-Farbe (z. B. "orange") darstellt.
setPatternTintAndShade(patternTintAndShade)

Gibt ein Double an, das eine Musterfarbe für die Bereichsfüllung aufhellt oder abdunknet. Der Wert liegt zwischen -1 (dunkelster) und 1 (hellste), mit 0 für die ursprüngliche Farbe. Ein null -Wert gibt an, dass der Bereich keine einheitlichen patternTintAndShade Einstellungen aufweist.
setTintAndShade(tintAndShade)

Gibt ein Double an, das eine Farbe für die Bereichsfüllung aufhellt oder abdunknet. Der Wert liegt zwischen -1 (dunkelster) und 1 (hellste), mit 0 für die ursprüngliche Farbe. Ein null -Wert gibt an, dass der Bereich keine einheitlichen tintAndShade Einstellungen aufweist.

Details zur Methode

clear()

Setzt den Hintergrund des Bereichs zurück.

clear(): void;

Gibt zurück

void

Beispiele

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

HTML-Farbcode, der die Farbe des Hintergrunds in form #RRGGBB (z. B. "FFA500") oder als benannte HTML-Farbe (z. B. "orange") darstellt

getColor(): string;

Gibt zurück

string

getPattern()

Das Muster eines Bereichs. Weitere Informationen finden Sie unter ExcelScript.FillPattern . LinearGradient und RectangularGradient werden nicht unterstützt. Ein null -Wert gibt an, dass der gesamte Bereich keine einheitliche Mustereinstellung aufweist.

getPattern(): FillPattern;

Gibt zurück

ExcelScript.FillPattern

getPatternColor()

Der HTML-Farbcode, der die Farbe des Bereichsmusters in form #RRGGBB (z. B. "FFA500") oder als benannte HTML-Farbe (z. B. "orange") darstellt.

getPatternColor(): string;

Gibt zurück

string

getPatternTintAndShade()

Gibt ein Double an, das eine Musterfarbe für die Bereichsfüllung aufhellt oder abdunknet. Der Wert liegt zwischen -1 (dunkelster) und 1 (hellste), mit 0 für die ursprüngliche Farbe. Ein null -Wert gibt an, dass der Bereich keine einheitlichen patternTintAndShade Einstellungen aufweist.

getPatternTintAndShade(): number;

Gibt zurück

number

getTintAndShade()

Gibt ein Double an, das eine Farbe für die Bereichsfüllung aufhellt oder abdunknet. Der Wert liegt zwischen -1 (dunkelster) und 1 (hellste), mit 0 für die ursprüngliche Farbe. Ein null -Wert gibt an, dass der Bereich keine einheitlichen tintAndShade Einstellungen aufweist.

getTintAndShade(): number;

Gibt zurück

number

setColor(color)

HTML-Farbcode, der die Farbe des Hintergrunds in form #RRGGBB (z. B. "FFA500") oder als benannte HTML-Farbe (z. B. "orange") darstellt

setColor(color: string): void;

Parameter

color

string

Gibt zurück

void

Beispiele

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

Das Muster eines Bereichs. Weitere Informationen finden Sie unter ExcelScript.FillPattern . LinearGradient und RectangularGradient werden nicht unterstützt. Ein null -Wert gibt an, dass der gesamte Bereich keine einheitliche Mustereinstellung aufweist.

setPattern(pattern: FillPattern): void;

Parameter

pattern
ExcelScript.FillPattern

Gibt zurück

void

Beispiele

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

Der HTML-Farbcode, der die Farbe des Bereichsmusters in form #RRGGBB (z. B. "FFA500") oder als benannte HTML-Farbe (z. B. "orange") darstellt.

setPatternColor(patternColor: string): void;

Parameter

patternColor

string

Gibt zurück

void

setPatternTintAndShade(patternTintAndShade)

Gibt ein Double an, das eine Musterfarbe für die Bereichsfüllung aufhellt oder abdunknet. Der Wert liegt zwischen -1 (dunkelster) und 1 (hellste), mit 0 für die ursprüngliche Farbe. Ein null -Wert gibt an, dass der Bereich keine einheitlichen patternTintAndShade Einstellungen aufweist.

setPatternTintAndShade(patternTintAndShade: number): void;

Parameter

patternTintAndShade

number

Gibt zurück

void

setTintAndShade(tintAndShade)

Gibt ein Double an, das eine Farbe für die Bereichsfüllung aufhellt oder abdunknet. Der Wert liegt zwischen -1 (dunkelster) und 1 (hellste), mit 0 für die ursprüngliche Farbe. Ein null -Wert gibt an, dass der Bereich keine einheitlichen tintAndShade Einstellungen aufweist.

setTintAndShade(tintAndShade: number): void;

Parameter

tintAndShade

number

Gibt zurück

void