Excel.ShapeFont class

Stellt die Schriftartattribute dar, z. B. Schriftartname, Schriftgrad und Farbe, für das Objekt einer Form TextRange .

Extends

Hinweise

[ API-Satz: ExcelApi 1.9 ]

Eigenschaften

bold

Stellt den Fett-Status der Schriftart dar. Gibt zurück null , wenn sowohl TextRange fett formatierte als auch nicht fett formatierte Textfragmente enthalten sind.

color

HTML-Farbcodedarstellung der Textfarbe (z. B. "#FF0000" steht für Rot). Gibt zurück null , wenn die TextRange Textfragmente mit unterschiedlichen Farben enthält.

context

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

italic

Stellt den Kursiv-Status der Schriftart dar. Gibt zurück null , wenn sowohl TextRange kursiv formatierte als auch nicht kursiv formatierte Textfragmente enthalten sind.

name

Stellt den Namen der Schriftart dar (z. B. "Calibri"). Wenn der Text eine komplexe Schrift oder eine ostasiatische Sprache ist, ist dies der entsprechende Schriftartname; andernfalls ist dies der lateinische Schriftartname.

size

Stellt den Schriftgrad in Punkt dar (z. B. 11). Gibt zurück null , wenn die TextRange Textfragmente mit unterschiedlichen Schriftgraden enthält.

underline

Art der auf die Schriftart angewendeten Unterstreichung. Gibt zurück null , wenn die TextRange Textfragmente mit unterschiedlichen Unterstreichungsstilen enthält. Weitere Informationen finden Sie unter Excel.ShapeFontUnderlineStyle .

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 "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.ShapeFont Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.ShapeFontData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

Details zur Eigenschaft

bold

Stellt den Fett-Status der Schriftart dar. Gibt zurück null , wenn sowohl TextRange fett formatierte als auch nicht fett formatierte Textfragmente enthalten sind.

bold: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.9 ]

color

HTML-Farbcodedarstellung der Textfarbe (z. B. "#FF0000" steht für Rot). Gibt zurück null , wenn die TextRange Textfragmente mit unterschiedlichen Farben enthält.

color: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApi 1.9 ]

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

italic

Stellt den Kursiv-Status der Schriftart dar. Gibt zurück null , wenn sowohl TextRange kursiv formatierte als auch nicht kursiv formatierte Textfragmente enthalten sind.

italic: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.9 ]

name

Stellt den Namen der Schriftart dar (z. B. "Calibri"). Wenn der Text eine komplexe Schrift oder eine ostasiatische Sprache ist, ist dies der entsprechende Schriftartname; andernfalls ist dies der lateinische Schriftartname.

name: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApi 1.9 ]

size

Stellt den Schriftgrad in Punkt dar (z. B. 11). Gibt zurück null , wenn die TextRange Textfragmente mit unterschiedlichen Schriftgraden enthält.

size: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApi 1.9 ]

underline

Art der auf die Schriftart angewendeten Unterstreichung. Gibt zurück null , wenn die TextRange Textfragmente mit unterschiedlichen Unterstreichungsstilen enthält. Weitere Informationen finden Sie unter Excel.ShapeFontUnderlineStyle .

underline: Excel.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";

Eigenschaftswert

Excel.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble"

Hinweise

[ API-Satz: ExcelApi 1.9 ]

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.ShapeFontLoadOptions): Excel.ShapeFont;

Parameter

options
Excel.Interfaces.ShapeFontLoadOptions

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

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

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

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.ShapeFontUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameter

properties
Excel.Interfaces.ShapeFontUpdateData

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.ShapeFont): void;

Parameter

properties
Excel.ShapeFont

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.ShapeFont Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.ShapeFontData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

toJSON(): Excel.Interfaces.ShapeFontData;

Gibt zurück