Excel.RangeFormat class
範囲のフォント、塗りつぶし、境界線、配置などのプロパティをカプセル化する、書式設定オブジェクトです。
- Extends
注釈
プロパティ
| auto |
テキストの配置が等しい分布に設定されている場合に、テキストを自動的にインデントするかどうかを指定します。 |
| borders | 選択した範囲全体に適用する境界線オブジェクトのコレクション。 |
| column |
範囲内のすべての列の幅を指定します。 列の幅が均一でない場合は、 |
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| fill | 範囲全体に定義された塗りつぶしオブジェクトを返します。 |
| font | 範囲全体に定義されたフォント オブジェクトを返します。 |
| horizontal |
指定したオブジェクトの水平方向の配置を表します。 詳細は「 |
| indent |
インデント レベルを示す 0 から 250 までの整数。 |
| protection | 範囲に対する書式保護オブジェクトを返します。 |
| reading |
範囲に適用される読み上げ順序。 |
| row |
範囲内のすべての行の高さ。 行の高さが一様でない場合は、 |
| shrink |
使用可能な列幅に合わせてテキストを自動的に縮小するかどうかを指定します。 |
| text |
範囲内のすべてのセルのテキストの向き。 テキストの向きは、-90 ~ 90 の整数、または垂直方向のテキストの場合は 180 である必要があります。 範囲内の向きが一様でない場合は、 |
| use |
|
| use |
|
| vertical |
指定したオブジェクトの垂直方向の配置を表します。 詳細は「 |
| wrap |
Excel がオブジェクト内のテキストを折り返すかどうかを指定します。
|
メソッド
| adjust |
範囲の書式設定のインデントを調整します。 インデント値の範囲は 0 ~ 250 で、文字数で測定されます。 |
| autofit |
現在の列のデータに基づいて、現在の範囲の列の幅を最適な幅に変更します。 |
| autofit |
現在の行のデータに基づいて、現在の範囲の行の高さを最適な高さに変更します。 |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| set(properties, options) | オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。 |
| set(properties) | 既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。 |
| toJSON() | API オブジェクトが |
プロパティの詳細
autoIndent
テキストの配置が等しい分布に設定されている場合に、テキストを自動的にインデントするかどうかを指定します。
autoIndent: boolean;プロパティ値
boolean
注釈
borders
選択した範囲全体に適用する境界線オブジェクトのコレクション。
readonly borders: Excel.RangeBorderCollection;プロパティ値
注釈
columnWidth
範囲内のすべての列の幅を指定します。 列の幅が均一でない場合は、 null が返されます。
columnWidth: number;プロパティ値
number
注釈
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
fill
範囲全体に定義された塗りつぶしオブジェクトを返します。
readonly fill: Excel.RangeFill;プロパティ値
注釈
font
範囲全体に定義されたフォント オブジェクトを返します。
readonly font: Excel.RangeFont;プロパティ値
注釈
horizontalAlignment
指定したオブジェクトの水平方向の配置を表します。 詳細は「Excel.HorizontalAlignment」をご覧ください。
horizontalAlignment: Excel.HorizontalAlignment | "General" | "Left" | "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | "Distributed";プロパティ値
Excel.HorizontalAlignment | "General" | "Left" | "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | "Distributed"
注釈
indentLevel
protection
範囲に対する書式保護オブジェクトを返します。
readonly protection: Excel.FormatProtection;プロパティ値
注釈
readingOrder
範囲に適用される読み上げ順序。
readingOrder: Excel.ReadingOrder | "Context" | "LeftToRight" | "RightToLeft";プロパティ値
Excel.ReadingOrder | "Context" | "LeftToRight" | "RightToLeft"
注釈
rowHeight
範囲内のすべての行の高さ。 行の高さが一様でない場合は、 null が返されます。
rowHeight: number;プロパティ値
number
注釈
shrinkToFit
使用可能な列幅に合わせてテキストを自動的に縮小するかどうかを指定します。
shrinkToFit: boolean;プロパティ値
boolean
注釈
textOrientation
範囲内のすべてのセルのテキストの向き。 テキストの向きは、-90 ~ 90 の整数、または垂直方向のテキストの場合は 180 である必要があります。 範囲内の向きが一様でない場合は、 null が返されます。
textOrientation: number;プロパティ値
number
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-text-orientation.yaml
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 オブジェクトの行の高さがシートの標準の高さと等しいかどうかを判断します。
Range オブジェクトの行の高さがシートの標準の高さと等しい場合は、trueを返します。 範囲に複数の行が含まれており、行がすべて同じ高さではない場合は、 null を返します。 それ以外の場合は false を返します。 注: このプロパティは、 trueに設定のみを目的としています。
falseに設定しても効果はありません。
useStandardHeight: boolean;プロパティ値
boolean
注釈
useStandardWidth
Range オブジェクトの列幅がシートの標準幅と等しいかどうかを指定します。
Range オブジェクトの列幅がシートの標準幅と等しい場合は、trueを返します。 範囲に複数の列が含まれており、列がすべて同じ高さではない場合は、 null を返します。 それ以外の場合は false を返します。 注: このプロパティは、 trueに設定のみを目的としています。
falseに設定しても効果はありません。
useStandardWidth: boolean;プロパティ値
boolean
注釈
verticalAlignment
指定したオブジェクトの垂直方向の配置を表します。 詳細は「Excel.VerticalAlignment」をご覧ください。
verticalAlignment: Excel.VerticalAlignment | "Top" | "Center" | "Bottom" | "Justify" | "Distributed";プロパティ値
Excel.VerticalAlignment | "Top" | "Center" | "Bottom" | "Justify" | "Distributed"
注釈
wrapText
Excel がオブジェクト内のテキストを折り返すかどうかを指定します。
null値は、範囲全体に均一なラップ設定がないことを示します
wrapText: boolean;プロパティ値
boolean
注釈
メソッドの詳細
adjustIndent(amount)
範囲の書式設定のインデントを調整します。 インデント値の範囲は 0 ~ 250 で、文字数で測定されます。
adjustIndent(amount: number): void;パラメーター
- amount
-
number
現在のインデントを調整する文字数。 この値は -250 から 250 の間である必要があります。 注: インデント レベルが 250 を超える場合、インデント レベルは 250 のままです。 同様に、インデント レベルが 0 より下の場合、インデント レベルは 0 のままです。
戻り値
void
注釈
autofitColumns()
autofitRows()
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Excel.Interfaces.RangeFormatLoadOptions): Excel.RangeFormat;パラメーター
読み込むオブジェクトのプロパティのオプションを提供します。
戻り値
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Excel.RangeFormat;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。
戻り値
例
// Select all of the range's format properties.
await Excel.run(async (context) => {
const sheetName = "Sheet1";
const rangeAddress = "F:G";
const worksheet = context.workbook.worksheets.getItem(sheetName);
const range = worksheet.getRange(rangeAddress);
range.load(["format/*", "format/fill", "format/borders", "format/font"]);
await context.sync();
console.log(range.format.wrapText);
console.log(range.format.fill.color);
console.log(range.format.font.name);
});
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.RangeFormat;パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。
戻り値
set(properties, options)
オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。
set(properties: Interfaces.RangeFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;パラメーター
- properties
- Excel.Interfaces.RangeFormatUpdateData
メソッドが呼び出されるオブジェクトのプロパティに等形的に構造化されたプロパティを持つ JavaScript オブジェクト。
- options
- OfficeExtension.UpdateOptions
properties オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。
戻り値
void
set(properties)
既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
set(properties: Excel.RangeFormat): void;パラメーター
- properties
- Excel.RangeFormat
戻り値
void
toJSON()
API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Excel.RangeFormat オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.RangeFormatData として型指定) を返します。
toJSON(): Excel.Interfaces.RangeFormatData;戻り値
Office Add-ins