Excel.ShapeLineFormat class

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

Extends

Hinweise

[ API-Satz: ExcelApi 1.9 ]

Eigenschaften

color

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

context

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

dashStyle

Stellt die Linienart der Form dar. Gibt zurück null , wenn die Zeile nicht sichtbar ist oder inkonsistente Bindestricharten vorhanden sind. Weitere Informationen finden Sie unter Excel.ShapeLineDashStyle .

style

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

transparency

Stellt den Deckungsgrad der angegebenen Linie als Wert von 0,0 (undurchsichtig) bis 1,0 (transparent) dar. Gibt zurück null , wenn das Shape über inkonsistente Transparenzen verfügt.

visible

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

weight

Stellt die Stärke der Linie in Punkt dar. Gibt zurück null , wenn die Zeile nicht sichtbar ist oder inkonsistente Liniengewichtungen 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.

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

Details zur Eigenschaft

color

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

color: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApi 1.9 ]

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

dashStyle

Stellt die Linienart der Form dar. Gibt zurück null , wenn die Zeile nicht sichtbar ist oder inkonsistente Bindestricharten vorhanden sind. Weitere Informationen finden Sie unter Excel.ShapeLineDashStyle .

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

Eigenschaftswert

Excel.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot"

Hinweise

[ API-Satz: ExcelApi 1.9 ]

style

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

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

Eigenschaftswert

Excel.ShapeLineStyle | "Single" | "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin"

Hinweise

[ API-Satz: ExcelApi 1.9 ]

transparency

Stellt den Deckungsgrad der angegebenen Linie als Wert von 0,0 (undurchsichtig) bis 1,0 (transparent) dar. Gibt zurück null , wenn das Shape über inkonsistente Transparenzen verfügt.

transparency: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApi 1.9 ]

visible

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

visible: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.9 ]

weight

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

weight: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApi 1.9 ]

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?: Excel.Interfaces.ShapeLineFormatLoadOptions): Excel.ShapeLineFormat;

Parameter

options
Excel.Interfaces.ShapeLineFormatLoadOptions

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

Parameter

propertyNames

string | string[]

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

Gibt zurück

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

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

Parameter

properties
Excel.Interfaces.ShapeLineFormatUpdateData

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

Parameter

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

toJSON(): Excel.Interfaces.ShapeLineFormatData;

Gibt zurück