API version 1

- ‐

Spread

表計算スプレッドシートを表示するクラスです。


画面表示例

../../../../_images/image001.png

スプレッドシートの利用可能行列数( maxColumns 、maxRows プロパティ)を設定することでスプレッドシートとして利用することが可能です。

また、CSVDocument オブジェクトやExcelSheet オブジェクトを<< オペレータで読み込むことで、オブジェクトの内容を表示/編集することができます。

概要

スプレッドシートを構成する行ヘッダ、列ヘッダ、行、列、セル等に対応するオブジェクトはありません。これらはSpreadの内部データとして管理され、メソッドを通じてアクセスする必要があります。

以下のようなプロパティ、メソッドを用いて各構成要素へのアクセッサを取得できます。

構成要素

プロパティ/メソッド

行ヘッダ

rowHeader プロパティ

列ヘッダ

columnHeader プロパティ

行

rows メソッド

列

columns メソッド

セル範囲

range メソッド

セル

cell メソッド

セルの表示スタイル(スタイルの合成)

セルの表示形式はスタイル情報が保持しています。スタイルを設定するプロパティは
Spread.defaultStyle
Spread.oddRowStyle
Spread.evenRowStyle
SpreadRow.style
SpreadColumn.style
SpreadRange.style
のように複数ありますが、最終的なセルの表示形式はこれらを合成した結果として表示されます。

セルの表示スタイルの合成は次のような仕様で行われます。

  • 複数のスタイルが設定されている場合、プロパティ毎にUNSPECIFIEDが設定されていない値が有効になります

  • 複数のスタイルにUNSPECIFIED以外の値が設定されている場合、以下の優先順位に従い、優先順位の高いスタイルに設定されている値が有効になります。*

高 セルのスタイル(SpreadRange.style)
↑ 行のスタイル(SpreadRow.style)
　 列のスタイル(SpreadColumn.style)
　 1行おきの行のスタイル(Spread.oddRowStyle、Spread.evenRowStyle)
↓ スプレッドシートのスタイル(Spread.defaultStyle)
低 システム規定のスタイル

システム規定のセル型はSpreadStyleTextです。各プロパティの規定値は、各プロパティページをご覧ください。


*
rows(2).style.bgColor = Color.GREEN;
columns("B").style.fgColor =Color.RED;
cell("C2").style.bgColor = Color.BLUE;
cell("C2").style.fgColor = Color.CYAN;
のように設定されている場合、
C2セル以外の2行目の背景色は緑になります。
B列の文字色は赤になります。
B2セルは背景色が緑で、文字色が赤になります。
C2セルは背景色が青で、文字色がシアンになります。

valueプロパティとtextプロパティ

valueプロパティはセルの値を示すプロパティです。ユーザーが値を入力することで変更されますが、それ以外にも自動的に値が設定される場合があります。

  • formulaプロパティに数式が設定されている場合、valueプロパティには計算結果が自動的に設定されます。

  • htmlプロパティにリッチテキストが設定されている場合、valueプロパティにはHTMLタグを除いた文字列が自動的に設定されます。

  • コンボボックス型セルの場合、リストから選択することで、選択された文字列が自動的に設定されます。

  • チェックボックス型セルの場合、チェックボックスをクリックすることで、チェックボックスの状態を表す数値が自動的に設定されます。

  • トグルボタン型セルの場合、ボタンをクリックすることで、ボタンの状態を表す論理値が自動的に設定されます。

textプロパティには、valueプロパティの内容をformatプロパティの書式設定に従い成形した文字列が自動的に設定されます。†


†
セルに数式「3+5」、書式文字列「00.00」が設定されている場合、
セルのvalueプロパティの値は8になります。また、textプロパティの内容は「08.00」という文字列になります。