workbookRange リソースの種類
名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
セル、行、列、セルのブロックなど、ブック内の 1 つ以上の連続するセルのセットを表します。
メソッド
| メソッド | 戻り値の型 | 説明 |
|---|---|---|
| Get | workbookRange | 範囲オブジェクトのプロパティとリレーションシップを読み取ります。 |
| Update | workbookRange | 範囲オブジェクトを更新します。 |
| Delete | なし | 範囲に関連付けられているセルを削除します。 |
| Clear | なし | 範囲の値、書式、塗りつぶし、または罫線をクリアします。 |
| boundingrect を取得する | workbookRange | 指定された範囲を含む最小範囲オブジェクトを取得します。 たとえば、"B2:C5" と "D10:E15" の GetBoundingRect は、"B2:E16" になります。 |
| セルを取得する | workbookRange | 行番号と列番号に基づいて、1 つのセルを含む range オブジェクトを取得します。 セルは、ワークシートのグリッド内に留まる限り、親範囲の範囲外にすることができます。 返されるセルは、範囲の左上のセルを基準に配置されます。 |
| 列の取得 | workbookRange | 範囲に含まれる列を取得します。 |
| 後に列を取得する | workbookRangeView | 指定された範囲の右側にいくつかの列を取得します。 |
| 前に列を取得する | workbookRangeView | 指定された範囲の左側にいくつかの列を取得します。 |
| 列全体を取得する | workbookRange | 範囲の列全体を表す オブジェクトを取得します。 |
| 行全体を取得する | workbookRange | 範囲の行全体を表す オブジェクトを取得します。 |
| 交差を取得する | workbookRange | 指定した範囲の四角形の積集合を表す range オブジェクトを取得します。 |
| 最後のセルを取得する | workbookRange | 範囲内の最後のセルを取得します。 たとえば、"B2:D5" の最後のセルは "D5" になります。 |
| 最後の列を取得する | workbookRange | 範囲内の最後の列を取得します。 たとえば、"B2:D5" の最後の列は "D2:D5" になります。 |
| 最後の行を取得する | workbookRange | 範囲内の最後の行を取得します。 たとえば、"B2:D5" の最後の行は "B5:D5" になります。 |
| オフセット範囲を取得する | workbookRange | 指定した範囲からのオフセットの範囲を表す オブジェクトを取得します。 返される範囲のディメンションは、この範囲と一致します。 結果の範囲が、ワークシートのグリッドの境界線の外にはみ出る場合は、例外がスローされます。 |
| サイズ変更された範囲を取得する | workbookRangeView | 現在の範囲オブジェクトに似た範囲オブジェクトを取得しますが、右下隅が一部の行と列で展開 (または縮小) されます。 |
| 行を取得する | workbookRange | 範囲に含まれる行を取得します。 |
| 上記の行を取得する | workbookRangeView | 特定の範囲の上にある行を取得します。 |
| 以下の行を取得する | workbookRangeView | 特定の範囲より下の行を取得します。 |
| 使用範囲を取得する | workbookRange | 指定された範囲オブジェクトの使用範囲を返します。 |
| 表示ビューを取得する | workbookRangeView | フィルター済み範囲から、表示されている範囲を取得します。 |
| 範囲を挿入する | workbookRange | セルまたはセル範囲をこの範囲の代わりにワークシートに挿入し、他のセルをシフトしてスペースを作成します。 この時点で空き領域に位置する、新しい Range オブジェクトが返されます。 |
| Merge | なし | 範囲内のセルをワークシートの 1 つの領域にマージします。 |
| Unmerge | なし | 範囲内のセルを結合解除して別々のセルにします。 |
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| address | string | A1 スタイルの範囲参照を表します。 アドレス値には、シート参照が含まれています (たとえば、Sheet1!A1:B4)。 読み取り専用です。 |
| addressLocal | string | ユーザーの言語で指定された範囲の範囲参照を表します。 読み取り専用です。 |
| cellCount | int | 範囲に含まれるセルの数。 読み取り専用です。 |
| columnCount | int | 範囲に含まれる列の合計数を表します。 読み取り専用です。 |
| columnHidden | ブール型 | 現在の範囲のすべての列が非表示かどうかを示します。 |
| 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 | ブール型 | 現在の範囲のすべての行が非表示かどうかを示します。 |
| 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"
}