WP Insert table

4D v17

WP Insert table


WP Insert table ( rangeObj ; mode {; rangeUpdate {; nbCols {; nbRows}}} ) -> 戻り値

引数	型	説明
rangeObj	Object	レンジオブジェクト
mode	倍長整数	挿入モード
rangeUpdate	倍長整数	レンジ更新モード
nbCols	倍長整数	テーブル内に設定するカラム数
nbRows	倍長整数	テーブル内に設定する行数
戻り値	Object	テーブル参照オブジェクト

説明

WP Insert table コマンドはrangeObj 引数で指定したレンジに、mode 引数で指定した挿入モード新しいテーブルを挿入し、それに対応した新しいテーブルオブジェクトを返します。オプションとして、rangeUpdate 引数や、規定のカラム数や行数を指定するnbCols や nbRows 引数を渡すことができます。

rangeObj 引数には、レンジを渡します。

注: テーブル内に別のテーブルを挿入することはできません(エラーが返されます)。

mode 引数には、ドキュメント内のテーブルに対して使用される挿入モードを指定する以下の定数のいづれか一つを渡します:

定数	型	値	コメント
wk append	倍長整数	2	コンテンツをターゲットの終わりに挿入する
wk prepend	倍長整数	1	コンテンツをターゲットの始めに挿入する
wk replace	倍長整数	0	ターゲットのコンテンツを置き換える

任意のrangeUpdate 引数には、以下の定数のいづれか一つを渡し、挿入されたテーブルがレンジに含まれるかどうかを指定します:

定数	型	値	コメント
wk exclude from range	倍長整数	1	更新されたレンジには、以前のコンテンツのみを含める
wk include in range	倍長整数	0	更新されたレンジに挿入コンテンツを含める

rangeUpdate 引数を渡さなかった場合、挿入されたテーブルはデフォルトではレンジに含まれます。

nbCols および nbRows 引数を渡して、テーブル内に定義したいカラムの数と行の数を指定することができます。デフォルトでは、引数が省略された場合、0列のカラムと0行を持った新しいテーブルが作成されます。するとWP Table append row コマンドを使用してこれらの要素を追加することができるようになります。

このコマンドは新しいテーブルをテーブルオブジェクトとして返し、これはその後他のWP tableコマンドへと渡すことができます。テーブルはデフォルトのフォント、境界線、カラーで作成されますが、これらはWP SET ATTRIBUTES コマンドを使用してカスタマイズすることが可能です。

例題

空のドキュメントに、3つのカラムと2つの行を持つ新しいテーブルを作成したい場合を考えます:

 C_OBJECT($WPRange;$WPTable)

 $WPRange:=WP Create range(WParea;wk start text;wk end text)

 $WPTable:=WP Insert table($WPRange;wk append;wk exclude from range;3;2)

結果:

参照

WP Table append row
WP Table get rows