Excel.RangeFont class

フォントの太字の状態を表します。

bold: boolean;

プロパティ値

注釈

API セット: ExcelApi 1.1

例

// 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 カラー コード表現 (例: #FF0000 は赤を表します)。

color: string;

プロパティ値

注釈

API セット: ExcelApi 1.1

例

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

オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。

context: RequestContext;

プロパティ値

フォントの斜体の状態を指定します。

italic: boolean;

プロパティ値

注釈

API セット: ExcelApi 1.1

フォント名 (例: "Calibri")。 名前の長さは 31 文字以内にする必要があります。

name: string;

プロパティ値

注釈

API セット: ExcelApi 1.1

例

// 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: number;

プロパティ値

注釈

API セット: ExcelApi 1.1

フォントに適用する下線の種類。 詳細は「Excel.RangeUnderlineStyle」をご覧ください。

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

プロパティ値

注釈

API セット: ExcelApi 1.1

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(options?: Excel.Interfaces.RangeFontLoadOptions): Excel.RangeFont;

パラメーター

返品

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNames?: string | string[]): Excel.RangeFont;

パラメーター

返品

例

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

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.RangeFont;

パラメーター

返品

オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。

set(properties: Interfaces.RangeFontUpdateData, options?: OfficeExtension.UpdateOptions): void;

パラメーター

返品

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。

set(properties: Excel.RangeFont): void;

パラメーター

返品

API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Excel.RangeFont オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.RangeFontData と型指定) を返します。

toJSON(): Excel.Interfaces.RangeFontData;

返品