Excel.RangeFill class

Stellt den Hintergrund eines Bereichsobjekts dar.

Extends

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Eigenschaften

color

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

context

Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

pattern

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

patternColor

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

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.

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.

Methoden

clear()

Setzt den Hintergrund des Bereichs zurück.

load(options)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNames)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNamesAndPaths)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

set(properties, options)

Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.

set(properties)

Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.

toJSON()

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Excel.RangeFill-Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.RangeFillData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

Details zur Eigenschaft

color

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

color: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApi 1.1 ]

context

Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

pattern

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

pattern: Excel.FillPattern | "None" | "Solid" | "Gray50" | "Gray75" | "Gray25" | "Horizontal" | "Vertical" | "Down" | "Up" | "Checker" | "SemiGray75" | "LightHorizontal" | "LightVertical" | "LightDown" | "LightUp" | "Grid" | "CrissCross" | "Gray16" | "Gray8" | "LinearGradient" | "RectangularGradient";

Eigenschaftswert

Excel.FillPattern | "None" | "Solid" | "Gray50" | "Gray75" | "Gray25" | "Horizontal" | "Vertical" | "Down" | "Up" | "Checker" | "SemiGray75" | "LightHorizontal" | "LightVertical" | "LightDown" | "LightUp" | "Grid" | "CrissCross" | "Gray16" | "Gray8" | "LinearGradient" | "RectangularGradient"

Hinweise

[ API-Satz: ExcelApi 1.9 ]

patternColor

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

patternColor: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApi 1.9 ]

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.

patternTintAndShade: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApi 1.9 ]

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.

tintAndShade: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApi 1.9 ]

Details zur Methode

clear()

Setzt den Hintergrund des Bereichs zurück.

clear(): void;

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Beispiele

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "F:G";
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const range = worksheet.getRange(rangeAddress);
    const rangeFill = range.format.fill;
    rangeFill.clear();
    await context.sync(); 
});

load(options)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(options?: Excel.Interfaces.RangeFillLoadOptions): Excel.RangeFill;

Parameter

options
Excel.Interfaces.RangeFillLoadOptions

Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.

Gibt zurück

load(propertyNames)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNames?: string | string[]): Excel.RangeFill;

Parameter

propertyNames

string | string[]

Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.

Gibt zurück

Beispiele

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "F:G";
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const range = worksheet.getRange(rangeAddress);
    const rangeFill = range.format.fill;
    rangeFill.load('color');
    await context.sync();
    console.log(rangeFill.color);
});

load(propertyNamesAndPaths)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.RangeFill;

Parameter

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select ist eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.

Gibt zurück

set(properties, options)

Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.

set(properties: Interfaces.RangeFillUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameter

properties
Excel.Interfaces.RangeFillUpdateData

Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.

options
OfficeExtension.UpdateOptions

Stellt eine Option zum Unterdrücken von Fehlern bereit, wenn das Eigenschaftenobjekt versucht, schreibgeschützte Eigenschaften festzulegen.

Gibt zurück

void

set(properties)

Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.

set(properties: Excel.RangeFill): void;

Parameter

properties
Excel.RangeFill

Gibt zurück

void

toJSON()

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Excel.RangeFill-Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.RangeFillData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

toJSON(): Excel.Interfaces.RangeFillData;

Gibt zurück