Excel.RangeFormat class
範囲のフォント、塗りつぶし、境界線、配置などのプロパティをカプセル化する、書式設定オブジェクトです。
- Extends
プロパティ
| borders | 選択した範囲全体に適用する境界線オブジェクトのコレクション。 |
| column |
範囲内のすべての列の幅を指定します。 列幅が均一でない場合は、 |
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| fill | 範囲全体に定義された塗りつぶしオブジェクトを返します。 |
| font | 範囲全体に定義されたフォント オブジェクトを返します。 |
| horizontal |
指定したオブジェクトの水平方向の配置を表します。 詳細は「 |
| protection | 範囲に対する書式保護オブジェクトを返します。 |
| row |
範囲内のすべての行の高さ。 行の高さが均一でない場合は、 |
| text |
範囲内のすべてのセルのテキストの向き。 テキストの向きは、-90 から 90 の整数にする必要があります。垂直方向のテキストの場合は 180 にする必要があります。 範囲内の向きが均一でない場合は、 |
| use |
|
| use |
|
| vertical |
指定したオブジェクトの垂直方向の配置を表します。 詳細は「 |
| wrap |
Excel がオブジェクト内のテキストを折り返すかどうかを指定します。
|
メソッド
| autofit |
現在の列のデータに基づいて、現在の範囲の列の幅を最適な幅に変更します。 |
| autofit |
現在の行のデータに基づいて、現在の範囲の行の高さを最適な高さに変更します。 |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| set(properties, options) | オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。 |
| set(properties) | 既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。 |
| toJSON() | API オブジェクトが |
プロパティの詳細
borders
選択した範囲全体に適用する境界線オブジェクトのコレクション。
readonly borders: Excel.RangeBorderCollection;プロパティ値
注釈
columnWidth
範囲内のすべての列の幅を指定します。 列幅が均一でない場合は、 null が返されます。
columnWidth: number;プロパティ値
number
注釈
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
fill
範囲全体に定義された塗りつぶしオブジェクトを返します。
readonly fill: Excel.RangeFill;プロパティ値
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/formatting.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
const range = sheet.getRange("B2:E2");
range.format.fill.color = "#4472C4";;
range.format.font.color = "white";
await context.sync();
});
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"
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-pivotlayout.yaml
await Excel.run(async (context) => {
// Set a default value for an empty cell in the PivotTable. This doesn't include cells left blank by the layout.
const pivotTable = context.workbook.pivotTables.getItem("Farm Sales");
const pivotLayout = pivotTable.layout;
pivotLayout.emptyCellText = "--";
// Set the text alignment to match the rest of the PivotTable.
pivotLayout.getDataBodyRange().format.horizontalAlignment = Excel.HorizontalAlignment.right;
await context.sync();
});
protection
範囲に対する書式保護オブジェクトを返します。
readonly protection: Excel.FormatProtection;プロパティ値
注釈
rowHeight
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"
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/style.yaml
await Excel.run(async (context) => {
let worksheet = context.workbook.worksheets.getItem("Sample");
let range = worksheet.getRange("A1:E1");
// Apply new style.
range.style = ("Diagonal Orientation Style");
range.format.verticalAlignment = "Justify";
await context.sync();
});
wrapText
Excel がオブジェクト内のテキストを折り返すかどうかを指定します。
null値は、範囲全体に均一な折り返し設定が設定されていないことを示します
wrapText: boolean;プロパティ値
boolean
注釈
メソッドの詳細
autofitColumns()
現在の列のデータに基づいて、現在の範囲の列の幅を最適な幅に変更します。
autofitColumns(): void;返品
void
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-table-changed.yaml
await Excel.run(async (context) => {
let sheet = context.workbook.worksheets.getItem("Sample");
let range = sheet.getRange("B7");
range.values = [[900]];
range.format.autofitColumns();
await context.sync();
console.log("B7 value has been changed.");
});
autofitRows()
現在の行のデータに基づいて、現在の範囲の行の高さを最適な高さに変更します。
autofitRows(): void;返品
void
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-advanced.yaml
function queueCommandsToCreateTemperatureTable(sheet: Excel.Worksheet) {
let temperatureTable = sheet.tables.add('A1:M1', true);
temperatureTable.name = "TemperatureTable";
temperatureTable.getHeaderRowRange().values = [["Category", "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"]];
temperatureTable.rows.add(null, [
["Avg High", 40, 38, 44, 45, 51, 56, 67, 72, 79, 59, 45, 41],
["Avg Low", 34, 33, 38, 41, 45, 48, 51, 55, 54, 45, 41, 38],
["Record High", 61, 69, 79, 83, 95, 97, 100, 101, 94, 87, 72, 66],
["Record Low", -1, 2, 9, 24, 28, 32, 36, 39, 35, 21, 12, 4]
]);
temperatureTable.getRange().format.autofitColumns();
temperatureTable.getRange().format.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
プロパティ オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。
返品
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;