Excel.ShapeFont class
Stellt die Schriftartattribute dar, z. B. Schriftartname, Schriftgrad und Farbe, für das Objekt einer Form TextRange .
- Extends
Hinweise
Eigenschaften
| bold | Stellt den Fett-Status der Schriftart dar. Gibt zurück |
| color | HTML-Farbcodedarstellung der Textfarbe (z. B. "#FF0000" steht für Rot). Gibt zurück |
| 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 |
| 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 |
| strikethrough | Gibt die durchgestrichene status der Schriftart an. Ein |
| subscript | Gibt den tiefgestellten status der Schriftart an. Gibt zurück |
| superscript | Gibt die hochgestellte status der Schriftart an. Gibt zurück |
| tint |
Gibt ein Double an, das eine Farbe für die Bereichsschriftart aufhellt oder abdunkeln kann. Der Wert liegt zwischen -1 (dunkelster) und 1 (hellste), mit 0 für die ursprüngliche Farbe. Ein |
| underline | Art der auf die Schriftart angewendeten Unterstreichung. Gibt zurück |
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 " |
| 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
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
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
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
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
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
strikethrough
Hinweis
Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Gibt die durchgestrichene status der Schriftart an. Ein null -Wert gibt an, dass der gesamte Bereich keine einheitliche Durchstreichungseinstellung aufweist.
strikethrough: boolean;Eigenschaftswert
boolean
Hinweise
subscript
Hinweis
Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Gibt den tiefgestellten status der Schriftart an. Gibt zurück true , wenn alle Schriftarten des Bereichs tiefgestellt sind. Gibt zurück false , wenn alle Schriftarten des Bereichs hoch- oder normal sind (weder hochgestellt noch tiefgestellt). Gibt andernfalls zurück null .
subscript: boolean;Eigenschaftswert
boolean
Hinweise
superscript
Hinweis
Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Gibt die hochgestellte status der Schriftart an. Gibt zurück true , wenn alle Schriftarten des Bereichs hochgestellt sind. Gibt zurück false , wenn alle Schriftarten des Bereichs tiefgestellt oder normal sind (weder hochgestellt noch tiefgestellt). Gibt andernfalls zurück null .
superscript: boolean;Eigenschaftswert
boolean
Hinweise
tintAndShade
Hinweis
Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Gibt ein Double an, das eine Farbe für die Bereichsschriftart aufhellt oder abdunkeln kann. Der Wert liegt zwischen -1 (dunkelster) und 1 (hellste), mit 0 für die ursprüngliche Farbe. Ein null -Wert gibt an, dass der gesamte Bereich keine einheitliche Schriftarteinstellung tintAndShade aufweist.
tintAndShade: number;Eigenschaftswert
number
Hinweise
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
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
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;