Main Content

mlreportgen.dom.ListItem クラス

名前空間: mlreportgen.dom

順序付きリストまたは順序なしリストの項目の作成

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

説明

順序付き (番号付き) リストまたは順序なし (箇条書き) リスト内の項目を指定します。

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

作成

説明

listItemObj = ListItem は、空のリスト項目を作成します。

例

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

listItemObj = ListItem(text,styleName) は、指定されたテキストを使用してリスト項目を作成し、指定されたスタイルを適用します。

listItemObj = ListItem(domObj) は、リスト項目を作成し、指定されたドキュメント要素オブジェクトをリスト項目に追加します。

listItemObj = ListItem(domObj,styleName) は、指定されたドキュメント要素オブジェクトとスタイル名を使用してリスト項目を作成します。

入力引数

すべて展開する

コンストラクターは、指定されたテキストの mlreportgen.dom.Text オブジェクトを作成します。

段落に追加可能な Paragraph オブジェクトまたは要素を指定することができます。次の種類の DOM オブジェクトが含まれます。

  • mlreportgen.dom.Text

  • mlreportgen.dom.Paragraph

  • mlreportgen.dom.Image

  • mlreportgen.dom.Table

  • mlreportgen.dom.FormalTable

  • mlreportgen.dom.ExternalLink

  • mlreportgen.dom.InternalLink

  • mlreportgen.dom.CustomElement

リスト項目に使用するスタイルの名前。文字ベクトルとして指定します。

プロパティ

すべて展開する

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

属性:

NonCopyable
true

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

属性:

NonCopyable
true

データ型: cell

クラスはこのプロパティを無視します。

属性:

NonCopyable
true

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

属性:

SetAccess
private
NonCopyable
true

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

属性:

SetAccess
private
NonCopyable
true

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

属性:

NonCopyable
true

データ型: char | string

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

属性:

NonCopyable
true

データ型: char | string

メソッド

すべて展開する

例

すべて折りたたむ

import mlreportgen.dom.*;
doctype = 'html';
d = Document('test',doctype);
p = Paragraph('Perform the following steps.');
append(d,p);

step1 = ListItem('Do this step first.');
textForItem = Text('Next, do this.');
step2 = ListItem(textForItem);
procedure = OrderedList();
append(procedure,step1);
append(procedure,step2);
append(d,procedure);

close(d);
rptview('test',doctype);

ヒント

  • 複数レベルのリストを作成する方法に基づいて、サブリストは、親リストの子となる場合と、親リスト内の前のリスト項目の子となる場合があります。サブリストが親リストのリスト項目の子である場合、サブリストはそのリスト項目から書式設定を継承します。サブリストが親リストの子である場合、サブリストは前のリスト項目から書式設定を継承しません。複数レベルのリストのリスト項目の書式設定を参照してください。

バージョン履歴

R2014b で導入

参考

| |

トピック