workbookRange リソースの種類

[アーティクル]
03/26/2023

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

範囲は、1 つ以上の隣接するセル (セル、行、列、セルのブロックなど) のセットを表します。

メソッド

メソッド	戻り値の型	説明
範囲を取得する	workbookRange	範囲オブジェクトのプロパティと関係を読み取ります。
Update	workbookRange	範囲オブジェクトを更新します。
Boundingrect	workbookRange	指定した範囲を包含する、最小の Range オブジェクトを取得します。たとえば、"B2:C5" と "D10:E15" の GetBoundingRect は、"B2:E16" になります。
Cell	workbookRange	行と列の番号に基づいて、1 つのセルを含んだ範囲オブジェクトを取得します。以外このセルは、ワークシートのグリッド内であれば、親の範囲の境界の外のセルであってもかまいません。返されるセルは、範囲の左上のセルを基準に配置されます。
列	workbookRange	範囲に含まれる列を 1 つ取得します。
Columnsafter	workbookRangeView	指定した範囲の右側にある列を取得します。
Columnsbefore	workbookRangeView	指定した範囲の左側にある列を取得します。
Entirecolumn	workbookRange	範囲に含まれるすべての列を表すオブジェクトを取得します。
Entirerow	workbookRange	範囲に含まれるすべての行を表すオブジェクトを取得します。
Intersection	workbookRange	指定した範囲の長方形の交差を表す範囲オブジェクトを取得します。
Lastcell	Range	範囲内の最後のセルを取得します。たとえば、"B2:D5" の最後のセルは "D5" になります。
Lastcolumn	workbookRange	範囲内の最後の列を取得します。たとえば、"B2:D5" の最後の列は "D2:D5" になります。
Lastrow	Range	範囲内の最後の行を取得します。たとえば、"B2:D5" の最後の行は "B5:D5" になります。
Offsetrange	workbookRange	指定した範囲からのオフセットで範囲を表すオブジェクトを取得します。返される範囲のディメンションは、この範囲と一致します。結果の範囲が、ワークシートのグリッドの境界線の外にはみ出る場合は、例外がスローされます。
Row	Range	範囲に含まれている行を 1 つ取得します。
Rowsabove	workbookRangeView	特定の範囲の上にある行を取得します。
Rowsbelow	workbookRangeView	指定された範囲の下にある行を取得します。
Usedrange	workbookRange	指定した範囲オブジェクトのうち使用されている範囲を返します。
Clear	なし	範囲の値、書式、塗りつぶし、罫線などをクリアします。
Delete	なし	範囲に関連付けられているセルを削除します。
Insert	workbookRange	この範囲を占めるセルまたはセルの範囲をワークシートに挿入し、領域を空けるために他のセルをシフトします。この時点で空き領域に位置する、新しい Range オブジェクトが返されます。
Merge	なし	範囲内のセルをワークシートの 1 つの領域に結合します。
Resizedrange	workbookRangeView	現在の範囲オブジェクトに似た (ただし、右下隅がいくつかの行と列で拡張 (または縮小) されている) 範囲オブジェクトを取得します。
Unmerge	なし	範囲内のセルを結合解除して別々のセルにします。
Visibleview	workbookRangeView	フィルター済み範囲から、表示されている範囲を取得します。

プロパティ

プロパティ	型	説明
address	string	A1 スタイルの範囲参照を表します。アドレス値には、シート参照が含まれています (たとえば、Sheet1!A1:B4)。読み取り専用です。
addressLocal	string	ユーザーの言語で指定された範囲の範囲参照を表します。読み取り専用です。
cellCount	int	範囲に含まれるセルの数。読み取り専用です。
columnCount	int	範囲に含まれる列の合計数を表します。読み取り専用です。
columnHidden	boolean	現在の範囲のすべての列が非表示になっているかどうかを表します。
columnIndex	int	範囲に含まれる最初のセルの列番号を表します。 0 を起点とする番号になります。読み取り専用です。
formulas	Json	A1 スタイル表記の数式を表します。
formulasLocal	Json	ユーザーの言語と数値書式ロケールで、A1 スタイル表記の数式を表します。たとえば、英語の数式 "=SUM(A1, 1.5)" は、ドイツ語では "=SUMME(A1; 1,5)" になります。
formulasR1C1	Json	R1C1 スタイル表記の数式を表します。
hidden	ブール値	現在の範囲のすべてのセルが非表示になっているかどうかを表します。読み取り専用です。
numberFormat	Json	指定したセルの Excel の数値書式コードを表します。
rowCount	int	範囲に含まれる行の合計数を返します。読み取り専用です。
rowHidden	boolean	現在の範囲のすべての行が非表示になっているかどうかを表します。
rowIndex	int	範囲に含まれる最初のセルの行番号を返します。 0 を起点とする番号になります。読み取り専用です。
text	Json	指定した範囲のテキスト値。 [テキスト] の値はセルの幅に依存しません。 Excel UI で発生する # 記号の置換は、API によって返されるテキスト値には影響しません。読み取り専用。
valueTypes	string	各セルのデータの種類を表します。可能な値は、`Unknown`、`Empty`、`String`、`Integer`、`Double`、`Boolean`、`Error` です。読み取り専用です。
values	Json	指定した範囲の Raw 値を表します。返されるデータの型は、文字列、数値、ブール値のいずれかになります。エラーを含むセルは、エラー文字列を返します。

リレーションシップ

リレーションシップ	型	説明
format	workbookRangeFormat	Format オブジェクト (範囲のフォント、塗りつぶし、罫線、配置などのプロパティをカプセル化するオブジェクト) を返します。読み取り専用です。
sort	workbookRangeSort	現在の範囲を含んでいるワークシート。読み取り専用です。
worksheet	workbookWorksheet	現在の範囲を含んでいるワークシート。読み取り専用です。

JSON 表記

次の JSON 表現は、リソースの種類を示しています。

{
  "id": "string",
  "address": "string",
  "addressLocal": "string",
  "cellCount": 1024,
  "columnCount": 1024,
  "columnHidden": true,
  "columnIndex": 1024,
  "formulas": "Json",
  "formulasLocal": "Json",
  "formulasR1C1": "Json",
  "hidden": true,
  "numberFormat": "Json",
  "rowCount": 1024,
  "rowHidden": true,
  "rowIndex": 1024,
  "text": "Json",
  "valueTypes": "string",
  "values": "json"
}