Excel.Style class

Gibt an, ob Text automatisch eingerückt wird, wenn die Textausrichtung in einer Zelle auf die gleiche Verteilung festgelegt ist.

autoIndent: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.8 ]

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

readonly borders: Excel.RangeBorderCollection;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.7 ]

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

readonly builtIn: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.7 ]

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

context: RequestContext;

Eigenschaftswert

Die Füllung des Stils.

readonly fill: Excel.RangeFill;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.7 ]

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

readonly font: Excel.RangeFont;

Eigenschaftswert

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);
});

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

formulaHidden: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.7 ]

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

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();
});

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

includeAlignment: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.7 ]

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

includeBorder: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.7 ]

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

Hinweise

[ API-Satz: ExcelApi 1.7 ]

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

includeNumber: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.7 ]

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

includePatterns: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.7 ]

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

includeProtection: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.7 ]

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

indentLevel: number;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.7 ]

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

locked: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.7 ]

Der Name der Formatvorlage.

readonly name: string;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.7 ]

Der Formatcode des Zahlenformats für die Formatvorlage.

numberFormat: string;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.7 ]

Der lokalisierte Formatcode des Zahlenformats für die Formatvorlage.

numberFormatLocal: string;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.7 ]

Die Leserichtung für die Formatvorlage.

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

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.7 ]

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

shrinkToFit: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.7 ]

Die Textausrichtung für die Formatvorlage.

textOrientation: number;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.8 ]

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

Hinweise

[ API-Satz: ExcelApi 1.7 ]

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

wrapText: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.7 ]

Löscht diese Formatvorlage.

delete(): void;

Gibt zurück

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.");
});

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

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);
});

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

Gibt zurück

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

Gibt zurück

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

Gibt zurück

Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.

set(properties: Excel.Style): void;

Parameter

Gibt zurück

Ü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