PowerPoint.ShapeFill class

  • Referenz
Paket:
powerpoint

Stellt die Füllformatierung eines Formobjekts dar.

Extends
OfficeExtension.ClientObject

Hinweise

[ API-Satz: PowerPointApi 1.4 ]

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 PowerPoint.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.
setSolidColor(color)

Legt die Füllungsformatierung der Form auf einfarbige Füllung fest. Dadurch wird der Fülltyp in geändert Solid.
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 PowerPoint.ShapeFill-Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als PowerPoint.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

PowerPoint.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: PowerPointApi 1.4 ]

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: PowerPointApi 1.4 ]

type

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

readonly type: PowerPoint.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "SlideBackground";

Eigenschaftswert

PowerPoint.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "SlideBackground"

Hinweise

[ API-Satz: PowerPointApi 1.4 ]

Details zur Methode

clear()

Löscht die Füllungsformatierung dieser Form.

clear(): void;

Gibt zurück

void

Hinweise

[ API-Satz: PowerPointApi 1.4 ]

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?: PowerPoint.Interfaces.ShapeFillLoadOptions): PowerPoint.ShapeFill;

Parameter

options
PowerPoint.Interfaces.ShapeFillLoadOptions

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

Gibt zurück

PowerPoint.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[]): PowerPoint.ShapeFill;

Parameter

propertyNames

string | string[]

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

Gibt zurück

PowerPoint.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;
        }): PowerPoint.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

PowerPoint.ShapeFill

setSolidColor(color)

Legt die Füllungsformatierung der Form auf einfarbige Füllung fest. Dadurch wird der Fülltyp in geändert Solid.

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") angibt.

Gibt zurück

void

Hinweise

[ API-Satz: PowerPointApi 1.4 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-set-shapes.yaml

// Changes the selected shapes fill color to red.
await PowerPoint.run(async (context) => {
  const shapes = context.presentation.getSelectedShapes();
  const shapeCount = shapes.getCount();
  shapes.load("items");
  await context.sync();
  shapes.items.map((shape) => {
    shape.fill.setSolidColor("red");
  });
  await context.sync();
});

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

toJSON(): PowerPoint.Interfaces.ShapeFillData;

Gibt zurück

PowerPoint.Interfaces.ShapeFillData