Excel.RangeFormat class

範囲のフォント、塗りつぶし、境界線、配置などのプロパティをカプセル化する、書式設定オブジェクトです。A format object encapsulating the range's font, fill, borders, alignment, and other properties.

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

Extends

プロパティ

autoIndent

テキスト配置が均等割り付けに設定されている場合、テキストを自動的にインデントするかどうかを指定します。Indicates if text is automatically indented when text alignment is set to equal distribution.

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

borders

選択した範囲全体に適用する境界線オブジェクトのコレクション。Collection of border objects that apply to the overall range. 読み取り専用です。Read-only.

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

columnWidth

範囲内のすべての列の幅を取得または設定します。Gets or sets the width of all colums within the range. 列の幅が均一でない場合は、null が返されます。If the column widths are not uniform, null will be returned.

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

context

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

fill

範囲全体に定義された塗りつぶしオブジェクトを返します。Returns the fill object defined on the overall range. 読み取り専用です。Read-only.

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

font

範囲全体に定義されたフォント オブジェクトを返します。Returns the font object defined on the overall range. 読み取り専用です。Read-only.

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

horizontalAlignment

指定したオブジェクトの水平方向の配置を表します。Represents the horizontal alignment for the specified object. 詳細については、「Excel の配置」を参照してください。See Excel.HorizontalAlignment for details.

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

indentLevel

インデント レベルを示す 0 から 250 までの整数。An integer from 0 to 250 that indicates the indent level.

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

protection

範囲に対する書式保護オブジェクトを返します。Returns the format protection object for a range. 読み取り専用。Read-only.

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

readingOrder

範囲に適用される読み上げ順序。The reading order for the range.

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

rowHeight

範囲内のすべての行の高さを取得または設定します。Gets or sets the height of all rows in the range. 行の高さが均一ではない場合は、null が返されます。If the row heights are not uniform, null will be returned.

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

shrinkToFit

使用可能な列幅に収まるように自動的に文字列が縮小されるかどうかを示します。Indicates if text automatically shrinks to fit in the available column width.

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

textOrientation

該当する範囲内のすべてのセルのテキストの向きを設定します。Gets or sets the text orientation of all the cells within the range. テキストの向きは、-90 から90、または180の整数である必要があります。垂直方向のテキスト。The text orientation should be an integer either from -90 to 90, or 180 for vertically-oriented text. 範囲内の向きが均一ではない場合は、null が返されます。If the orientation within a range are not uniform, then null will be returned.

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

useStandardHeight

Range オブジェクトの行の高さを、シートの標準の高さと等しくするかどうかを指定します。Determines if the row height of the Range object equals the standard height of the sheet. Range オブジェクトの行の高さがシートの標準の高さと等しい場合は True を返します。Returns True if the row height of the Range object equals the standard height of the sheet. 範囲に複数の行が含まれ、行の高さがすべて同じでない場合は、Null を返します。Returns Null if the range contains more than one row and the rows aren't all the same height. それ以外の場合は False を返します。Returns False otherwise.

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

useStandardWidth

Range オブジェクトの列の幅が、シートの標準の幅と等しいかどうかを示します。Indicates whether the column width of the Range object equals the standard width of the sheet. Range オブジェクトの列の幅がシートの標準の幅と等しい場合は True を返します。Returns True if the column width of the Range object equals the standard width of the sheet. 範囲に複数の列が含まれ、列の高さがすべて同じでない場合は、Null を返します。Returns Null if the range contains more than one column and the columns aren't all the same height. それ以外の場合は False を返します。Returns False otherwise.

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

verticalAlignment

指定したオブジェクトの垂直方向の配置を表します。Represents the vertical alignment for the specified object. 詳細については、「Excel の配置」を参照してください。See Excel.VerticalAlignment for details.

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

wrapText

オブジェクト内のテキストを Excel でラップするかどうかを表します。Indicates if Excel wraps the text in the object. null 値は、範囲全体に一様なラップ設定がないことを表します。A null value indicates that the entire range doesn't have uniform wrap setting

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

メソッド

autofitColumns()

現在の列のデータに基づいて、現在の範囲の列の幅を最適な幅に変更します。Changes the width of the columns of the current range to achieve the best fit, based on the current data in the columns.

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

autofitRows()

現在の行のデータに基づいて、現在の範囲の行の高さを最適な高さに変更します。Changes the height of the rows of the current range to achieve the best fit, based on the current data in the columns.

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

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 の RangeFormat オブジェクトは API オブジェクトであるのにtoJSON対し、メソッドはプレーンな JavaScript オブジェクト (として入力されます) を返します。Excel.Interfaces.RangeFormatData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.RangeFormat object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.RangeFormatData) は、元のオブジェクトから読み込まれた子プロパティの浅いコピーを格納します。) that contains shallow copies of any loaded child properties from the original object.

プロパティの詳細

autoIndent

テキスト配置が均等割り付けに設定されている場合、テキストを自動的にインデントするかどうかを指定します。Indicates if text is automatically indented when text alignment is set to equal distribution.

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

autoIndent: boolean;

プロパティ値

boolean

borders

選択した範囲全体に適用する境界線オブジェクトのコレクション。Collection of border objects that apply to the overall range. 読み取り専用です。Read-only.

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

readonly borders: Excel.RangeBorderCollection;

プロパティ値

columnWidth

範囲内のすべての列の幅を取得または設定します。Gets or sets the width of all colums within the range. 列の幅が均一でない場合は、null が返されます。If the column widths are not uniform, null will be returned.

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

columnWidth: number;

プロパティ値

number

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

fill

範囲全体に定義された塗りつぶしオブジェクトを返します。Returns the fill object defined on the overall range. 読み取り専用です。Read-only.

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

readonly fill: Excel.RangeFill;

プロパティ値

font

範囲全体に定義されたフォント オブジェクトを返します。Returns the font object defined on the overall range. 読み取り専用です。Read-only.

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

readonly font: Excel.RangeFont;

プロパティ値

horizontalAlignment

指定したオブジェクトの水平方向の配置を表します。Represents the horizontal alignment for the specified object. 詳細については、「Excel の配置」を参照してください。See Excel.HorizontalAlignment for details.

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

horizontalAlignment: Excel.HorizontalAlignment | "General" | "Left" | "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | "Distributed";

プロパティ値

Excel.HorizontalAlignment | "General" | "Left" | "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | "Distributed"

indentLevel

インデント レベルを示す 0 から 250 までの整数。An integer from 0 to 250 that indicates the indent level.

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

indentLevel: number;

プロパティ値

number

protection

範囲に対する書式保護オブジェクトを返します。Returns the format protection object for a range. 読み取り専用。Read-only.

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

readonly protection: Excel.FormatProtection;

プロパティ値

readingOrder

範囲に適用される読み上げ順序。The reading order for the range.

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

readingOrder: Excel.ReadingOrder | "Context" | "LeftToRight" | "RightToLeft";

プロパティ値

Excel.ReadingOrder | "Context" | "LeftToRight" | "RightToLeft"

rowHeight

範囲内のすべての行の高さを取得または設定します。Gets or sets the height of all rows in the range. 行の高さが均一ではない場合は、null が返されます。If the row heights are not uniform, null will be returned.

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

rowHeight: number;

プロパティ値

number

shrinkToFit

使用可能な列幅に収まるように自動的に文字列が縮小されるかどうかを示します。Indicates if text automatically shrinks to fit in the available column width.

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

shrinkToFit: boolean;

プロパティ値

boolean

textOrientation

該当する範囲内のすべてのセルのテキストの向きを設定します。Gets or sets the text orientation of all the cells within the range. テキストの向きは、-90 から90、または180の整数である必要があります。垂直方向のテキスト。The text orientation should be an integer either from -90 to 90, or 180 for vertically-oriented text. 範囲内の向きが均一ではない場合は、null が返されます。If the orientation within a range are not uniform, then null will be returned.

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

textOrientation: number;

プロパティ値

number

Examples

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const range = sheet.getRange("B2:E2");

    // Set textOrientation to either an integer between -90 and 90
    // or to 180 for vertically-oriented text.
    range.format.textOrientation = 90;

    await context.sync();
});

useStandardHeight

Range オブジェクトの行の高さを、シートの標準の高さと等しくするかどうかを指定します。Determines if the row height of the Range object equals the standard height of the sheet. Range オブジェクトの行の高さがシートの標準の高さと等しい場合は True を返します。Returns True if the row height of the Range object equals the standard height of the sheet. 範囲に複数の行が含まれ、行の高さがすべて同じでない場合は、Null を返します。Returns Null if the range contains more than one row and the rows aren't all the same height. それ以外の場合は False を返します。Returns False otherwise.

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

useStandardHeight: boolean;

プロパティ値

boolean

useStandardWidth

Range オブジェクトの列の幅が、シートの標準の幅と等しいかどうかを示します。Indicates whether the column width of the Range object equals the standard width of the sheet. Range オブジェクトの列の幅がシートの標準の幅と等しい場合は True を返します。Returns True if the column width of the Range object equals the standard width of the sheet. 範囲に複数の列が含まれ、列の高さがすべて同じでない場合は、Null を返します。Returns Null if the range contains more than one column and the columns aren't all the same height. それ以外の場合は False を返します。Returns False otherwise.

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

useStandardWidth: boolean;

プロパティ値

boolean

verticalAlignment

指定したオブジェクトの垂直方向の配置を表します。Represents the vertical alignment for the specified object. 詳細については、「Excel の配置」を参照してください。See Excel.VerticalAlignment for details.

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

verticalAlignment: Excel.VerticalAlignment | "Top" | "Center" | "Bottom" | "Justify" | "Distributed";

プロパティ値

Excel.VerticalAlignment | "Top" | "Center" | "Bottom" | "Justify" | "Distributed"

wrapText

オブジェクト内のテキストを Excel でラップするかどうかを表します。Indicates if Excel wraps the text in the object. null 値は、範囲全体に一様なラップ設定がないことを表します。A null value indicates that the entire range doesn't have uniform wrap setting

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

wrapText: boolean;

プロパティ値

boolean

メソッドの詳細

autofitColumns()

現在の列のデータに基づいて、現在の範囲の列の幅を最適な幅に変更します。Changes the width of the columns of the current range to achieve the best fit, based on the current data in the columns.

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

autofitColumns(): void;

戻り値

void

autofitRows()

現在の行のデータに基づいて、現在の範囲の行の高さを最適な高さに変更します。Changes the height of the rows of the current range to achieve the best fit, based on the current data in the columns.

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

autofitRows(): void;

戻り値

void

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.RangeFormatLoadOptions): Excel.RangeFormat;

パラメーター

戻り値

注釈

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

load(option?: string | string[]): Excel.RangeFormat-Where オプションは、読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列です。load(option?: string | string[]): Excel.RangeFormat - 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.RangeFormat-Where オプションを指定します。 select は、読み込むプロパティを指定するコンマで区切られた文字列で、オプション expand は読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。load(option?: { select?: string; expand?: string; }): Excel.RangeFormat - 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.RangeFormat-コレクション型でのみ使用できます。load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.RangeFormat - 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.RangeFormat;

パラメーター

propertyNames
string | string[]

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

戻り値

Examples

// Below example selects all of the Range's format properties. 
Excel.run(function (ctx) { 
    var sheetName = "Sheet1";
    var rangeAddress = "F:G";
    var worksheet = ctx.workbook.worksheets.getItem(sheetName);
    var range = worksheet.getRange(rangeAddress);
    range.load(["format/*", "format/fill", "format/borders", "format/font"]);
    return ctx.sync().then(function() {
        console.log(range.format.wrapText);
        console.log(range.format.fill.color);
        console.log(range.format.font.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, fill color and wraps text. 
Excel.run(function (ctx) { 
    var sheetName = "Sheet1";
    var rangeAddress = "F:G";
    var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range.format.wrapText = true;
    range.format.font.name = 'Times New Roman';
    range.format.fill.color = '0000FF';
    return ctx.sync(); 
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});
// The example below adds grid border around the range.
Excel.run(function (ctx) { 
    var sheetName = "Sheet1";
    var rangeAddress = "F:G";
    var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range.format.borders.getItem('InsideHorizontal').style = 'Continuous';
    range.format.borders.getItem('InsideVertical').style = 'Continuous';
    range.format.borders.getItem('EdgeBottom').style = 'Continuous';
    range.format.borders.getItem('EdgeLeft').style = 'Continuous';
    range.format.borders.getItem('EdgeRight').style = 'Continuous';
    range.format.borders.getItem('EdgeTop').style = 'Continuous';
    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.RangeFormat;

パラメーター

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.RangeFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;

パラメーター

properties
Interfaces.RangeFormatUpdateData

メソッドが呼び出されるオブジェクトのプロパティに構造化 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.RangeFormat): void

set(properties)

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

set(properties: Excel.RangeFormat): void;

パラメーター

properties
Excel.RangeFormat

戻り値

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 の RangeFormat オブジェクトは API オブジェクトであるのにtoJSON対し、メソッドはプレーンな JavaScript オブジェクト (として入力されます) を返します。Excel.Interfaces.RangeFormatData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.RangeFormat object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.RangeFormatData) は、元のオブジェクトから読み込まれた子プロパティの浅いコピーを格納します。) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.RangeFormatData;

戻り値