Excel.Style class
Ein Objekt, das das Format und andere Eigenschaften einer Formatvorlage kapselt.
- Extends
Hinweise
Eigenschaften
| auto |
Gibt an, ob Text automatisch eingerückt wird, wenn die Textausrichtung in einer Zelle auf die gleiche Verteilung festgelegt ist. |
| borders | Eine Auflistung von vier Rahmenobjekten, die den Stil der vier Rahmen darstellen. |
| built |
Gibt an, ob es sich bei der Formatvorlage um eine integrierte Formatvorlage handelt. |
| context | Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| fill | Die Füllung des Stils. |
| font | Ein |
| formula |
Gibt an, ob die Formel ausgeblendet wird, wenn das Arbeitsblatt geschützt ist. |
| horizontal |
Stellt die horizontale Ausrichtung für den Stil dar. Weitere Informationen finden Sie unter |
| include |
Gibt an, ob die Formatvorlage die Eigenschaften automatischer Einzug, horizontale Ausrichtung, vertikale Ausrichtung, Umbruchtext, Einzugsebene und Textausrichtung enthält. |
| include |
Gibt an, ob die Formatvorlage die Eigenschaften Farbe, Farbindex, Linienart und Gewichtungsrahmen enthält. |
| include |
Gibt an, ob die Formatvorlage die Schriftarteigenschaften "Hintergrund", "Fett", "Farbe", "Farbindex", "Schriftschnitt", "Kursiv", "Name", "Größe", "Durchgestrichen", "Tiefgestellt", "Hochgestellt" und "Unterstrichen" enthält. |
| include |
Gibt an, ob die Formatvorlage die Eigenschaft zahlenformat enthält. |
| include |
Gibt an, ob die Formatvorlage die inneren Eigenschaften Farbe, Farbindex, Umkehren, Wenn negativ, Muster, Musterfarbe und Musterfarbindex enthält. |
| include |
Gibt an, ob die Formatvorlage die Eigenschaften ausgeblendeter und gesperrter Schutz enthält. |
| indent |
Eine ganze Zahl zwischen 0 und 250, die die Einzugsebene für die Formatvorlage angibt. |
| locked | Gibt an, ob das Objekt gesperrt ist, wenn das Arbeitsblatt geschützt ist. |
| name | Der Name der Formatvorlage. |
| number |
Der Formatcode des Zahlenformats für die Formatvorlage. |
| number |
Der lokalisierte Formatcode des Zahlenformats für die Formatvorlage. |
| reading |
Die Leserichtung für die Formatvorlage. |
| shrink |
Gibt an, ob der Text automatisch verkleinert wird, um in die verfügbare Spaltenbreite einzupassen. |
| text |
Die Textausrichtung für die Formatvorlage. |
| vertical |
Gibt die vertikale Ausrichtung für die Formatvorlage an. Weitere Informationen finden Sie unter |
| wrap |
Gibt an, ob Excel den Text im -Objekt umschließt. |
Methoden
| delete() | Löscht diese Formatvorlage. |
| 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
autoIndent
Gibt an, ob Text automatisch eingerückt wird, wenn die Textausrichtung in einer Zelle auf die gleiche Verteilung festgelegt ist.
autoIndent: boolean;Eigenschaftswert
boolean
Hinweise
borders
Eine Auflistung von vier Rahmenobjekten, die den Stil der vier Rahmen darstellen.
readonly borders: Excel.RangeBorderCollection;Eigenschaftswert
Hinweise
builtIn
Gibt an, ob es sich bei der Formatvorlage um eine integrierte Formatvorlage handelt.
readonly builtIn: boolean;Eigenschaftswert
boolean
Hinweise
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
fill
Die Füllung des Stils.
readonly fill: Excel.RangeFill;Eigenschaftswert
Hinweise
font
Ein Font -Objekt, das die Schriftart des Stils darstellt.
readonly font: Excel.RangeFont;Eigenschaftswert
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/style.yaml
await Excel.run(async (context) => {
let style = context.workbook.styles.getItem("Normal");
style.font.load("bold, color, italic, name, size");
style.fill.load("color");
await context.sync();
console.log("Bold: " + style.font.bold);
console.log("Font color: " + style.font.color);
console.log("Italic: " + style.font.italic);
console.log("Name: " + style.font.name);
console.log("Size: " + style.font.size);
console.log("Fill color: " + style.fill.color);
});
formulaHidden
Gibt an, ob die Formel ausgeblendet wird, wenn das Arbeitsblatt geschützt ist.
formulaHidden: boolean;Eigenschaftswert
boolean
Hinweise
horizontalAlignment
Stellt die horizontale Ausrichtung für den Stil dar. Weitere Informationen finden Sie unter Excel.HorizontalAlignment .
horizontalAlignment: Excel.HorizontalAlignment | "General" | "Left" | "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | "Distributed";Eigenschaftswert
Excel.HorizontalAlignment | "General" | "Left" | "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | "Distributed"
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/style.yaml
await Excel.run(async (context) => {
let worksheet = context.workbook.worksheets.getItem("Sample");
let range = worksheet.getRange("A1:E1");
// Apply built-in style.
// Styles are in the Home tab ribbon.
range.style = Excel.BuiltInStyle.neutral;
range.format.horizontalAlignment = "Right";
await context.sync();
});
includeAlignment
Gibt an, ob die Formatvorlage die Eigenschaften automatischer Einzug, horizontale Ausrichtung, vertikale Ausrichtung, Umbruchtext, Einzugsebene und Textausrichtung enthält.
includeAlignment: boolean;Eigenschaftswert
boolean
Hinweise
includeBorder
Gibt an, ob die Formatvorlage die Eigenschaften Farbe, Farbindex, Linienart und Gewichtungsrahmen enthält.
includeBorder: boolean;Eigenschaftswert
boolean
Hinweise
includeFont
Gibt an, ob die Formatvorlage die Schriftarteigenschaften "Hintergrund", "Fett", "Farbe", "Farbindex", "Schriftschnitt", "Kursiv", "Name", "Größe", "Durchgestrichen", "Tiefgestellt", "Hochgestellt" und "Unterstrichen" enthält.
includeFont: boolean;Eigenschaftswert
boolean
Hinweise
includeNumber
Gibt an, ob die Formatvorlage die Eigenschaft zahlenformat enthält.
includeNumber: boolean;Eigenschaftswert
boolean
Hinweise
includePatterns
Gibt an, ob die Formatvorlage die inneren Eigenschaften Farbe, Farbindex, Umkehren, Wenn negativ, Muster, Musterfarbe und Musterfarbindex enthält.
includePatterns: boolean;Eigenschaftswert
boolean
Hinweise
includeProtection
Gibt an, ob die Formatvorlage die Eigenschaften ausgeblendeter und gesperrter Schutz enthält.
includeProtection: boolean;Eigenschaftswert
boolean
Hinweise
indentLevel
Eine ganze Zahl zwischen 0 und 250, die die Einzugsebene für die Formatvorlage angibt.
indentLevel: number;Eigenschaftswert
number
Hinweise
locked
Gibt an, ob das Objekt gesperrt ist, wenn das Arbeitsblatt geschützt ist.
locked: boolean;Eigenschaftswert
boolean
Hinweise
name
Der Name der Formatvorlage.
readonly name: string;Eigenschaftswert
string
Hinweise
numberFormat
Der Formatcode des Zahlenformats für die Formatvorlage.
numberFormat: string;Eigenschaftswert
string
Hinweise
numberFormatLocal
Der lokalisierte Formatcode des Zahlenformats für die Formatvorlage.
numberFormatLocal: string;Eigenschaftswert
string
Hinweise
readingOrder
Die Leserichtung für die Formatvorlage.
readingOrder: Excel.ReadingOrder | "Context" | "LeftToRight" | "RightToLeft";Eigenschaftswert
Excel.ReadingOrder | "Context" | "LeftToRight" | "RightToLeft"
Hinweise
shrinkToFit
Gibt an, ob der Text automatisch verkleinert wird, um in die verfügbare Spaltenbreite einzupassen.
shrinkToFit: boolean;Eigenschaftswert
boolean
Hinweise
textOrientation
Die Textausrichtung für die Formatvorlage.
textOrientation: number;Eigenschaftswert
number
Hinweise
verticalAlignment
Gibt die vertikale Ausrichtung für die Formatvorlage an. Weitere Informationen finden Sie unter Excel.VerticalAlignment .
verticalAlignment: Excel.VerticalAlignment | "Top" | "Center" | "Bottom" | "Justify" | "Distributed";Eigenschaftswert
Excel.VerticalAlignment | "Top" | "Center" | "Bottom" | "Justify" | "Distributed"
Hinweise
wrapText
Gibt an, ob Excel den Text im -Objekt umschließt.
wrapText: boolean;Eigenschaftswert
boolean
Hinweise
Details zur Methode
delete()
Löscht diese Formatvorlage.
delete(): void;Gibt zurück
void
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/style.yaml
await Excel.run(async (context) => {
let style = context.workbook.styles.getItem("Diagonal Orientation Style");
// Delete the diagonal orientation style from the style collection.
// Styles are in the Home tab ribbon.
style.delete();
await context.sync();
console.log("Successfully deleted the diagonal orientation style from the Home tab ribbon.");
});
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.StyleLoadOptions): Excel.Style;Parameter
Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.
Gibt zurück
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/style.yaml
await Excel.run(async (context) => {
let style = context.workbook.styles.getItem("Diagonal Orientation Style");
style.load("textOrientation, horizontalAlignment, autoIndent, readingOrder, wrapText, includeProtection, shrinkToFit, locked");
await context.sync();
console.log("Orientation: " + style.textOrientation);
console.log("Horizontal alignment: " + style.horizontalAlignment);
console.log("Add indent: " + style.autoIndent);
console.log("Reading order: " + style.readingOrder);
console.log("Wrap text: " + style.wrapText);
console.log("Include protection: " + style.includeProtection);
console.log("Shrink to fit: " + style.shrinkToFit);
console.log("Style locked: " + style.locked);
});
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.Style;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.Style;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.StyleUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameter
- properties
- Excel.Interfaces.StyleUpdateData
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.Style): void;Parameter
- properties
- Excel.Style
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.Style-Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.StyleData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
toJSON(): Excel.Interfaces.StyleData;Gibt zurück
Office Add-ins
Feedback
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unter https://aka.ms/ContentUserFeedback.
Feedback senden und anzeigen für