ExcelScript.RangeFill interface

Paquet:

ExcelScript

Représente l’arrière-plan d’un objet de plage.

Remarques

Exemples

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

clear()	Réinitialise l’arrière-plan de la plage.
getColor()	Code de couleur HTML représentant la couleur de l’arrière-plan, sous la forme #RRGGBB (par exemple, « FFA500 ») ou sous forme de couleur HTML nommée (par exemple, « orange »)
getPattern()	Modèle d’une plage. Pour plus d’informations, consultez ExcelScript.FillPattern . LinearGradient et RectangularGradient ne sont pas pris en charge. Une null valeur indique que la plage entière n’a pas de paramètre de modèle uniforme.
getPatternColor()	Code de couleur HTML représentant la couleur du modèle de plage, sous la forme #RRGGBB (par exemple, « FFA500 ») ou sous la forme d’une couleur HTML nommée (par exemple, « orange »).
getPatternTintAndShade()	Spécifie un double qui éclaircit ou assombrit une couleur de motif pour le remplissage de plage. La valeur est comprise entre -1 (la plus foncée) et 1 (la plus brillante), avec 0 pour la couleur d’origine. Une null valeur indique que la plage n’a pas de paramètres uniformes patternTintAndShade .
getTintAndShade()	Spécifie un double qui éclaircit ou assombrit une couleur pour le remplissage de plage. La valeur est comprise entre -1 (la plus foncée) et 1 (la plus brillante), avec 0 pour la couleur d’origine. Une null valeur indique que la plage n’a pas de paramètres uniformes tintAndShade .
setColor(color)	Code de couleur HTML représentant la couleur de l’arrière-plan, sous la forme #RRGGBB (par exemple, « FFA500 ») ou sous forme de couleur HTML nommée (par exemple, « orange »)
setPattern(pattern)	Modèle d’une plage. Pour plus d’informations, consultez ExcelScript.FillPattern . LinearGradient et RectangularGradient ne sont pas pris en charge. Une null valeur indique que la plage entière n’a pas de paramètre de modèle uniforme.
setPatternColor(patternColor)	Code de couleur HTML représentant la couleur du modèle de plage, sous la forme #RRGGBB (par exemple, « FFA500 ») ou sous la forme d’une couleur HTML nommée (par exemple, « orange »).
setPatternTintAndShade(patternTintAndShade)	Spécifie un double qui éclaircit ou assombrit une couleur de motif pour le remplissage de plage. La valeur est comprise entre -1 (la plus foncée) et 1 (la plus brillante), avec 0 pour la couleur d’origine. Une null valeur indique que la plage n’a pas de paramètres uniformes patternTintAndShade .
setTintAndShade(tintAndShade)	Spécifie un double qui éclaircit ou assombrit une couleur pour le remplissage de plage. La valeur est comprise entre -1 (la plus foncée) et 1 (la plus brillante), avec 0 pour la couleur d’origine. Une null valeur indique que la plage n’a pas de paramètres uniformes tintAndShade .

Détails de la méthode

clear()

Réinitialise l’arrière-plan de la plage.

clear(): void;

Retours

void

Exemples

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

Code de couleur HTML représentant la couleur de l’arrière-plan, sous la forme #RRGGBB (par exemple, « FFA500 ») ou sous forme de couleur HTML nommée (par exemple, « orange »)

getColor(): string;

Retours

string

getPattern()

Modèle d’une plage. Pour plus d’informations, consultez ExcelScript.FillPattern . LinearGradient et RectangularGradient ne sont pas pris en charge. Une null valeur indique que la plage entière n’a pas de paramètre de modèle uniforme.

getPattern(): FillPattern;

Retours

ExcelScript.FillPattern

getPatternColor()

Code de couleur HTML représentant la couleur du modèle de plage, sous la forme #RRGGBB (par exemple, « FFA500 ») ou sous la forme d’une couleur HTML nommée (par exemple, « orange »).

getPatternColor(): string;

Retours

string

getPatternTintAndShade()

Spécifie un double qui éclaircit ou assombrit une couleur de motif pour le remplissage de plage. La valeur est comprise entre -1 (la plus foncée) et 1 (la plus brillante), avec 0 pour la couleur d’origine. Une null valeur indique que la plage n’a pas de paramètres uniformes patternTintAndShade .

getPatternTintAndShade(): number;

Retours

number

getTintAndShade()

Spécifie un double qui éclaircit ou assombrit une couleur pour le remplissage de plage. La valeur est comprise entre -1 (la plus foncée) et 1 (la plus brillante), avec 0 pour la couleur d’origine. Une null valeur indique que la plage n’a pas de paramètres uniformes tintAndShade .

getTintAndShade(): number;

Retours

number

setColor(color)

Code de couleur HTML représentant la couleur de l’arrière-plan, sous la forme #RRGGBB (par exemple, « FFA500 ») ou sous forme de couleur HTML nommée (par exemple, « orange »)

setColor(color: string): void;

Paramètres

color

string

Retours

void

Exemples

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

Modèle d’une plage. Pour plus d’informations, consultez ExcelScript.FillPattern . LinearGradient et RectangularGradient ne sont pas pris en charge. Une null valeur indique que la plage entière n’a pas de paramètre de modèle uniforme.

setPattern(pattern: FillPattern): void;

Paramètres

pattern

ExcelScript.FillPattern

Retours

void

Exemples

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

Code de couleur HTML représentant la couleur du modèle de plage, sous la forme #RRGGBB (par exemple, « FFA500 ») ou sous la forme d’une couleur HTML nommée (par exemple, « orange »).

setPatternColor(patternColor: string): void;

Paramètres

patternColor

string

Retours

void

setPatternTintAndShade(patternTintAndShade)

Spécifie un double qui éclaircit ou assombrit une couleur de motif pour le remplissage de plage. La valeur est comprise entre -1 (la plus foncée) et 1 (la plus brillante), avec 0 pour la couleur d’origine. Une null valeur indique que la plage n’a pas de paramètres uniformes patternTintAndShade .

setPatternTintAndShade(patternTintAndShade: number): void;

Paramètres

patternTintAndShade

number

Retours

void

setTintAndShade(tintAndShade)

Spécifie un double qui éclaircit ou assombrit une couleur pour le remplissage de plage. La valeur est comprise entre -1 (la plus foncée) et 1 (la plus brillante), avec 0 pour la couleur d’origine. Une null valeur indique que la plage n’a pas de paramètres uniformes tintAndShade .

setTintAndShade(tintAndShade: number): void;

Paramètres

tintAndShade

number

Retours

void