Excel.Style class

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

Extends

Hinweise

[API-Satz: ExcelApi 1.7]

Eigenschaften

autoIndent

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

borders

Eine Sammlung von vier Bordürenobjekten, die den Stil der vier Bordüren darstellen.

builtIn

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

context

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

fill

Die Füllung der Formatvorlage.

font

Ein Font Objekt, das die Schriftart der Formatvorlage 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 findest du hier Excel.HorizontalAlignment .

includeAlignment

Gibt an, ob die Formatvorlage die Eigenschaften AutoEinzug, horizontale Ausrichtung, vertikale Ausrichtung, Textumbruch, Einzugsebene und Textausrichtung enthält.

includeBorder

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

includeFont

Gibt an, ob die Formatvorlage die Schriftarteigenschaften Hintergrund, Fett, Farbe, Farbindex, Schriftschnitt, kursiv, Name, Schriftgrad, durchgestrichen, tiefgestellt, hochgestellt und unterstrichen enthält.

includeNumber

Gibt an, ob die Formatvorlage die Zahlenformateigenschaft enthält.

includePatterns

Gibt an, ob die Formatvorlage die Eigenschaften Farbe, Farbindex, umkehren, wenn negativ, Muster, Musterfarbe und Musterfarbindex enthält.

includeProtection

Gibt an, ob die Formatvorlage die Eigenschaften "Ausgeblendeter Schutz" und "Gesperrter Schutz" für die Formel 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 Text automatisch verkleinert wird, damit er in die verfügbare Spaltenbreite passt.

textOrientation

Die Textausrichtung für die Formatvorlage.

verticalAlignment

Gibt die vertikale Ausrichtung für die Formatvorlage an. Weitere Informationen findest du hier Excel.VerticalAlignment .

wrapText

Gibt an, ob Excel den Text in das Objekt einbricht.

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 sie übergeben wird.) Während das ursprüngliche Excel.Style Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Excel.Interfaces.StyleData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.

Details zur Eigenschaft

autoIndent

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

autoIndent: boolean;

Eigenschaftswert

boolean

Hinweise

[API-Satz: ExcelApi 1.8]

borders

Eine Sammlung von vier Bordürenobjekten, die den Stil der vier Bordüren darstellen.

readonly borders: Excel.RangeBorderCollection;

Eigenschaftswert

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 dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

fill

Die Füllung der Formatvorlage.

readonly fill: Excel.RangeFill;

Eigenschaftswert

Hinweise

[API-Satz: ExcelApi 1.7]

font

Ein Font Objekt, das die Schriftart der Formatvorlage darstellt.

readonly font: Excel.RangeFont;

Eigenschaftswert

Hinweise

[API-Satz: ExcelApi 1.7]

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 findest du hier 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]

includeAlignment

Gibt an, ob die Formatvorlage die Eigenschaften AutoEinzug, horizontale Ausrichtung, vertikale Ausrichtung, Textumbruch, Einzugsebene und Textausrichtung enthält.

includeAlignment: boolean;

Eigenschaftswert

boolean

Hinweise

[API-Satz: ExcelApi 1.7]

includeBorder

Gibt an, ob die Formatvorlage die Eigenschaften Farbe, Farbindex, Linienart und Stärke 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, Schriftgrad, durchgestrichen, tiefgestellt, hochgestellt und unterstrichen enthält.

includeFont: boolean;

Eigenschaftswert

boolean

Hinweise

[API-Satz: ExcelApi 1.7]

includeNumber

Gibt an, ob die Formatvorlage die Zahlenformateigenschaft enthält.

includeNumber: boolean;

Eigenschaftswert

boolean

Hinweise

[API-Satz: ExcelApi 1.7]

includePatterns

Gibt an, ob die Formatvorlage die 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 Schutz" und "Gesperrter Schutz" für die Formel 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 Text automatisch verkleinert wird, damit er in die verfügbare Spaltenbreite passt.

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 findest du hier 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 in das Objekt einbricht.

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]

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

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.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 sie übergeben wird.) Während das ursprüngliche Excel.Style Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Excel.Interfaces.StyleData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.

toJSON(): Excel.Interfaces.StyleData;

Gibt zurück