mlreportgen.dom.LOT クラス

名前空間: mlreportgen.dom
スーパークラス: mlreportgen.dom.LOC

テーブルのリスト

説明

mlreportgen.dom.LOT クラスのオブジェクトを使用して、レポート内のテーブルのリストを作成します。

各リスト項目には、テーブルのタイトルと、レポート内のタイトルへのリンクが含まれています。PDF または Microsoft^® Word のレポートでは、ページ番号およびタイトルとページ番号の間のスペースを埋めるリーダーもリスト項目に含まれます。PDF または Word のレポートでは、レポート内で LOT オブジェクトを追加した箇所にリストが配置されます。HTML レポートでは、List of Tables というタイトルをもつサイド バーにリストが配置されます。

リストの生成方法は、レポートのタイプによって異なります。

• PDF — DOM API がレポート生成時にリストを生成します。

• Word — DOM API がリストのプレースホルダーを生成します。リスト項目を生成するには、レポート生成プログラムまたは Word で Word ドキュメントを更新しなければなりません。Word ドキュメントの目次および生成されたリストの更新を参照してください。

• HTML — DOM API がリストのプレースホルダーを生成します。レポートが HTML ブラウザーで開かれるときに、ブラウザーによってリストが生成されます。

テーブルのリストにテーブルを含めるには、次のようにします。

1. mlreportgen.dom.Paragraph オブジェクトを使用してテーブルのタイトルを作成します。

2. mlreportgen.dom.AutoNumber オブジェクトを使用して、table という名前をもつ番号付けストリームに Paragraph オブジェクトを関連付けます。

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

クラス属性

ConstructOnLoad	true
HandleCompatible	true

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

作成

説明

LOTObj = mlreportgen.dom.LOT() は、mlreportgen.dom.LOT オブジェクトを作成し、LeaderPattern プロパティを "." に設定します。

LOTObj = mlreportgen.dom.LOT(leaderPattern) は mlreportgen.dom.LOT オブジェクトを作成し、LeaderPattern プロパティを指定されたリーダー パターンに設定します。

プロパティ

AutoNumberStreamName — 番号付けストリームの名前

"table" (既定値)

番号付けストリームの名前。"table" として指定します。このプロパティの値は変更しないでください。カスタムの番号付けストリーム名を使用してタイトルまたは表題のリストを作成するには、mlreportgen.dom.LOC オブジェクトを使用します。

データ型: char | string

LeaderPattern — リーダーのタイプ

"." (既定値) | "dots" | " " | "space"

タイトルとページ番号の間に使用するリーダーのタイプ。以下の文字ベクトルまたは string スカラーのいずれかとして指定します。

• "." または "dots"

• " " または "space"

メモ

このプロパティは、PDF レポートにのみ適用されます。Word レポートには常にドット リーダーがあります。HTML レポートにはリーダーがありません。

属性:

GetAccess	public
SetAccess	public
NonCopyable	true

データ型: char | string

StyleName — スタイルシート定義スタイル名

[] (既定値) | 文字ベクトル | string スカラー

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

メモ

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

属性:

GetAccess	public
SetAccess	public
NonCopyable	true

データ型: char | string

Style — 書式指定

{} (既定値) | DOM 書式オブジェクトの配列

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

属性:

GetAccess	public
SetAccess	public
NonCopyable	true

CustomAttributes — ドキュメント要素のカスタム属性

[] (既定値) | mlreportgen.dom.CustomAttribute オブジェクトの配列

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

属性:

GetAccess	public
SetAccess	public
NonCopyable	true

Parent — このオブジェクトの親

ドキュメント要素オブジェクト

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

属性:

GetAccess	public
SetAccess	private
NonCopyable	true

Children — このオブジェクトの子

ドキュメント要素オブジェクトの配列

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

属性:

GetAccess	public
SetAccess	private
NonCopyable	true

Tag — タグ

文字ベクトル | string スカラー

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

属性:

GetAccess	public
SetAccess	public
NonCopyable	true

データ型: char | string

Id — オブジェクト識別子

文字ベクトル | string スカラー

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

属性:

GetAccess	public
SetAccess	public
NonCopyable	true

データ型: char | string

メソッド

パブリック メソッド

clone

LOTObjCopy = clone(LOTObj) は、指定された LOT オブジェクトをコピー (クローン) します。mlreportgen.dom.Paragraph オブジェクトの clone メソッドを使用するのと同じ方法で、LOT オブジェクトの clone メソッドを使用します。

例

レポートでのテーブル リストの生成

テーブルのリストを mlreportgen.dom.LOT オブジェクトとして作成します。リストにテーブルを含めるには、次のようにします。

• テーブルのタイトルを mlreportgen.dom.Paragraph オブジェクトとして作成します。

• table という名前をもつ番号付けストリームに Paragraph オブジェクトを関連付けます。

長い完全修飾クラス名を使用せずに済むよう、DOM 名前空間をインポートします。

import mlreportgen.dom.*

レポートを作成します。

d = Document("DOM Report with List of Tables","docx");

テーブル コンテナーのリストを作成し、それをレポートに追加します。

lotObj = LOT();
append(d,lotObj);
append(d,PageBreak);

テーブルを作成します。

t1 = Table(magic(2));

テーブル タイトルの段落を作成します。

p1 = Paragraph("Table ");

table という名前の自動番号付けストリームを作成し、それを段落に関連付けます。

append(p1,AutoNumber("table"));

番号付けストリームのカウンターをインクリメントします。

p1.Style = {CounterInc("table"),WhiteSpace("preserve")};

残りのタイトル テキストを段落に追加し、その段落をレポートに追加します。

append(p1,".");
append(p1," Order 2 Magic Square");
append(d,p1);

テーブル タイトルに続けてテーブルをレポートに追加します。

append(d,t1);

別のテーブルおよびそのテーブルのタイトルを作成します。table 番号付けストリームをテーブル タイトルに関連付け、番号付けカウンターをインクリメントします。

t2 = Table(magic(3));
p2 = Paragraph("Table ");
append(p2,AutoNumber("table"));
p2.Style = {CounterInc("table"),WhiteSpace("preserve")};

残りのタイトル テキストを段落に追加し、その段落をレポートに追加します。

append(p2,".");
append(p2, " Order 3 Magic Square");
append(d,p2);

テーブル タイトルに続けてテーブルをレポートに追加します。

append(d,t2);

レポートを閉じて表示します。

close(d);
rptview(d);

生成されたレポートで、テーブルのリストは次のようになります。

バージョン履歴

R2020b で導入

参考

mlreportgen.report.ListOfFigures | mlreportgen.report.ListOfTables | mlreportgen.report.ListOfCaptions | mlreportgen.dom.LOF | mlreportgen.dom.LOC

トピック

• Create Lists of Figures, Tables, or Other Report Elements in DOM API Reports
• ドキュメントのコンテンツへの自動番号付け
• Word ドキュメントの目次および生成されたリストの更新
• Create Lists of Figures and Tables in Report API Reports