Freigeben über

Excel.Style class

  • Referenz
Paket:
excel

Ein Objekt, das das Format und andere Eigenschaften einer Formatvorlage kapselt.

Extends
OfficeExtension.ClientObject

Hinweise

[ API-Satz: ExcelApi 1.7 ]

Eigenschaften

autoIndent

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.
builtIn

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 Font -Objekt, das die Schriftart des Stils darstellt.
formulaHidden

Gibt an, ob die Formel ausgeblendet wird, wenn das Arbeitsblatt geschützt ist.
horizontalAlignment

Stellt die horizontale Ausrichtung für den Stil dar. Weitere Informationen finden Sie unter Excel.HorizontalAlignment .
includeAlignment

Gibt an, ob die Formatvorlage die Eigenschaften automatischer Einzug, horizontale Ausrichtung, vertikale Ausrichtung, Umbruchtext, Einzugsebene und Textausrichtung umfasst.
includeBorder

Gibt an, ob die Formatvorlage die Eigenschaften Farbe, Farbindex, Linienart und Gewichtungsrahmen enthält.
includeFont

Gibt an, ob die Formatvorlage die Schriftarteigenschaften "Hintergrund", "Fett", "Farbe", "Farbindex", "Schriftschnitt", "Kursiv", "Name", "Größe", "Durchgestrichen", "Tiefgestellt", "Hochgestellt" und "Unterstrichen" enthält.
includeNumber

Gibt an, ob die Formatvorlage die Eigenschaft zahlenformat enthält.
includePatterns

Gibt an, ob die Formatvorlage die inneren Eigenschaften Farbe, Farbindex, Umkehren, Wenn negativ, Muster, Musterfarbe und Musterfarbindex enthält.
includeProtection

Gibt an, ob die Formatvorlage die Eigenschaften ausgeblendeter und gesperrter Schutz enthält.
indentLevel

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.
numberFormat

Der Formatcode des Zahlenformats für die Formatvorlage.
numberFormatLocal

Der lokalisierte Formatcode des Zahlenformats für die Formatvorlage.
readingOrder

Die Leserichtung für die Formatvorlage.
shrinkToFit

Gibt an, ob der Text automatisch verkleinert wird, um in die verfügbare Spaltenbreite einzupassen.
textOrientation

Die Textausrichtung für die Formatvorlage.
verticalAlignment

Gibt die vertikale Ausrichtung für die Formatvorlage an. Weitere Informationen finden Sie unter Excel.VerticalAlignment .
wrapText

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

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

[ API-Satz: ExcelApi 1.8 ]

borders

Eine Auflistung von vier Rahmenobjekten, die den Stil der vier Rahmen darstellen.

readonly borders: Excel.RangeBorderCollection;

Eigenschaftswert

Excel.RangeBorderCollection

Hinweise

[ API-Satz: ExcelApi 1.7 ]

builtIn

Gibt an, ob es sich bei der Formatvorlage um eine integrierte Formatvorlage handelt.

readonly builtIn: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.7 ]

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

Excel.RequestContext

fill

Die Füllung des Stils.

readonly fill: Excel.RangeFill;

Eigenschaftswert

Excel.RangeFill

Hinweise

[ API-Satz: ExcelApi 1.7 ]

font

Ein Font -Objekt, das die Schriftart des Stils darstellt.

readonly font: Excel.RangeFont;

Eigenschaftswert

Excel.RangeFont

Hinweise

[ API-Satz: ExcelApi 1.7 ]

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

[ API-Satz: ExcelApi 1.7 ]

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

[ API-Satz: ExcelApi 1.7 ]

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 umfasst.

includeAlignment: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.7 ]

includeBorder

Gibt an, ob die Formatvorlage die Eigenschaften Farbe, Farbindex, Linienart und Gewichtungsrahmen enthält.

includeBorder: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.7 ]

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

[ API-Satz: ExcelApi 1.7 ]

includeNumber

Gibt an, ob die Formatvorlage die Eigenschaft zahlenformat enthält.

includeNumber: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.7 ]

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

[ API-Satz: ExcelApi 1.7 ]

includeProtection

Gibt an, ob die Formatvorlage die Eigenschaften ausgeblendeter und gesperrter Schutz enthält.

includeProtection: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.7 ]

indentLevel

Eine ganze Zahl zwischen 0 und 250, die die Einzugsebene für die Formatvorlage angibt.

indentLevel: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApi 1.7 ]

locked

Gibt an, ob das Objekt gesperrt ist, wenn das Arbeitsblatt geschützt ist.

locked: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.7 ]

name

Der Name der Formatvorlage.

readonly name: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApi 1.7 ]

numberFormat

Der Formatcode des Zahlenformats für die Formatvorlage.

numberFormat: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApi 1.7 ]

numberFormatLocal

Der lokalisierte Formatcode des Zahlenformats für die Formatvorlage.

numberFormatLocal: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApi 1.7 ]

readingOrder

Die Leserichtung für die Formatvorlage.

readingOrder: Excel.ReadingOrder | "Context" | "LeftToRight" | "RightToLeft";

Eigenschaftswert

Excel.ReadingOrder | "Context" | "LeftToRight" | "RightToLeft"

Hinweise

[ API-Satz: ExcelApi 1.7 ]

shrinkToFit

Gibt an, ob der Text automatisch verkleinert wird, um in die verfügbare Spaltenbreite einzupassen.

shrinkToFit: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.7 ]

textOrientation

Die Textausrichtung für die Formatvorlage.

textOrientation: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApi 1.8 ]

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

[ API-Satz: ExcelApi 1.7 ]

wrapText

Gibt an, ob Excel den Text im -Objekt umschließt.

wrapText: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.7 ]

Details zur Methode

delete()

Löscht diese Formatvorlage.

delete(): void;

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApi 1.7 ]

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

options
Excel.Interfaces.StyleLoadOptions

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

Gibt zurück

Excel.Style

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

Excel.Style

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

Excel.Style

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

Excel.Interfaces.StyleData