Excel.RangeFont class

このオブジェクトは、オブジェクトのフォントの属性 (フォント名、フォント サイズ、色など) を表します。This object represents the font attributes (font name, font size, color, etc.) for an object.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

Extends

プロパティ

bold

フォントの太字の状態を表します。Represents the bold status of font.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

color

テキストの色の HTML カラー コード表記。HTML color code representation of the text color. 例:E.g. #FF0000 はは赤を表します。#FF0000 represents Red.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

context

オブジェクトに関連付けられている要求コンテキスト。The request context associated with the object. これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。This connects the add-in's process to the Office host application's process.

italic

フォントの斜体の状態を表します。Represents the italic status of the font.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

name

フォント名 (例: "Calibri")Font name (e.g. "Calibri")

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

size

フォント サイズ。Font size.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

strikethrough

フォントの取り消し線の状態を表します。Represents the strikethrough status of font. null 値は、範囲全体に同じ取り消し線設定がないことを示します。A null value indicates that the entire range doesn't have uniform Strikethrough setting.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

subscript

フォントの下付きの状態を表します。Represents the Subscript status of font. 範囲のすべてのフォントが下付きの場合は True を返します。Returns True if all the fonts of the range are Subscript. 範囲のすべてのフォントが上付き文字または標準 (上付き文字または下付き文字でない場合) の場合は、False を返します。Returns False if all the fonts of the range are Superscript or normal (neither Superscript, nor Subscript). それ以外の場合は Null を返します。Returns Null otherwise.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

superscript

フォントの上付きの状態を表します。Represents the Superscript status of font. 範囲のすべてのフォントが上付きの場合は True を返します。Returns True if all the fonts of the range are Superscript. 指定範囲のすべてのフォントが下付きまたは通常の場合 (上付き文字または下付き文字ではない場合) は、False を返します。Returns False if all the fonts of the range are Subscript or normal (neither Superscript, nor Subscript). それ以外の場合は Null を返します。Returns Null otherwise.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

tintAndShade

範囲のフォントの色を明るくするか、暗くする double 値を設定または返します。値は -1 が最も暗く、1 が最も明るくなります。元の色は 0 です。Returns or sets a double that lightens or darkens a color for Range Font, the value is between -1 (darkest) and 1 (brightest), with 0 for the original color. Null 値は、範囲全体に均一なフォントの tintAndShade が設定されていないことを示します。A null value indicates that the entire range doesn't have uniform font tintAndShade setting.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

underline

フォントに適用する下線の種類。Type of underline applied to the font. 詳細については、「Excel の Range過小な Linestyle」を参照してください。See Excel.RangeUnderlineStyle for details.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

メソッド

load(option)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るには先に "context.sync()" を呼び出す必要があります。You must call "context.sync()" before reading the properties.

load(propertyNames)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

load(propertyNamesAndPaths)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

set(properties, options)

一度に1つのオブジェクトの複数のプロパティを設定します。Sets multiple properties of an object at the same time. 適切なプロパティを持つプレーンオブジェクト、または同じ種類の別の API オブジェクトのいずれかを渡すことができます。You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを設定します。Sets multiple properties on the object at the same time, based on an existing loaded object.

toJSON()

API オブジェクトがtoJSON()渡されるときに、より有用な出力を提供するために、JavaScript メソッドをオーバーライドします。JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringifyその後、渡されたtoJSONオブジェクトのメソッドを呼び出します。元の Excel の RangeFont オブジェクトは API オブジェクトであるのにtoJSON対して、メソッドはプレーンな JavaScript オブジェクト (として型指定されます) を返します。Excel.Interfaces.RangeFontData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.RangeFont object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.RangeFontData) は、元のオブジェクトから読み込まれた子プロパティの浅いコピーを格納します。) that contains shallow copies of any loaded child properties from the original object.

プロパティの詳細

bold

フォントの太字の状態を表します。Represents the bold status of font.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

bold: boolean;

プロパティ値

boolean

color

テキストの色の HTML カラー コード表記。HTML color code representation of the text color. 例:E.g. #FF0000 はは赤を表します。#FF0000 represents Red.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

color: string;

プロパティ値

string

context

オブジェクトに関連付けられている要求コンテキスト。The request context associated with the object. これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。This connects the add-in's process to the Office host application's process.

context: RequestContext;

プロパティ値

RequestContext

italic

フォントの斜体の状態を表します。Represents the italic status of the font.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

italic: boolean;

プロパティ値

boolean

name

フォント名 (例: "Calibri")Font name (e.g. "Calibri")

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

name: string;

プロパティ値

string

size

フォント サイズ。Font size.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

size: number;

プロパティ値

number

strikethrough

フォントの取り消し線の状態を表します。Represents the strikethrough status of font. null 値は、範囲全体に同じ取り消し線設定がないことを示します。A null value indicates that the entire range doesn't have uniform Strikethrough setting.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

strikethrough: boolean;

プロパティ値

boolean

subscript

フォントの下付きの状態を表します。Represents the Subscript status of font. 範囲のすべてのフォントが下付きの場合は True を返します。Returns True if all the fonts of the range are Subscript. 範囲のすべてのフォントが上付き文字または標準 (上付き文字または下付き文字でない場合) の場合は、False を返します。Returns False if all the fonts of the range are Superscript or normal (neither Superscript, nor Subscript). それ以外の場合は Null を返します。Returns Null otherwise.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

subscript: boolean;

プロパティ値

boolean

superscript

フォントの上付きの状態を表します。Represents the Superscript status of font. 範囲のすべてのフォントが上付きの場合は True を返します。Returns True if all the fonts of the range are Superscript. 指定範囲のすべてのフォントが下付きまたは通常の場合 (上付き文字または下付き文字ではない場合) は、False を返します。Returns False if all the fonts of the range are Subscript or normal (neither Superscript, nor Subscript). それ以外の場合は Null を返します。Returns Null otherwise.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

superscript: boolean;

プロパティ値

boolean

tintAndShade

範囲のフォントの色を明るくするか、暗くする double 値を設定または返します。値は -1 が最も暗く、1 が最も明るくなります。元の色は 0 です。Returns or sets a double that lightens or darkens a color for Range Font, the value is between -1 (darkest) and 1 (brightest), with 0 for the original color. Null 値は、範囲全体に均一なフォントの tintAndShade が設定されていないことを示します。A null value indicates that the entire range doesn't have uniform font tintAndShade setting.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

tintAndShade: number;

プロパティ値

number

underline

フォントに適用する下線の種類。Type of underline applied to the font. 詳細については、「Excel の Range過小な Linestyle」を参照してください。See Excel.RangeUnderlineStyle for details.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

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

プロパティ値

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

メソッドの詳細

load(option)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るには先に "context.sync()" を呼び出す必要があります。You must call "context.sync()" before reading the properties.

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

パラメーター

戻り値

注釈

このシグネチャに加えて、このメソッドのシグネチャは次のとおりです。In addition to this signature, this method has the following signatures:

load(option?: string | string[]): Excel.RangeFont-Where オプションは、読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列です。load(option?: string | string[]): Excel.RangeFont - Where option is a comma-delimited string or an array of strings that specify the properties to load.

load(option?: { select?: string; expand?: string; }): Excel.RangeFont-Where オプションを指定します。 select は、読み込むプロパティを指定するコンマで区切られた文字列で、オプション expand は読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。load(option?: { select?: string; expand?: string; }): Excel.RangeFont - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load.

load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.RangeFont-コレクション型でのみ使用できます。load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.RangeFont - Only available on collection types. これは、前述の署名に似ています。It is similar to the preceding signature. Top は、結果に含めることができるコレクション項目の最大数を指定します。Option.top specifies the maximum number of collection items that can be included in the result. 省略すると、スキップされ、結果に含まれないアイテムの数を指定します。Option.skip specifies the number of items that are to be skipped and not included in the result. Option を指定すると、指定した数のアイテムをスキップした後に結果セットが開始されます。If option.top is specified, the result set will start after skipping the specified number of items.

load(propertyNames)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

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

パラメーター

propertyNames
string | string[]

読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列。A comma-delimited string or an array of strings that specify the properties to load.

戻り値

Examples

Excel.run(function (ctx) { 
    var sheetName = "Sheet1";
    var rangeAddress = "F:G";
    var worksheet = ctx.workbook.worksheets.getItem(sheetName);
    var range = worksheet.getRange(rangeAddress);
    var rangeFont = range.format.font;
    rangeFont.load('name');
    return ctx.sync().then(function() {
        console.log(rangeFont.name);
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});
// The example below sets font name. 
Excel.run(function (ctx) { 
    var sheetName = "Sheet1";
    var rangeAddress = "F:G";
    var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range.format.font.name = 'Times New Roman';
    return ctx.sync(); 
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

load(propertyNamesAndPaths)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

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

パラメーター

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

ここで、は、読み込むプロパティを指定するコンマで区切られた文字列を指定します。 expand は、読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。Where propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.

戻り値

set(properties, options)

一度に1つのオブジェクトの複数のプロパティを設定します。Sets multiple properties of an object at the same time. 適切なプロパティを持つプレーンオブジェクト、または同じ種類の別の API オブジェクトのいずれかを渡すことができます。You can pass either a plain object with the appropriate properties, or another API object of the same type.

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

パラメーター

properties
Interfaces.RangeFontUpdateData

メソッドが呼び出されるオブジェクトのプロパティに構造化 isomorphically されているプロパティを持つ JavaScript オブジェクト。A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.

options
OfficeExtension.UpdateOptions

プロパティオブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。Provides an option to suppress errors if the properties object tries to set any read-only properties.

戻り値

void

注釈

このメソッドには、次の追加のシグネチャがあります。This method has the following additional signature:

set(properties: Excel.RangeFont): void

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを設定します。Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Excel.RangeFont): void;

パラメーター

properties
Excel.RangeFont

戻り値

void

toJSON()

API オブジェクトがtoJSON()渡されるときに、より有用な出力を提供するために、JavaScript メソッドをオーバーライドします。JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringifyその後、渡されたtoJSONオブジェクトのメソッドを呼び出します。元の Excel の RangeFont オブジェクトは API オブジェクトであるのにtoJSON対して、メソッドはプレーンな JavaScript オブジェクト (として型指定されます) を返します。Excel.Interfaces.RangeFontData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.RangeFont object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.RangeFontData) は、元のオブジェクトから読み込まれた子プロパティの浅いコピーを格納します。) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.RangeFontData;

戻り値