Excel.RangeFont class
Dieses Objekt stellt die Zeichenformatierung (Schriftart, Schriftgrad, Farbe usw.) für ein Objekt dar.
- Extends
Eigenschaften
| bold | Stellt den fetten Status der Schriftart dar. |
| color | HTML-Farbcodedarstellung der Textfarbe (z. B. #FF0000 steht für Rot). |
| context | Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| italic | Gibt den kursiven Status der Schriftart an. |
| name | Name der Schriftart (z. B. "Calibri"). Die Länge des Namens sollte nicht mehr als 31 Zeichen betragen. |
| size | Schriftgrad |
| strikethrough | Gibt den durchgestrichenen Status einer Schriftart an. Ein |
| subscript | Gibt den tiefgestellten Status der Schriftart an. Gibt zurück |
| superscript | Gibt den hochgestellten Status der Schriftart an. Gibt zurück |
| tint |
Gibt ein Double-Zeichen an, das eine Farbe für die Bereichsschriftart aufhellt oder abdunkelt. Der Wert liegt zwischen -1 (dunkelste) und 1 (hellste), mit 0 für die Originalfarbe. Ein |
| underline | Art der auf die Schriftart angewendeten Unterstreichung. Weitere Informationen findest du hier |
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 fetten Status der Schriftart dar.
bold: boolean;
Eigenschaftswert
boolean
Hinweise
color
HTML-Farbcodedarstellung der Textfarbe (z. B. #FF0000 steht für Rot).
color: string;
Eigenschaftswert
string
Hinweise
context
Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;
Eigenschaftswert
italic
Gibt den kursiven Status der Schriftart an.
italic: boolean;
Eigenschaftswert
boolean
Hinweise
name
Name der Schriftart (z. B. "Calibri"). Die Länge des Namens sollte nicht mehr als 31 Zeichen betragen.
name: string;
Eigenschaftswert
string
Hinweise
Beispiele
// Change the font of the selected range to "Impact".
await Excel.run(async (context) => {
const selection = context.workbook.getSelectedRange();
selection.format.font.name = "Impact";
await context.sync();
});
size
strikethrough
Gibt den durchgestrichenen Status einer Schriftart an. Ein null Wert gibt an, dass es im gesamten Bereich keine einheitliche Durchstreichungseinstellung gibt.
strikethrough: boolean;
Eigenschaftswert
boolean
Hinweise
subscript
Gibt den tiefgestellten Status der Schriftart an. Gibt zurück true , ob alle Schriftarten des Bereichs tiefgestellt sind. Gibt zurück false , ob alle Schriftarten des Bereichs hochgestellt oder normal sind (weder hochgestellt noch tiefgestellt). Andernfalls wird zurückgegeben null .
subscript: boolean;
Eigenschaftswert
boolean
Hinweise
superscript
Gibt den hochgestellten Status der Schriftart an. Gibt zurück true , ob alle Schriftarten des Bereichs hochgestellt sind. Gibt zurück false , ob alle Schriftarten des Bereichs tiefgestellt oder normal (weder hochgestellt noch tiefgestellt) sind. Andernfalls wird zurückgegeben null .
superscript: boolean;
Eigenschaftswert
boolean
Hinweise
tintAndShade
Gibt ein Double-Zeichen an, das eine Farbe für die Bereichsschriftart aufhellt oder abdunkelt. Der Wert liegt zwischen -1 (dunkelste) und 1 (hellste), mit 0 für die Originalfarbe. Ein null Wert gibt an, dass für den gesamten Bereich keine einheitliche Schriftarteinstellung tintAndShade festgelegt ist.
tintAndShade: number;
Eigenschaftswert
number
Hinweise
underline
Art der auf die Schriftart angewendeten Unterstreichung. Weitere Informationen findest du hier Excel.RangeUnderlineStyle .
underline: Excel.RangeUnderlineStyle | "None" | "Single" | "Double" | "SingleAccountant" | "DoubleAccountant";
Eigenschaftswert
Excel.RangeUnderlineStyle | "None" | "Single" | "Double" | "SingleAccountant" | "DoubleAccountant"
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.RangeFontLoadOptions): Excel.RangeFont;
Parameter
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.RangeFont;
Parameter
- propertyNames
-
string | string[]
Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.
Gibt zurück
Beispiele
await Excel.run(async (context) => {
const sheetName = "Sheet1";
const rangeAddress = "F:G";
const worksheet = context.workbook.worksheets.getItem(sheetName);
const range = worksheet.getRange(rangeAddress);
const rangeFont = range.format.font;
rangeFont.load('name');
await context.sync();
console.log(rangeFont.name);
});
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.RangeFont;
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.RangeFontUpdateData, options?: OfficeExtension.UpdateOptions): void;
Parameter
- properties
- Excel.Interfaces.RangeFontUpdateData
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.RangeFont): void;
Parameter
- properties
- Excel.RangeFont
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.RangeFont Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Excel.Interfaces.RangeFontData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.
toJSON(): Excel.Interfaces.RangeFontData;