mlreportgen.dom.TemplateHole クラス

名前空間: mlreportgen.dom

テンプレートに追加するホール

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

説明

ドキュメント テンプレートに追加するホール。

次の種類の DOM オブジェクトにテンプレート ホールを追加できます。

  • Paragraph

  • TableEntry

  • Group

  • Template

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

作成

説明

templateHoleObj = TemplateHole は、空のプロパティをもつホールを作成します。

templateHoleObj = TemplateHole(id) は、指定された ID をもつホールを作成します。

templateHoleObj = TemplateHole(id,description) は、指定された ID と説明をもつホールを作成します。

入力引数

すべて展開する

テンプレート ホールの ID。文字ベクトルまたは string スカラーとして指定します。

テンプレート ホールの説明。文字ベクトルまたは string スカラーとして指定します。この引数の値は、割り当てられたテンプレートのホールのコンテンツになります。これにより、対応するアプリケーションでテンプレートを表示するときにホールの用途を判断することができます。この説明は、テンプレートから生成されるレポートにおいて、追加されるホール コンテンツで置き換えられます。

プロパティ

すべて展開する

ホール コンテンツの既定スタイルの名前。このスタイル名は、スタイル名を指定していないホール コンテンツに割り当てられます。たとえば、Text オブジェクトをこのホールに追加し、その Text オブジェクトがスタイル名を指定していないとします。次に、このプロパティの値がスタイル名として text オブジェクトに割り当てられます。このプロパティにより、テンプレートが追加コンテンツの外観を指定できるようになります。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

テンプレート ホールの説明。文字ベクトルまたは string スカラーとして指定します。このプロパティの値は、割り当てられたテンプレートのホールのコンテンツになります。これにより、対応するアプリケーションでテンプレートを表示するときにホールの用途を判断することができます。この説明は、テンプレートから生成されるレポートにおいて、追加されるホール コンテンツで置き換えられます。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

このテンプレート ホールの ID。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

タグ。文字ベクトルまたは 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

メソッド

すべて展開する

バージョン履歴

R2014b で導入

参考

| |

トピック