Excel.RangeFont class

このオブジェクトは、オブジェクトのフォントの属性 (フォント名、フォント サイズ、色など) を表します。

Extends

注釈

[ API セット: ExcelApi 1.1 ]

プロパティ

bold

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

color

テキストの色の HTML カラー コード表現 (たとえば、#FF0000 は赤を表します)。

context

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

italic

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

name

フォント名 ("Calibri" など)。 名前の長さは 31 文字を超えてはなりません。

size

フォント サイズ。

strikethrough

フォントの取り消し線の状態を指定します。 null値は、範囲全体に均一な取り消し線設定がないことを示します。

subscript

フォントの添字の状態を指定します。 範囲のすべてのフォントが添字である場合は、 true を返します。 範囲のすべてのフォントが上付きまたは標準 (上付き文字も下付き文字もない) の場合は、 false を返します。 それ以外の場合は null を返します。

superscript

フォントの上付き文字の状態を指定します。 範囲のすべてのフォントが上付きである場合は、 true を返します。 範囲のすべてのフォントが添字または標準 (上付き文字も下付き文字もない) の場合は、 false を返します。 それ以外の場合は null を返します。

tintAndShade

範囲フォントの色を明るくまたは暗くする倍精度浮動小数点型 (double) を指定します。 値は -1 (最も暗い) から 1 (最も明るい) の間で、元の色の場合は 0 です。 null値は、範囲全体に均一なフォントtintAndShade設定がないことを示します。

underline

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

メソッド

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

set(properties, options)

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

set(properties)

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

toJSON()

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

プロパティの詳細

bold

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

bold: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.1 ]

color

テキストの色の HTML カラー コード表現 (たとえば、#FF0000 は赤を表します)。

color: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.1 ]

context

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

context: RequestContext;

プロパティ値

italic

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

italic: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.1 ]

name

フォント名 ("Calibri" など)。 名前の長さは 31 文字を超えてはなりません。

name: string;

プロパティ値

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

フォント サイズ。

size: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.1 ]

strikethrough

フォントの取り消し線の状態を指定します。 null値は、範囲全体に均一な取り消し線設定がないことを示します。

strikethrough: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

subscript

フォントの添字の状態を指定します。 範囲のすべてのフォントが添字である場合は、 true を返します。 範囲のすべてのフォントが上付きまたは標準 (上付き文字も下付き文字もない) の場合は、 false を返します。 それ以外の場合は null を返します。

subscript: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

superscript

フォントの上付き文字の状態を指定します。 範囲のすべてのフォントが上付きである場合は、 true を返します。 範囲のすべてのフォントが添字または標準 (上付き文字も下付き文字もない) の場合は、 false を返します。 それ以外の場合は null を返します。

superscript: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

tintAndShade

範囲フォントの色を明るくまたは暗くする倍精度浮動小数点型 (double) を指定します。 値は -1 (最も暗い) から 1 (最も明るい) の間で、元の色の場合は 0 です。 null値は、範囲全体に均一なフォントtintAndShade設定がないことを示します。

tintAndShade: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.9 ]

underline

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

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

プロパティ値

Excel.RangeUnderlineStyle | "None" | "Single" | "Double" | "SingleAccountant" | "DoubleAccountant"

注釈

[ API セット: ExcelApi 1.1 ]

メソッドの詳細

load(options)

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

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

パラメーター

options
Excel.Interfaces.RangeFontLoadOptions

読み込むオブジェクトのプロパティのオプションを提供します。

戻り値

load(propertyNames)

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

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

パラメーター

propertyNames

string | string[]

読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。

戻り値

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)

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

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

パラメーター

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。

戻り値

set(properties, options)

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

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

パラメーター

properties
Excel.Interfaces.RangeFontUpdateData

メソッドが呼び出されるオブジェクトのプロパティに等形的に構造化されたプロパティを持つ JavaScript オブジェクト。

options
OfficeExtension.UpdateOptions

properties オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。

戻り値

void

set(properties)

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

set(properties: Excel.RangeFont): void;

パラメーター

properties
Excel.RangeFont

戻り値

void

toJSON()

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

toJSON(): Excel.Interfaces.RangeFontData;

戻り値