Excel.RangeFont class

Stellt den fetten Status der Schriftart dar.

bold: boolean;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.1

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-auto-fill.yaml

await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getActiveWorksheet();
  const sumRange = sheet.getRange("F4");
  sumRange.formulas = [["=SUM(B4:E4)"]];
  sumRange.format.fill.color = "LightBlue";
  sumRange.format.font.bold = true;
  sheet.getRanges("K4,P4").copyFrom("F4", Excel.RangeCopyType.all);
  sheet.getRanges("F4,K4,P4").format.autofitColumns();
  await context.sync();
});

HTML-Farbcodedarstellung der Textfarbe (z. B. #FF0000 steht für Rot).

color: string;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.1

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/formatting.yaml

// Get the font properties for the header range.
await Excel.run(async (context) => {
    const sheet: Excel.Worksheet = context.workbook.worksheets.getItem("Sample");
    const headerRange: Excel.Range = sheet.getRange("B2:E2");
    const headerFont: Excel.RangeFont = headerRange.format.font;

    headerFont.load("bold, color, italic, name, size, underline");
    await context.sync();

    console.log(`Bold: ${headerFont.bold}`);
    console.log(`Color: ${headerFont.color}`);
    console.log(`Italic: ${headerFont.italic}`);
    console.log(`Name: ${headerFont.name}`);
    console.log(`Size: ${headerFont.size}`);
    console.log(`Underline: ${headerFont.underline}`);
});

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

context: RequestContext;

Eigenschaftswert

Gibt den kursiven Status der Schriftart an.

italic: boolean;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.1

Name der Schriftart (z. B. "Calibri"). Die Länge des Namens sollte nicht mehr als 31 Zeichen betragen.

name: string;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.1

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();
});

Schriftgrad

size: number;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.1

Art der auf die Schriftart angewendeten Unterstreichung. Weitere Informationen findest du hier Excel.RangeUnderlineStyle .

underline: Excel.RangeUnderlineStyle | "None" | "Single" | "Double" | "SingleAccountant" | "DoubleAccountant";

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.1

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

Gibt zurück

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

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);
});

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

Gibt zurück

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

Gibt zurück

Legt mehrere Eigenschaften für das Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.

set(properties: Excel.RangeFont): void;

Parameter

Gibt zurück

Ü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;

Gibt zurück