Excel.RangeFont class
Dieses Objekt stellt die Zeichenformatierung (Schriftart, Schriftgrad, Farbe usw.) für ein Objekt dar.
- Extends
Hinweise
Eigenschaften
| bold | Stellt den Fettdruckstatus der Schriftart dar. |
| color | HTML-Farbcodedarstellung der Textfarbe (z. B. #FF0000 steht für Rot). |
| context | Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| italic | Gibt den Kursivstatus der Schriftart an. |
| name | Schriftartname (z. B. "Calibri"). Die Länge des Namens darf nicht größer als 31 Zeichen sein. |
| size | Schriftgrad |
| strikethrough | Gibt den durchgestrichenen Status der Schriftart an. Ein |
| subscript | Gibt den Tiefgestelltstatus der Schriftart an. Gibt zurück |
| superscript | Gibt den hochgestellten 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. Weitere Informationen finden Sie unter |
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 Fettdruckstatus 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 Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;Eigenschaftswert
italic
Gibt den Kursivstatus der Schriftart an.
italic: boolean;Eigenschaftswert
boolean
Hinweise
name
Schriftartname (z. B. "Calibri"). Die Länge des Namens darf nicht größer als 31 Zeichen sein.
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 der Schriftart an. Ein null -Wert gibt an, dass der gesamte Bereich keine einheitliche Durchstreichungseinstellung aufweist.
strikethrough: boolean;Eigenschaftswert
boolean
Hinweise
subscript
Gibt den Tiefgestelltstatus 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
Gibt den hochgestellten 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
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. Weitere Informationen finden Sie unter 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 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.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 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.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
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.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 das Objekt übergeben wird.) Während das ursprüngliche Excel.RangeFont-Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.RangeFontData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
toJSON(): Excel.Interfaces.RangeFontData;Gibt zurück
Office Add-ins