Excel.RangeView class

パッケージ:

excel

RangeView は、親の範囲の表示されているセルのセットを表します。

Extends

OfficeExtension.ClientObject

注釈

[ API セット: ExcelApi 1.3 ]

プロパティ

cellAddresses	RangeView のセル アドレスを表します。
columnCount	表示される列の数。
context	オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
formulas	A1 スタイル表記の数式を表します。 セルに数式がない場合は、代わりに値が返されます。
formulasLocal	ユーザーの言語と数値書式ロケールで、A1 スタイル表記の数式を表します。 たとえば、英語の数式 "=SUM(A1, 1.5)" は、ドイツ語では "=SUMME(A1; 1,5)" になります。 セルに数式がない場合は、代わりに値が返されます。
formulasR1C1	R1C1 スタイル表記の数式を表します。 セルに数式がない場合は、代わりに値が返されます。
index	RangeView のインデックスを表す値を返します。
numberFormat	指定したセルの Excel の数値書式コードを表します。
rowCount	表示される行の数。
rows	範囲に関連付けられている範囲ビューのコレクションを表します。
text	指定した範囲のテキスト値。 テキスト値は、セルの幅には依存しません。 Excel UI で発生する # 記号による置換は、この API から返されるテキスト値には影響しません。
values	指定した範囲ビューの Raw 値を表します。 返されるデータの型は、文字列、数値、ブール値のいずれかになります。 エラーが含まれているセルは、エラー文字列を返します。
valueTypes	各セルのデータの種類を表します。

メソッド

getRange()	現在の RangeViewに関連付けられている親範囲を取得します。
load(options)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
set(properties, options)	オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。
set(properties)	既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
toJSON()	API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Excel.RangeView オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.RangeViewData として型指定) を返します。

プロパティの詳細

cellAddresses

RangeView のセル アドレスを表します。

readonly cellAddresses: any[][];

プロパティ値

any[][]

注釈

[ API セット: ExcelApi 1.3 ]

columnCount

表示される列の数。

readonly columnCount: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.3 ]

context

オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。

context: RequestContext;

プロパティ値

Excel.RequestContext

formulas

A1 スタイル表記の数式を表します。 セルに数式がない場合は、代わりに値が返されます。

formulas: any[][];

プロパティ値

any[][]

注釈

[ API セット: ExcelApi 1.3 ]

formulasLocal

ユーザーの言語と数値書式ロケールで、A1 スタイル表記の数式を表します。 たとえば、英語の数式 "=SUM(A1, 1.5)" は、ドイツ語では "=SUMME(A1; 1,5)" になります。 セルに数式がない場合は、代わりに値が返されます。

formulasLocal: any[][];

プロパティ値

any[][]

注釈

[ API セット: ExcelApi 1.3 ]

formulasR1C1

R1C1 スタイル表記の数式を表します。 セルに数式がない場合は、代わりに値が返されます。

formulasR1C1: any[][];

プロパティ値

any[][]

注釈

[ API セット: ExcelApi 1.3 ]

index

RangeView のインデックスを表す値を返します。

readonly index: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.3 ]

numberFormat

指定したセルの Excel の数値書式コードを表します。

numberFormat: any[][];

プロパティ値

any[][]

注釈

[ API セット: ExcelApi 1.3 ]

rowCount

表示される行の数。

readonly rowCount: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.3 ]

rows

範囲に関連付けられている範囲ビューのコレクションを表します。

readonly rows: Excel.RangeViewCollection;

プロパティ値

Excel.RangeViewCollection

注釈

[ API セット: ExcelApi 1.3 ]

text

指定した範囲のテキスト値。 テキスト値は、セルの幅には依存しません。 Excel UI で発生する # 記号による置換は、この API から返されるテキスト値には影響しません。

readonly text: string[][];

プロパティ値

string[][]

注釈

[ API セット: ExcelApi 1.3 ]

values

指定した範囲ビューの Raw 値を表します。 返されるデータの型は、文字列、数値、ブール値のいずれかになります。 エラーが含まれているセルは、エラー文字列を返します。

values: any[][];

プロパティ値

any[][]

注釈

[ API セット: ExcelApi 1.3 ]

valueTypes

各セルのデータの種類を表します。

readonly valueTypes: Excel.RangeValueType[][];

プロパティ値

Excel.RangeValueType[][]

注釈

[ API セット: ExcelApi 1.3 ]

メソッドの詳細

getRange()

現在の RangeViewに関連付けられている親範囲を取得します。

getRange(): Excel.Range;

戻り値

Excel.Range

注釈

[ API セット: ExcelApi 1.3 ]

load(options)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(options?: Excel.Interfaces.RangeViewLoadOptions): Excel.RangeView;

パラメーター

options

Excel.Interfaces.RangeViewLoadOptions

読み込むオブジェクトのプロパティのオプションを提供します。

戻り値

Excel.RangeView

load(propertyNames)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

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

パラメーター

propertyNames

string | string[]

読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。

戻り値

Excel.RangeView

load(propertyNamesAndPaths)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

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

パラメーター

propertyNamesAndPaths

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

propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。

戻り値

Excel.RangeView

set(properties, options)

オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。

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

パラメーター

properties

Excel.Interfaces.RangeViewUpdateData

メソッドが呼び出されるオブジェクトのプロパティに等形的に構造化されたプロパティを持つ JavaScript オブジェクト。

options

OfficeExtension.UpdateOptions

properties オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。

戻り値

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;

戻り値

Excel.Interfaces.RangeViewData