Excel.ShapeLineFormat class
Stellt die Linienformatierung für das Formobjekt dar. Bei Bildern und geometrischen Formen stellt die Linienformatierung den Rahmen der Form dar.
- Extends
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. |
| dash |
Stellt die Linienart der Form dar. Gibt zurück |
| style | Stellt die Linienart der Form dar. Gibt zurück |
| transparency | Stellt den Deckungsgrad der angegebenen Linie als Wert von 0,0 (undurchsichtig) bis 1,0 (transparent) dar. Gibt zurück |
| visible | Gibt an, ob die Linienformatierung eines Formelements sichtbar ist. Gibt zurück |
| weight | Stellt die Stärke der Linie in Punkt dar. Gibt zurück |
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 " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| 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 |
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
context
Der dem Objekt zugeordnete Anforderungskontext. 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 Linie nicht sichtbar ist oder inkonsistente Stricharten vorhanden sind. Weitere Informationen findest du hier 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
style
Stellt die Linienart der Form dar. Gibt zurück null , wenn die Linie nicht sichtbar ist oder inkonsistente Formatvorlagen vorhanden sind. Weitere Informationen findest du hier Excel.ShapeLineStyle .
style: Excel.ShapeLineStyle | "Single" | "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin";Eigenschaftswert
Excel.ShapeLineStyle | "Single" | "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin"
Hinweise
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 inkonsistente Transparenzen aufweist.
transparency: number;Eigenschaftswert
number
Hinweise
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
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-fill-and-line-formatting.yaml
await Excel.run(async (context) => {
// Hide the shape's outline.
const sheet = context.workbook.worksheets.getItem("Sample");
const badge = sheet.shapes.getItem("Badge");
const lineFormat: Excel.ShapeLineFormat = badge.lineFormat;
lineFormat.visible = false;
await context.sync();
});
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
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
Stellt Optionen für die zu ladenden Eigenschaften des Objekts bereit.
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 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
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
Bietet eine Option zum Unterdrücken von Fehlern, wenn das properties-Objekt 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
- properties
- Excel.ShapeLineFormat
Gibt zurück
void
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-fill-and-line-formatting.yaml
await Excel.run(async (context) => {
// Apply outline formatting to the shape.
const sheet = context.workbook.worksheets.getItem("Sample");
const badge = sheet.shapes.getItem("Badge");
const lineFormat: Excel.ShapeLineFormat = badge.lineFormat;
lineFormat.set({
color: "#C55A11",
dashStyle: Excel.ShapeLineDashStyle.dashDotDot,
style: Excel.ShapeLineStyle.thinThick,
transparency: 0.2,
visible: true,
weight: 4
});
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 sie übergeben wird.) Während das ursprüngliche Excel.ShapeLineFormat Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Excel.Interfaces.ShapeLineFormatData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.
toJSON(): Excel.Interfaces.ShapeLineFormatData;