PowerPoint.ShapeLineFormat class

Paket:: powerpoint

Stellt die Linienformatierung für das Formobjekt dar. Bei Bildern und geometrischen Formen stellt die Linienformatierung den Rahmen der Form dar.

Extends: OfficeExtension.ClientObject

Hinweise

API-Satz: PowerPointApi 1.4

Verwendet von

PowerPoint.Shape: lineFormat

Beispiele

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

// Changes the dash style of every line in the slide.
await PowerPoint.run(async (context) => {
  // Get the type of shape for every shape in the collection.
  const shapes: PowerPoint.ShapeCollection = context.presentation.slides.getItemAt(0).shapes;
  shapes.load("type");
  await context.sync();

  // Change the dash style for shapes of the type `line`.
  shapes.items.forEach((shape) => {
    if (shape.type === PowerPoint.ShapeType.line) {
      shape.lineFormat.style = PowerPoint.ShapeLineStyle.thickThin;
      shape.lineFormat.dashStyle = PowerPoint.ShapeLineDashStyle.dashDot;
    }
  });
  await context.sync();
});

Eigenschaften

color	Stellt die Linienfarbe im HTML-Farbformat im Format #RRGGBB (z. B. "FFA500") oder als benannte HTML-Farbe (z. B. "orange") dar.
context	Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
dashStyle	Stellt die Strichart der Linie dar. Gibt Null zurück, wenn die Linie nicht sichtbar ist oder wenn inkonsistente Stricharten vorhanden sind. Weitere Informationen finden Sie unter PowerPoint.ShapeLineDashStyle .
style	Stellt die Linienart der Form dar. Gibt Null zurück, wenn die Linie nicht sichtbar ist oder inkonsistente Formatvorlagen vorhanden sind. Weitere Informationen finden Sie unter PowerPoint.ShapeLineStyle .
transparency	Gibt den Transparenzprozentsatz der Linie als Wert zwischen 0,0 (undurchsichtig) und 1,0 (klar) an. Gibt NULL zurück, wenn die Form inkonsistente Transparenz aufweist.
visible	Gibt an, ob die Linienformatierung eines Formelements sichtbar ist. Gibt zurück `null` , wenn das Shape inkonsistente Sichtbarkeiten aufweist.
weight	Stellt die Stärke der Linie in Punkt dar. Gibt zurück `null` , wenn die Linie nicht sichtbar ist oder inkonsistente Linienstärken vorhanden sind.

Methoden

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.
toJSON()	Überschreibt die JavaScript-Methode `toJSON()` , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an `JSON.stringify()`übergeben wird. (`JSON.stringify`ruft wiederum die `toJSON` Methode des Objekts auf, das an sie übergeben wird.) Während das ursprüngliche `PowerPoint.ShapeLineFormat` Objekt ein API-Objekt ist, gibt die `toJSON` Methode ein einfaches JavaScript-Objekt (als `PowerPoint.Interfaces.ShapeLineFormatData`) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.

Details zur Eigenschaft

color

Stellt die Linienfarbe im HTML-Farbformat im Format #RRGGBB (z. B. "FFA500") oder als benannte HTML-Farbe (z. B. "orange") dar.

color: string;

Eigenschaftswert

string

Hinweise

API-Satz: PowerPointApi 1.4

context

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

context: RequestContext;

Eigenschaftswert

PowerPoint.RequestContext

dashStyle

Stellt die Strichart der Linie dar. Gibt Null zurück, wenn die Linie nicht sichtbar ist oder wenn inkonsistente Stricharten vorhanden sind. Weitere Informationen finden Sie unter PowerPoint.ShapeLineDashStyle .

dashStyle: PowerPoint.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot";

Eigenschaftswert

Hinweise

API-Satz: PowerPointApi 1.4

Beispiele

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

// Changes the dash style of every line in the slide.
await PowerPoint.run(async (context) => {
  // Get the type of shape for every shape in the collection.
  const shapes: PowerPoint.ShapeCollection = context.presentation.slides.getItemAt(0).shapes;
  shapes.load("type");
  await context.sync();

  // Change the dash style for shapes of the type `line`.
  shapes.items.forEach((shape) => {
    if (shape.type === PowerPoint.ShapeType.line) {
      shape.lineFormat.style = PowerPoint.ShapeLineStyle.thickThin;
      shape.lineFormat.dashStyle = PowerPoint.ShapeLineDashStyle.dashDot;
    }
  });
  await context.sync();
});

style

Stellt die Linienart der Form dar. Gibt Null zurück, wenn die Linie nicht sichtbar ist oder inkonsistente Formatvorlagen vorhanden sind. Weitere Informationen finden Sie unter PowerPoint.ShapeLineStyle .

style: PowerPoint.ShapeLineStyle | "Single" | "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin";

Eigenschaftswert

Hinweise

API-Satz: PowerPointApi 1.4

transparency

Gibt den Transparenzprozentsatz der Linie als Wert zwischen 0,0 (undurchsichtig) und 1,0 (klar) an. Gibt NULL zurück, wenn die Form inkonsistente Transparenz aufweist.

transparency: number;

Eigenschaftswert

number

Hinweise

API-Satz: PowerPointApi 1.4

visible

Gibt an, ob die Linienformatierung eines Formelements sichtbar ist. Gibt zurück null , wenn das Shape inkonsistente Sichtbarkeiten aufweist.

visible: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: PowerPointApi 1.4

weight

Stellt die Stärke der Linie in Punkt dar. Gibt zurück null , wenn die Linie nicht sichtbar ist oder inkonsistente Linienstärken vorhanden sind.

weight: number;

Eigenschaftswert

number

Hinweise

API-Satz: PowerPointApi 1.4

Details zur Methode

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

Parameter

options: PowerPoint.Interfaces.ShapeLineFormatLoadOptions

Stellt Optionen für die zu ladenden Eigenschaften des Objekts bereit.

Gibt zurück

PowerPoint.ShapeLineFormat

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

Parameter

propertyNames: string | string[]

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

Gibt zurück

PowerPoint.ShapeLineFormat

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

Parameter

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

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

Gibt zurück

PowerPoint.ShapeLineFormat

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 sie übergeben wird.) Während das ursprüngliche PowerPoint.ShapeLineFormat Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als PowerPoint.Interfaces.ShapeLineFormatData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.

toJSON(): PowerPoint.Interfaces.ShapeLineFormatData;

Gibt zurück

PowerPoint.Interfaces.ShapeLineFormatData

Feedback

War diese Seite hilfreich?