Main Content

このページの翻訳は最新ではありません。ここをクリックして、英語の最新版を参照してください。

mlreportgen.dom.LOC クラス

パッケージ: mlreportgen.dom

表題のリスト

R2020b 以降

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

説明

mlreportgen.dom.LOC クラスのオブジェクトを使用して、表題付きレポート要素のリストを生成します。表題付きの図やタイトル付きのテーブルのリストを生成するには、mlreportgen.dom.LOF クラスと mlreportgen.dom.LOT クラスのオブジェクトをそれぞれ使用します。式など、他のタイプのレポート要素のリストを生成するには、LOC オブジェクトを使用します。

各リスト項目には、レポート要素の表題と、レポート内の表題へのリンクが含まれます。PDF または Microsoft® Word のレポートでは、ページ番号および表題とページ番号の間のスペースを埋めるリーダーもリスト項目に含まれます。

PDF および Word レポートでは、レポート生成プログラムで指定した場所に表題のリストが配置されます。HTML レポートでは、表題のリストはサイド パネルに配置され、List of とそれに続く AutoNumberStreamName プロパティの値 (最初の文字が大文字になる) で構成されるタイトルをもちます。

リストにレポート要素を含めるには、次のようにします。

  1. equation などの番号付けストリーム名を選択します。LOC オブジェクトの AutoNumberStreamName プロパティを番号付けストリームの名前に設定します。

  2. mlreportgen.dom.Paragraph オブジェクトを使用して、レポート要素の表題またはタイトルを作成します。

  3. mlreportgen.dom.AutoNumber オブジェクトを使用して、Paragraph オブジェクトを番号付けストリーム名に関連付けます。

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

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

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

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

メモ

レポート要素に続く表題またはレポート要素に先行するタイトルに LOC オブジェクトを使用できます。

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

クラス属性

ConstructOnLoad
true
HandleCompatible
true

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

作成

説明

例

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

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

プロパティ

すべて展開する

番号付けストリームの名前。文字ベクトルまたは string スカラーとして指定します。

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

  • '.' または 'dots'

  • ' ' または 'space'

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

表題リストを書式設定するためのスタイルシート定義スタイルの名前。文字ベクトルまたは string スカラーとして指定します。

StyleName プロパティで指定されたスタイルは、この表題リストを追加するドキュメントまたはドキュメント パーツのスタイルシートで定義されていなければなりません。指定されたスタイルは、この LOC オブジェクトの Style プロパティで指定された書式を除いて、出力ドキュメントでの表題リストの外観を定義します。Style プロパティで指定された書式オブジェクトは、スタイルシートで定義された書式をオーバーライドします。

表題リストのスタイルを定義する書式。DOM 書式オブジェクトの cell 配列として指定します。この書式は、StyleName プロパティで指定したスタイルシートのスタイルで定義した対応する書式をオーバーライドします。表題のリストに適用されない書式は無視されます。

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

このドキュメント要素の親。DOM オブジェクトとして指定します。このプロパティは読み取り専用です。

属性:

GetAccess
public
SetAccess
private
NonCopyable
true

このドキュメント要素の子。DOM オブジェクトの配列として指定します。このプロパティは読み取り専用です。

このドキュメント要素のタグ。文字ベクトルまたは string スカラーとして指定します。

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

このドキュメント要素の ID。文字ベクトルまたは string スカラーとして指定します。ドキュメント要素を作成するときに、DOM によってセッション固有 ID が生成されます。独自の ID を指定できます。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

メソッド

すべて展開する

例

すべて折りたたむ

ライブ スクリプトを開く

この例では、レポートでコード例の表題リストを生成します。同じ手順を使用して、他のレポート要素の表題リストを生成できます。この例では、example という名前の自動番号付けストリームに表題を関連付けることで、リストに含める表題を識別します。番号付けストリームには任意の名前を使用できますが、その名前は、表題のリストを表す mlreportgen.dom.LOC オブジェクトの AutoNumberStream プロパティの値と一致していなければなりません。

長い完全修飾クラス名を使用せずに済むよう、DOM API パッケージをインポートします。

import mlreportgen.dom.*

レポートを作成します。

d = Document("DOM Report with List of Captions","pdf");

表題のプレースホルダーのリストを作成し、レポートに追加します。

locObj = LOC();
locObj.AutoNumberStreamName = "example";
append(d,locObj);
append(d,PageBreak);

コード例を含む段落を作成します。

pr1 = Preformatted("  a = 1;" + newline + "  b = 2;" + newline + "  c = a + b;");
append(d,pr1);

コード例の表題の段落を作成します。

p1 = Paragraph("Example ");

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

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

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

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

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

append(p1,".");
append(p1," Addition");
append(d,p1);

コード例とコード例の表題を含む別の段落を作成します。example 番号付けストリームを表題に関連付け、番号付けカウンターをインクリメントします。 

pr2 = Preformatted("  a = 1;" + newline + "  b = 2;" + newline + "  c = a * b;");
append(d,pr2);
p2 = Paragraph("Example ");
append(p2,AutoNumber("example"));
p2.Style = {CounterInc("example"),WhiteSpace("preserve")};

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

append(p2,".");
append(p2," Multiplication");
append(d,p2);

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

close(d);
rptview(d);

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

バージョン履歴

R2020b で導入

参考

| | | | | |

トピック