mlreportgen.dom.TableEntry クラス

名前空間: mlreportgen.dom

テーブル エントリ

このページをすべて展開する

説明

mlreportgen.dom.TableEntry クラスのオブジェクトを使用して、テーブル エントリのコンテンツとスタイルを指定します。

mlreportgen.dom.TableEntry オブジェクトを追加できる DOM オブジェクトを確認するには、mlreportgen.dom.TableEntry オブジェクトを DOM クラス オブジェクトに追加を参照してください。

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

作成

説明

entryObj = TableEntry は、空のテーブル エントリを作成します。

entryObj = TableEntry(text) は、指定されたテキストを使用してテーブル エントリを作成します。コンストラクターは text オブジェクトを作成してテーブル エントリに追加します。Microsoft® Word 出力や PDF 出力では、Word や PDF がテーブル エントリ内で折り返されていないテキストを許可しないため、テーブル エントリのテキストは段落内で折り返されます。HTML 出力の場合、テキストは段落内で折り返されません。

entryObj = TableEntry(text,styleName) は、指定されたスタイルを使用し、指定されたテキストを含むテーブル エントリを作成します。

entryObj = TableEntry(domObj) は、domObj を含むテーブル エントリを作成します。ここで、domObj は、mlreportgen.dom.Paragraph オブジェクトなどの DOM オブジェクトです。

入力引数

すべて展開する

テーブル エントリのテキスト。文字ベクトルまたは string スカラーとして指定します。

データ型: char | string

テーブル エントリのテキスト。mlreportgen.dom.Text オブジェクトとして指定します。

styleName で指定されたスタイルは、このテーブルを追加するドキュメントのテンプレートで定義されていなければなりません。

プロパティ

すべて展開する

描画する境界線のタイプ。次の値のいずれかとして指定します。

境界線のスタイル説明Microsoft Word でサポートHTML と PDF でサポート
"dashed"破線はいはい
"dashdotstroked"斜めの破線と点が交互に入った線はいはい
"dashsmallgap"破線間に小さい隙間がある破線はいはい
"dotted"点線はいはい
"dotdash"点と破線が交互に入った線はいいいえ
"dotdotdash"2 つの点と 1 本の破線が交互に入った線はいいいえ
"double"二重線はいはい
"doublewave"二重波線はいいいえ
"groove"3D 効果溝付き線いいえはい
"hidden"

線なし

競合する境界線スタイルがある場合、競合する境界線スタイルよりも "hidden" の境界線スタイルが優先されるため、線は非表示になります。

いいえはい
"inset"3D 効果線いいえはい
"none"

線なし

競合する境界線スタイルがある場合、競合する境界線スタイルは "none" よりも優先されるため、競合する境界線スタイルが表示されます。

はいはい
"outset"3D 効果線はいはい
"ridge"3D 効果突起付き線いいえはい
"single"一重線はいはい
"solid"一重線いいえはい
"thick"太い線はいいいえ
"thickthinlargegap"太い破線と細い破線が交互に入った隙間の大きい破線はいいいえ
"thickthinmediumgap"太い破線と細い破線が交互に入った隙間が中程度の破線はいいいえ
"thickthinsmallgap"太い破線と細い破線が交互に入った隙間の小さい破線はいいいえ
"thinthicklargegap"細い破線と太い破線が交互に入った隙間の大きい破線はいいいえ
"thinthickmediumgap"細い破線と太い破線が交互に入った隙間が中程度の破線はいいいえ
"thinthicksmallgap"細い破線と太い破線が交互に入った隙間の小さい破線はいいいえ
"thinthickthinlargegap"細い破線と太い破線が交互に入った隙間の大きい破線はいいいえ
"thinthickthinmediumgap"細い破線と太い破線が交互に入った隙間が中程度の破線はいいいえ
"thinthickthinsmallgap"細い破線と太い破線が交互に入った隙間の小さい破線はいいいえ
"threedemboss"エンボス加工した効果線はいいいえ
"threedengrave"彫り込み効果線はいいいえ
"triple"三重線はいいいえ
"wave"波線はいいいえ

メモ

Microsoft Word レポートでは、mlreportgen.dom.Border オブジェクトを mlreportgen.dom.TableHeaderEntry、mlreportgen.dom.TableEntry、または mlreportgen.dom.HorizontalRule オブジェクトの Style プロパティに割り当てた場合、このプロパティの "inset" スタイルまたは "outset" スタイルは、レポーターによってサポートされません。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

境界線の色。CSS の色名、16 進数の RGB 値、または 10 進数の RGB 値を含む文字ベクトルまたは string スカラーとして指定します。

形式値
CSS の色名CSS の色名を指定します。CSS の色名のリストについては、https://www.w3.org/wiki/CSS/Properties/color/keywords を参照してください。
16 進数の RGB 値"#RRGGBB" の形式を使用します。最初の文字として # を使用し、赤、緑、および青の値に 2 桁の 16 進数を使用します。大文字と小文字のいずれも使用できます。
10 進数の RGB カラー値"rgb(r,g,b)" 形式を使用します。r、g、b は、それぞれ赤、緑、青の値を指定する正の整数で、コンマで区切ります。各値の範囲は 0 と 255 の範囲内でなければなりません。

例: "red" は、CSS の色名を使用して赤色を指定します。

例: "#0000ff" は、16 進数の RGB 値を使用して青色を指定します。

例: "rgb(128,0,128)" は、10 進数の RGB カラー値を使用して紫色を指定します。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

テーブルの境界線幅。数値とそれに続く測定単位の略語を含む文字ベクトルまたは string スカラーとして指定します。たとえば、"10px" は 10 ピクセルを指定します。有効な略語を以下に示します。

  • "px" — ピクセル

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

  • "in" — インチ

  • "mm" — ミリメートル

  • "pc" — パイカ

  • "pt" — ポイント

単位を省略することで、ピクセルとして指定することもできます。たとえば、"5" は 5 ピクセルを指定します。

例: "2pt"

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

テーブル エントリの範囲に含まれるテーブル列の数。double として指定します。

属性:

GetAccess
public
SetAccess
public

データ型: double

内側の余白。数値とそれに続く測定単位の略語を含む文字ベクトルまたは string スカラーとして指定します。たとえば、"10px" は 10 ピクセルを指定します。有効な略語を以下に示します。

  • "px" — ピクセル

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

  • "in" — インチ

  • "mm" — ミリメートル

  • "pc" — パイカ

  • "pt" — ポイント

単位を省略することで、ピクセルとして指定することもできます。たとえば、"5" は 5 ピクセルを指定します。

例: "5px"

このプロパティを設定すると、InnerMargin 書式がこのテーブル エントリの Style 書式配列に追加されます。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

テーブル エントリの範囲に含まれるテーブル行の数。double として指定します。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: double

テーブル セルのコンテンツの垂直方向の配置。以下のいずれかの値として指定します。

  • "top"

  • "bottom"

  • "middle"

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

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

メモ

Microsoft Word レポートでは、ドキュメント テンプレートで定義されていないスタイル名は無視されます。Microsoft Word テンプレートの詳細については、DOM API レポート プログラムのテンプレートを参照してください。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

このドキュメント要素オブジェクトの書式指定。DOM 書式オブジェクトの cell 配列として指定します。このプロパティで指定された書式は、この要素の StyleName プロパティで指定された対応する書式をオーバーライドします。このドキュメント要素オブジェクトに適用されない書式は無視されます。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: cell

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

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

属性:

GetAccess
public
SetAccess
private
NonCopyable
true

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

属性:

GetAccess
public
SetAccess
private
NonCopyable
true

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

メソッド

すべて展開する

詳細

すべて展開する

ヒント

  • テーブル内のすべてのテーブル エントリの書式設定を指定するには、mlreportgen.dom.Table オブジェクトまたは mlreportgen.dom.FormalTable オブジェクトの TableEntriesStyle プロパティを調整します。たとえば、境界線の書式を設定できます。

    import mlreportgen.dom.*
t = Table(magic(5));
t.TableEntriesStyle = {Border("solid","black","1")};

    mlreportgen.dom.TableEntry オブジェクトに設定したプロパティは、mlreportgen.dom.TableEntriesStyle 書式オブジェクトよりも優先されます。

  • テーブルの書式設定エラーを避けるため、テーブルのエントリ数に関係なく、同じセル数を占めるテーブル行を作成してください。たとえば、次のテーブルの最初の行には 2 つのテーブル エントリがあります。最初のエントリ Winter は 2 列分を占め、2 番目のエントリ Spring は 1 列分を占めています。2 行目には 3 つのエントリがあり、それぞれが 1 列分を占めています。

    Table with two rows that have different numbers of cells but span the same number of columns.

    テーブルの 2 行目だけを変更し、最初の 2 つのエントリ (Jaunary と February) をそれぞれ 2 列分、最後のエントリを 1 列分にすると、テーブルの書式が変わってしまいます。

    The first row in the table has two entries. The second row has three entries and the last entry spans two rows.

  • テーブル エントリに大きなコンテンツを含めると、テーブルがレポート ページに収まらない場合があります。テーブルが DOCX レポートのページに収まらない場合、Microsoft Word はそのレポートを開くことができません。テーブルが DOCX レポートに確実に収まるようにするには、大きなコンテンツがあるテーブル エントリの幅と高さを設定してください。幅を設定するには、mlreportgen.dom.Width クラスを使用します。高さを設定するには、mlreportgen.dom.Height クラスを使用します。既存の書式を削除しないようにするには、次のようにして、新しいテーブル エントリ スタイルを既存のスタイルと連結します。

    te = TableEntry(domObj);
te.Style = [te.Style, {Width("1in"), Height("1in")}];
append(row,te);
    テーブル内のすべてのエントリに書式を適用するには、テーブル オブジェクトの TableEntriesStyle プロパティを使用します。

バージョン履歴

R2014a で導入

参考

| | | | | | | |

トピック