Excel.RangeView class
RangeView は、親の範囲の表示されているセルのセットを表します。
- Extends
注釈
使用元
プロパティ
| cell |
|
| column |
表示されている列の数。 |
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| formulas | A1 スタイル表記の数式を表します。 セルに数式がない場合は、代わりにその値が返されます。 |
| formulas |
ユーザーの言語と数値書式ロケールで、A1 スタイル表記の数式を表します。 たとえば、英語の数式 "=SUM(A1, 1.5)" は、ドイツ語では "=SUMME(A1; 1,5)" になります。 セルに数式がない場合は、代わりにその値が返されます。 |
| formulasR1C1 | R1C1 スタイル表記の数式を表します。 セルに数式がない場合は、代わりにその値が返されます。 |
| index |
|
| number |
指定したセルの Excel の数値書式コードを表します。 |
| row |
表示されている行の数。 |
| rows | 範囲に関連付けられている範囲ビューのコレクションを表します。 |
| text | 指定した範囲のテキスト値。 テキスト値は、セルの幅には依存しません。 Excel UI で発生する # 記号による置換は、この API から返されるテキスト値には影響しません。 |
| values | 指定した範囲ビューの Raw 値を表します。 返されるデータは、文字列型、数値型、またはブール値にすることができます。 エラーが含まれているセルは、エラー文字列を返します。 |
| values |
この範囲内のセルの値の JSON 表現。
|
| values |
この範囲内のセルの値の JSON 表現。
|
| value |
各セルのデータの種類を表します。 |
メソッド
| get |
現在の |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| set(properties, options) | オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。 |
| set(properties) | 既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。 |
| toJSON() | API オブジェクトが |
プロパティの詳細
cellAddresses
columnCount
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
formulas
A1 スタイル表記の数式を表します。 セルに数式がない場合は、代わりにその値が返されます。
formulas: any[][];プロパティ値
any[][]
注釈
formulasLocal
ユーザーの言語と数値書式ロケールで、A1 スタイル表記の数式を表します。 たとえば、英語の数式 "=SUM(A1, 1.5)" は、ドイツ語では "=SUMME(A1; 1,5)" になります。 セルに数式がない場合は、代わりにその値が返されます。
formulasLocal: any[][];プロパティ値
any[][]
注釈
formulasR1C1
R1C1 スタイル表記の数式を表します。 セルに数式がない場合は、代わりにその値が返されます。
formulasR1C1: any[][];プロパティ値
any[][]
注釈
index
numberFormat
rowCount
rows
範囲に関連付けられている範囲ビューのコレクションを表します。
readonly rows: Excel.RangeViewCollection;プロパティ値
注釈
text
指定した範囲のテキスト値。 テキスト値は、セルの幅には依存しません。 Excel UI で発生する # 記号による置換は、この API から返されるテキスト値には影響しません。
readonly text: string[][];プロパティ値
string[][]
注釈
values
指定した範囲ビューの Raw 値を表します。 返されるデータは、文字列型、数値型、またはブール値にすることができます。 エラーが含まれているセルは、エラー文字列を返します。
values: any[][];プロパティ値
any[][]
注釈
valuesAsJson
この範囲内のセルの値の JSON 表現。
RangeView.values
とは異なり、RangeView.valuesAsJson はセル内のすべてのデータ型をサポートします。 たとえば、標準のブール値、数値値、文字列値に加えて、書式設定された数値や Web 画像などがあります。 この API から返されるデータは、常に en-US ロケールに合わせて調整されます。 ユーザーの表示ロケールでデータを取得するには、 RangeView.valuesAsJsonLocal を使用します。
valuesAsJson: CellValue[][];プロパティ値
Excel.CellValue[][]
注釈
valuesAsJsonLocal
この範囲内のセルの値の JSON 表現。
RangeView.values
とは異なり、RangeView.valuesAsJsonLocal はセル内のすべてのデータ型をサポートします。 たとえば、標準のブール値、数値値、文字列値に加えて、書式設定された数値や Web 画像などがあります。 この API から返されるデータは、常にユーザーの表示ロケールに合わせて調整されます。 ロケールに関係なくデータを取得するには、 RangeView.valuesAsJson を使用します。
valuesAsJsonLocal: CellValue[][];プロパティ値
Excel.CellValue[][]
注釈
valueTypes
各セルのデータの種類を表します。
readonly valueTypes: Excel.RangeValueType[][];プロパティ値
注釈
メソッドの詳細
getRange()
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Excel.Interfaces.RangeViewLoadOptions): Excel.RangeView;パラメーター
読み込むオブジェクトのプロパティのオプションを指定します。
返品
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Excel.RangeView;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切りの文字列または文字列の配列。
返品
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.RangeView;パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列であり、 propertyNamesAndPaths.expand は読み込むナビゲーションのプロパティを指定するコンマ区切りの文字列です。
返品
set(properties, options)
オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。
set(properties: Interfaces.RangeViewUpdateData, options?: OfficeExtension.UpdateOptions): void;パラメーター
- properties
- Excel.Interfaces.RangeViewUpdateData
メソッドが呼び出されたオブジェクトのプロパティと同型構造のプロパティを持つ JavaScript オブジェクト。
- options
- OfficeExtension.UpdateOptions
プロパティ オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。
返品
void
set(properties)
既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
set(properties: Excel.RangeView): void;パラメーター
- properties
- Excel.RangeView
返品
void
toJSON()
API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Excel.RangeView オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.RangeViewData と型指定) を返します。
toJSON(): Excel.Interfaces.RangeViewData;