Excel.ShapeFill class

Paket:

excel

Stellt die Füllformatierung eines Formobjekts dar.

Extends

OfficeExtension.ClientObject

Hinweise

[ API-Satz: ExcelApi 1.9 ]

Eigenschaften

context	Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
foregroundColor	Stellt die Vordergrundfarbe der Formfüllung im HTML-Farbformat, im Formular #RRGGBB (z. B. "FFA500") oder als benannte HTML-Farbe (z. B. "orange") dar.
transparency	Gibt den Transparenzprozentsatz der Füllung als Wert von 0,0 (undurchsichtig) bis 1,0 (klar) an. Gibt zurück null , wenn der Formtyp keine Transparenz unterstützt oder die Formfüllung eine inkonsistente Transparenz aufweist, z. B. mit einem Farbverlaufsfülltyp.
type	Gibt den Füllungstyp der Form zurück. Weitere Informationen finden Sie unter Excel.ShapeFillType .

Methoden

clear()	Löscht die Füllungsformatierung dieser Form.
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.
setSolidColor(color)	Legt die Füllungsformatierung der Form auf einfarbige Füllung fest. Dadurch wird der Füllungstyp in "Einfarbig" geändert.
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.ShapeFill-Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.ShapeFillData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

Details zur Eigenschaft

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

Excel.RequestContext

foregroundColor

Stellt die Vordergrundfarbe der Formfüllung im HTML-Farbformat, im Formular #RRGGBB (z. B. "FFA500") oder als benannte HTML-Farbe (z. B. "orange") dar.

foregroundColor: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApi 1.9 ]

transparency

Gibt den Transparenzprozentsatz der Füllung als Wert von 0,0 (undurchsichtig) bis 1,0 (klar) an. Gibt zurück null , wenn der Formtyp keine Transparenz unterstützt oder die Formfüllung eine inkonsistente Transparenz aufweist, z. B. mit einem Farbverlaufsfülltyp.

transparency: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApi 1.9 ]

type

Gibt den Füllungstyp der Form zurück. Weitere Informationen finden Sie unter Excel.ShapeFillType .

readonly type: Excel.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "Mixed";

Eigenschaftswert

Excel.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "Mixed"

Hinweise

[ API-Satz: ExcelApi 1.9 ]

Details zur Methode

clear()

Löscht die Füllungsformatierung dieser Form.

clear(): void;

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApi 1.9 ]

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.ShapeFillLoadOptions): Excel.ShapeFill;

Parameter

options

Excel.Interfaces.ShapeFillLoadOptions

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

Gibt zurück

Excel.ShapeFill

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.ShapeFill;

Parameter

propertyNames

string | string[]

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

Gibt zurück

Excel.ShapeFill

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.ShapeFill;

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

Excel.ShapeFill

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.ShapeFillUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameter

properties

Excel.Interfaces.ShapeFillUpdateData

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.ShapeFill): void;

Parameter

properties

Excel.ShapeFill

Gibt zurück

void

setSolidColor(color)

Legt die Füllungsformatierung der Form auf einfarbige Füllung fest. Dadurch wird der Füllungstyp in "Einfarbig" geändert.

setSolidColor(color: string): void;

Parameter

color

string

Eine Zeichenfolge, die die Füllfarbe im HTML-Farbformat, im Format #RRGGBB (z. B. "FFA500") oder als benannte HTML-Farbe (z. B. "orange") darstellt.

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApi 1.9 ]

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.ShapeFill-Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.ShapeFillData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

toJSON(): Excel.Interfaces.ShapeFillData;

Gibt zurück

Excel.Interfaces.ShapeFillData