Main Content

mlreportgen.dom.TableRow クラス

名前空間: mlreportgen.dom

説明

mlreportgen.dom.TableRow クラスのオブジェクトを使用してテーブル行を作成します。

mlreportgen.dom.TableRow クラスは handle クラスです。

クラス属性

ConstructOnLoad
true
HandleCompatible
true

クラス属性の詳細については、クラスの属性を参照してください。

作成

説明

tableRowObj = TableRow は空のテーブル行を作成します。

プロパティ

すべて展開する

このテーブル行の高さ。数値とそれに続く測定単位の略語で構成される文字ベクトルまたは string スカラーとして指定します。たとえば、'0.5in' は 0.5 インチを指定します。有効な略語を以下に示します。

  • "px" — ピクセル

  • "cm" — センチメートル

  • "in" — インチ

  • "mm" — ミリメートル

  • "pc" — パイカ

  • "pt" — ポイント

このテーブル行の Style プロパティに mlreportgen.dom.RowHeight 書式オブジェクトが含まれている場合、Height プロパティは書式オブジェクトで指定された高さに設定されます。

Height プロパティを高さの値に設定すると、指定された高さの RowHeight オブジェクトが作成され、行の Style プロパティに追加されるか、Style プロパティの既存の RowHeight オブジェクトを置き換えるために使用されます。新しい RowHeight オブジェクトの Type'exact' です。この Type 値により、Microsoft® Word は指定された高さの行を生成し、収まらないコンテンツを切り捨てます。HTML および PDF のビューアーは、最小の高さを指定した行を作成し、コンテンツに合わせて行の高さを調整します。

メモ

mlreportgen.dom.Height オブジェクトを Style プロパティに追加すると、Type'atleast' に設定された mlreportgen.dom.RowHeight オブジェクトに変換されます。この Type 値により、HTML ビューアー、PDF ビューアー、および Microsoft Word は、最小の高さを指定した行を作成し、コンテンツに合わせて行の高さを調整します。

例: '0.5in'

この行のテーブル エントリ。mlreportgen.dom.TableEntry オブジェクトの配列として指定します。この行のテーブル エントリにアクセスするには、このプロパティを使用します。たとえば、次のコードは行 2 の要素 2 にアクセスします。

t = Table({'e11', 'e12'; 'e21', 'e22'});
elem22 = t.row(2).Entries(2);

mlreportgen.dom.Table クラスの entry メソッドを使用して、行 2 の要素 2 にアクセスすることもできます。例:

t = Table({'e11', 'e12'; 'e21', 'e22'});
elem22 = entry(t,2,2);

テーブル エントリに対応する TableEntry オブジェクトにアクセスする場合、オブジェクトのプロパティを設定してエントリを書式設定することができます。テーブル エントリの書式設定を参照してください。

このプロパティは読み取り専用です。

この行のテーブル エントリの数。整数として指定します。このプロパティは読み取り専用です。

スタイル名。文字ベクトルまたは string スカラーとして指定します。スタイル名は、この要素を追加するドキュメントまたはドキュメント パーツのスタイル シートで指定したスタイルの名前です。指定されたスタイルは、この要素の Style プロパティで指定された書式によってオーバーライドされない限り、出力ドキュメントでのこの要素の外観を定義します。スタイル シートの使用の詳細については、スタイル シートのスタイルの使用を参照してください。

メモ

Microsoft Word 出力ではスタイル名が無視されます。

属性:

NonCopyable
true

データ型: char | string

このテーブル行のスタイルを定義する書式。DOM 書式オブジェクトの cell 配列として指定します。この書式は、StyleName プロパティで指定したスタイルシートのスタイルで定義した対応する書式をオーバーライドします。

mlreportgen.dom.RowHeight オブジェクトまたは mlreportgen.dom.Height オブジェクトを Style プロパティに追加して、行の高さを指定することができます。mlreportgen.dom.Height オブジェクトは、タイプが 'atleast' に設定された mlreportgen.dom.RowHeight オブジェクトに変換されます。

このドキュメント要素のカスタム属性。mlreportgen.dom.CustomAttribute オブジェクトの配列として指定します。カスタム属性は、このオブジェクトが追加されるドキュメント要素の出力形式でサポートされていなければなりません。

属性:

NonCopyable
true

mlreportgen.dom.TableRow オブジェクトの親。ドキュメント要素オブジェクトとして指定します。ドキュメント要素の親は 1 つでなければなりません。

属性:

SetAccess
private
NonCopyable
true

mlreportgen.dom.TableRow オブジェクトの子。ドキュメント要素オブジェクトの配列として指定します。このプロパティには、append メソッドを使用して追加されたドキュメント要素オブジェクトが含まれます。

属性:

SetAccess
private
NonCopyable
true

mlreportgen.dom.TableRow オブジェクトのタグ。文字ベクトルまたは string スカラーとして指定します。DOM API は、このオブジェクトを作成するときに、セッション固有タグを生成します。生成されるタグの形式は CLASS:ID という形式です。ここで、CLASS はオブジェクト クラスです。ID はオブジェクトの Id プロパティの値です。独自のタグ値を指定すると、ドキュメント生成中に問題が発生したときにどこを確認すればよいかを特定しやすくなります。

属性:

NonCopyable
true

データ型: char | string

mlreportgen.dom.TableRow オブジェクトのオブジェクト識別子。文字ベクトルまたは string スカラーとして指定します。DOM API は、ドキュメント要素オブジェクトの作成時にセッション固有識別子を生成します。Id には独自の値を指定できます。

属性:

NonCopyable
true

データ型: char | string

メソッド

すべて展開する

すべて折りたたむ

空のテーブルにコンテンツを追加するには、テーブル エントリをテーブルの行に追加してから、テーブル行をテーブルに追加します。この例では、次の 2 行 2 列のテーブルを作成します。

ドキュメントを作成した後、2 つの列をもつテーブルを作成します。

import mlreportgen.dom.*

d = Document();
t = Table(2);

2 つのテーブル行を作成します。

tr1 = TableRow();
tr2 = TableRow();

コンテンツを含むテーブル エントリを作成し、そのテーブル エントリを行に追加します。

append(tr1,TableEntry('e11'));
append(tr1,TableEntry('e12'));
append(tr2,TableEntry('e21'));
append(tr2,TableEntry('e22'));

テーブル行をテーブルに追加します。

append(t,tr1);
append(t,tr2);

テーブルをドキュメントに追加します。ドキュメントを閉じて表示します。

append(d,t);
close(d);
rptview(d);

mlreportgen.dom.TableRow オブジェクトの Entries プロパティを使用して、書式設定するエントリに対応する mlreportgen.dom.TableEntry オブジェクトにアクセスします。TableEntry オブジェクトの書式プロパティを設定するか、オブジェクトの Style プロパティに書式オブジェクトを追加して、エントリを書式設定します。この例では、2 行目の 2 番目のエントリのテキストの色を赤に変更します。

import mlreportgen.dom.*
d = Document();
t = Table({'e11','e12';'e21','e22'});
t.row(2).Entries(2).Style = {Color('red')};
append(d,t);
close(d);
rptview(d);
    

結果のテーブルでは、2 行目の 2 番目のエントリにあるテキスト e22 が赤色になります。

あるいは、エントリを含む mlreportgen.dom.Table オブジェクトの entry メソッドを使用して、テーブル エントリにアクセスできます。前の例で、次を置き換えます。

t.row(2).Entries(2).Style = {Color('red')};

これを次のようにします。

elem = entry(t,2,2);
elem.Style = {Color('red')};

バージョン履歴

R2014b で導入