mlreportgen.dom.Template クラス

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

レポートテンプレートオブジェクトの作成

説明

レポートテンプレートを作成するには、mlreportgen.dom.Template オブジェクトを使用します。たとえば、Text オブジェクト、Paragraph オブジェクト、または Image オブジェクトなどの DOM コンテンツと TemplateHole オブジェクトを Template オブジェクトに追加して、生成コンテンツ用のホールをもつ固定コンテンツを含むテンプレートを作成できます。

メモ

Microsoft^® Word for Mac は、DOM API テンプレートのホールの作成をサポートしていません。Mac で Word ドキュメント生成用の Word テンプレートを作成する必要がある場合は、DOM API を使用してテンプレートを作成できます。Template オブジェクトを作成し、mlreportgen.dom.TemplateHole を使用してホールを追加します。あるいは、Word を使用してテンプレートを作成し、そのテンプレートを Mac にコピーします。

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

作成

説明

templateObj = mlreportgen.dom.Template はテンプレートオブジェクトを作成し、TemplatePath プロパティを Untitled.htmtx に設定します。

templateObj = mlreportgen.dom.Template(templatePath) はテンプレートオブジェクトを作成し、TemplatePath プロパティを templatePath に設定します。templatePath にファイル拡張子が含まれていない場合、Type プロパティは既定値の HTML に設定されます。

例

templateObj = mlreportgen.dom.Template(templatePath,fileType) は、さらに Type プロパティを fileType に設定します。templatePath にファイル拡張子が含まれる場合、fileType は templatePath で指定されたファイル拡張子と一致していなければなりません。

templateObj = mlreportgen.dom.Template(templatePath,fileType,sourceTemplatePath) は、sourceTemplatePath で指定されたテンプレートに基づいてテンプレートオブジェクトを作成します。

入力引数

すべて展開する

`sourceTemplatePath` — 新しいテンプレートのベース
文字ベクトル | string スカラー

新しいテンプレートのベースとして使用するテンプレートへのパス。文字ベクトルまたは string スカラーとして指定します。ソーステンプレートのタイプは、fileType 引数と一致していなければなりません。

プロパティ

すべて展開する

`CurrentHoleId` — ドキュメントのカレントホールの ID
`''` (既定値) | 文字ベクトル | string スカラー

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

属性:

`SetAccess`	`private`
`Transient`	`true`
`NonCopyable`	`true`

データ型: char | string

`CurrentHoleType` — カレントホールのタイプ
`''` (既定値) | `"Inline"` | `"Block"`

カレントテンプレートホールのタイプ。"Inline" または "Block" として指定します。

インラインホールは、段落要素が含むことのできるドキュメント要素 (Text、Image、LinkTarget、ExternalLink、InternalLink、CharEntity、または AutoNumber) を対象とする。
ブロックホールは、Paragraph、Table、OrderedList、UnorderedList、DocumentPart、または Group の要素を含むことができる。

属性:

`SetAccess`	`private`
`Transient`	`true`
`NonCopyable`	`true`

データ型: char | string

`CurrentPageLayout` — このドキュメントの現在のページレイアウト
`[]` (既定値) | `mlreportgen.dom.DOCXPageLayout` オブジェクト | `mlreportgen.dom.PDFPageLayout` オブジェクト | `[]`

このドキュメントの現在のページレイアウト。mlreportgen.dom.DOCXPageLayout オブジェクト、mlreportgen.dom.PDFPageLayout オブジェクト、または [] として指定します。このプロパティは、Word ドキュメントと PDF ドキュメントに適用されます。Word ドキュメントの場合、この値は現在のページレイアウトを指定する DOCXPageLayout オブジェクトになります。PDF ドキュメントの場合、ドキュメントによってページレイアウトが現在指定されていれば、この値は PDFPageLayout オブジェクトになります。HTML ドキュメントの場合、この値は常に [] になります。

属性:

`SetAccess`	`private`
`Transient`	`true`
`NonCopyable`	`true`

`ForceOverwrite` — 既存の出力ファイルを上書きするオプション
`true` (既定値) | `false`

既存の出力ファイルを上書きするかどうか。true または false として指定します。既存の出力ファイルを同じ名前で上書きするには、このプロパティを true に設定します。このプロパティが false で、同じ名前の書き込み可能ファイルが存在する場合、このドキュメントを閉じるときにエラーが発生します。既存のファイルが読み取り専用の場合は、このプロパティの設定にかかわらず、このドキュメントを閉じるときにエラーが発生します。

属性:

NonCopyable true

データ型: logical

`HTMLHeadExt` — HTML ヘッダーのカスタムコンテンツ
`''` (既定値) | 文字ベクトル | string スカラー

HTML ヘッダーのカスタムコンテンツ。文字ベクトルまたは string スカラーとして指定します。このプロパティの値は、ドキュメントテンプレートの head セクションで指定されたコンテンツの後、このドキュメントの <head> 要素に対して追加されます。このプロパティは、ドキュメントを開く前にのみ設定します。

属性:

NonCopyable true

データ型: char | string

`OpenStatus` — ドキュメント要素が開かれているかどうかのステータス
`'unopened'` (既定値) | `'open'` | `'closed'`

このドキュメントが開かれているかどうかのステータス。'unopened'、'open'、または 'closed' として指定します。

属性:

`SetAccess`	`private`
`Transient`	`true`
`NonCopyable`	`true`

データ型: char | string

`OutputPath` — 出力ファイルまたはフォルダーのパス
`"untitled"` (既定値) | 文字ベクトル | string スカラー

出力ファイルまたはフォルダーのパス。文字ベクトルまたは string スカラーとして指定します。既定値は、現在のフォルダー内の untitled という名前のファイルまたはフォルダーへのパスです。パスは、"C:/myreports/reportA.docx" のように、絶対パスで指定できます。また、"reportA" のように、現在の MATLAB フォルダーからの相対パスで指定することもできます。ファイル拡張子を指定しない場合、DOM はドキュメントの Type プロパティに基づいて拡張子を追加します。このプロパティは、ドキュメントを開く前にのみ設定できます。

OutputPath がファイルとフォルダーのどちらのパスを指定するかは、以下の表に示すように、PackageType プロパティの値によって決まります。

`PackageType`	`OutputPath` の値
`"zipped"` または `"single-file"`	zip ファイルまたは単一のファイルのパスと名前
`"unzipped"`	未圧縮ファイルのフォルダー
`"both"`	zip ファイルのパスと名前、および未圧縮ファイルのフォルダー

メモ

MATLAB^® Drive™ などのクラウドドライブで PDF レポートを生成すると、レポート生成ソフトウェアとクラウドドライブ同期ソフトウェアとの間でファイルの競合が発生し、エラーとなる可能性があります。このエラーを回避するには、クラウドと同期しないローカルドライブでレポートを生成します。ローカルドライブにレポートを生成し、そのレポートをクラウドドライブにコピーするスクリプトを作成することを検討してください。

属性:

NonCopyable true

データ型: char | string

`PackageType` — 生成されるファイルのパッケージ化
`"zipped"` (既定値) | `"unzipped"` | `"both"` | `"single-file"`

生成されたファイルに使用するパッケージ化。表中のいずれか 1 つを値として指定します。

値	サポートされているレポートタイプ	説明
`"zipped"`	`"docx"`、`"html-multipage"`、または `"html"`	`OutputPath` プロパティで指定された場所に zip ファイルとしてレポートを生成します。この zip ファイルは、ドキュメントタイプと一致する拡張子をもちます (Word 出力であれば `docx`、HTML 出力であれば `htmtx`。)たとえば、ドキュメントタイプが `docx` であり、`OutputPath` が `s:\docs\MyDoc` であれば、その出力は `s:\docs\MyDoc.docx` という名前の zip ファイルにパッケージ化されます。
`"unzipped"`	`"docx"`、`"html-multipage"`、または `"html"`	`OutputPath` プロパティのファイル名をもつフォルダー内に、個別のファイルとしてレポートを生成します。たとえば、`OutputPath` が `s:\docs\MyDoc` であれば、出力フォルダーは `s:\docs\MyDoc` となります。
`"both"`	`"docx"`、`"html-multipage"`、または `"html"`	圧縮した出力と未圧縮の出力を生成します。
`"single-file"`	`"pdf"` または `"html-file"`	レポートを単一のファイルとして生成します。

ヒント

Type プロパティが "html" または "html-multipage" の場合、解凍せずに開くことができる HTML レポートを生成するには、PackageType を "unzipped" または "both" に設定します。生成されたファイルがあるフォルダーで root.html ファイルを開きます。

属性:

NonCopyable true

データ型: char | string

`Stylesheet` — テンプレートオブジェクトに適用するスタイルシート
`[]` (既定値) | `mlreportgen.dom.TemplateStylesheet` オブジェクト

テンプレートのスタイルシートを表すタイプ mlreportgen.dom.TemplateStylesheet のオブジェクト。スタイルシートには、段落、リスト、テーブルなどのレポート要素の書式設定に使用できるスタイル定義が含まれています。スタイルは、メインのテンプレート本体、ドキュメントパーツテンプレート、またはこのテンプレートオブジェクトから生成されたテンプレートを使用する他のドキュメントで使用できます。open メソッドを使用してこの Template を開くと、スタイルシートオブジェクトが作成され、この Template の基となっているテンプレートに存在するスタイルが自動的に設定されます。Stylesheet プロパティを使用し、既存のスタイルにアクセスして変更し、新しいスタイルを追加します。Template オブジェクトが閉じられると、スタイルは出力テンプレートパッケージ (HTML、PDF、DOCX) またはテンプレートドキュメント (HTML ファイル) に書き込まれます。

属性:

`SetAccess`	`private`
`NonCopyable`	`true`

`TemplateDocumentParts` — テンプレートオブジェクトで使用するドキュメントパーツ
`[]` (既定値) | `mlreportgen.dom.TemplateDocumentPart` オブジェクトの配列

テンプレートオブジェクトで使用するドキュメントパーツ。テンプレートに含める mlreportgen.dom.TemplateDocumentPart オブジェクトの配列として指定します。Template オブジェクトを閉じると、Report Generator はそれらのドキュメントパーツテンプレートを出力テンプレートパッケージ (HTML、PDF、DOCX) またはテンプレートドキュメント (HTML ファイル) に書き込みます。Template オブジェクトが使用しているテンプレートドキュメントにドキュメントパーツが含まれている場合、Report Generator は、Template オブジェクトが開かれたときに、既存のドキュメントパーツの DOM 表現を含む TemplateDocumentPart オブジェクトをこのプロパティに自動的に取り込みます。

`TemplatePath` — 使用するテンプレートのパス
文字ベクトル | string スカラー

使用するテンプレートの絶対パス (必要に応じてファイル拡張子を含めることができる)。文字ベクトルまたは string スカラーとして指定します。ファイル拡張子は、次のいずれかの値になります。

拡張子	ファイルタイプ
`.htmtx`	圧縮 HTML
`.dotx`	Microsoft Word
`.htmt`	単一ファイルの HTML
`.pdfx`	PDF

メモ

ドキュメントを出力用に開いた後、このプロパティを変更することはできません。

属性:

NonCopyable true

データ型: char | string

`TitleBarText` — HTML ブラウザーのタイトルバーのテキスト
`''` (既定値) | 文字ベクトル | string スカラー

HTML ブラウザーのタイトルバーのテキスト。文字ベクトルまたは string スカラーとして指定します。HTML ドキュメントの場合、このプロパティは、このドキュメントを表示するのに使用されるブラウザーのタイトルバーに表示されるテキストを指定します。Word ドキュメントと PDF ドキュメントの場合、このプロパティは無視されます。

このプロパティは、ドキュメントを開く前に設定します。

属性:

NonCopyable true

データ型: char | string

`Type` — 出力ファイルタイプ
`"html"` (既定値) | `"docx"`, | `"html-file"` | `"html-multipage"` | `"pdf"`

出力ファイルタイプ。次の値のいずれかとして指定します。

値	ファイルタイプ
`"docx"`	Microsoft Word
`"html"`	HTML ドキュメントのテキスト、イメージ、スタイルシート、および JavaScript^® ファイルを含む圧縮または未圧縮のフォルダーとしての HTML 出力
`"html-file"`	レポート用にテキスト、スタイルシート、JavaScript、およびイメージを含む単一のファイルで構成される HTML 出力
`"html-multipage"` (R2024a 以降)	複数のページに分割された HTML ドキュメントのテキスト、イメージ、スタイルシート、および JavaScript ファイルを含む圧縮または未圧縮のフォルダーとしての HTML 出力
`"pdf"`	PDF

TemplatePath プロパティを使用してテンプレートを指定する場合、テンプレートは Type プロパティと一致するものでなければなりません。

属性:

NonCopyable true

データ型: char | string

`Children` — `mlreportgen.dom.Template` オブジェクトの子
ドキュメント要素オブジェクトの配列

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

属性:

`SetAccess`	`private`
`NonCopyable`	`true`

`Tag` — `mlreportgen.dom.Template` オブジェクトのタグ
文字ベクトル | string スカラー

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

属性:

NonCopyable true

データ型: char | string

`Id` — `mlreportgen.dom.Template` オブジェクトの識別子
文字ベクトル | string スカラー

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

属性:

NonCopyable true

データ型: char | string

メソッド

すべて展開する

パブリックメソッド

Template メソッドは、対応する Document メソッドを使用するのと同じ方法で使用します。

メソッド	目的
`append`	ドキュメント要素をドキュメントに追加します。
`close`	このドキュメントを閉じます。ドキュメントが開かれていない場合または先に閉じられた場合、ドキュメントを閉じることはできません。
`mlreportgen.dom.Document.createTemplate`	既定のテンプレートを作成します。
`fill`	ドキュメントホールを埋めます。
`mlreportgen.dom.Document.getCoreProperties`	ドキュメントのコアプロパティを取得します。
`mlreportgen.dom.Document.getImageDirectory`	ドキュメントのイメージディレクトリを取得します。
`mlreportgen.dom.Document.getImagePrefix`	ドキュメントの生成されたイメージ名の接頭辞を取得します。
`getMainPartPath`	出力ドキュメントのメインパーツの相対パスを取得します。
`mlreportgen.dom.Document.getOPCMainPart`	出力ドキュメントのメインパーツの絶対パスを取得します。
`moveToNextHole`	次のテンプレートホールに移動します。
`open`	このドキュメントを開きます。ドキュメントが先に開かれた場合または先に閉じられた場合、ドキュメントを開くことはできません。
`package`	ファイルをドキュメントの OPC パッケージに追加します。
`mlreportgen.dom.Document.setCoreProperties`	ドキュメント要素のコアプロパティを設定します。

例

すべて折りたたむ

テンプレートの作成およびコンテンツの追加

ライブスクリプトを開く

この例では、タイトルのホールと作成者のホールをもつテンプレートを作成します。変数 type の値を変更して、他のタイプのテンプレートを作成できます。

テンプレートの作成

mlreportgen.dom 名前空間をインポートして、オブジェクトのコンストラクターとメソッドを呼び出すときに完全修飾名を含める必要がないようにします。

import mlreportgen.dom.*;

テンプレートのタイプを指定して、テンプレートオブジェクトを作成します。

type = "docx";
t = Template("mytemplate",type);

テンプレートにタイトルホールを追加し、スタイル Title を適用します。

hole = append(t,TemplateHole("TITLE"));
hole.Description = ("Title Description");
hole.DefaultHoleStyleName = "Title";

定型文テキストを含む段落を追加し、書式 Subtitle を適用します。

p = Paragraph("Author: ");
p.StyleName = "Subtitle";

段落を配置し、テキスト内の空白を維持します。

p.Style = {OuterMargin("0","0","1in","1in")};
p.WhiteSpace = "preserve";

段落にインラインホールを追加します。

hole = append(p,TemplateHole("AUTHOR"));
append(t,p);

作成したテンプレートオブジェクトを閉じます。

close(t);

テンプレートのホールを埋める

テンプレート mytemplate を使用するドキュメント TitleAuthor を作成します。

rpt = Document("TitleAuthor",type,"mytemplate");
open(rpt);

ホールを循環するループを作成します。

各ホールにコンテンツを追加します。

while(~strcmp(rpt.CurrentHoleId,"#end#"))
    switch(rpt.CurrentHoleId)
        case "TITLE"
            append(rpt,Paragraph("This Is My Title"));
        case "AUTHOR"
            append(rpt,"My Name");
    end
    
    moveToNextHole(rpt);
end

レポートを生成して表示します。

close(rpt);
rptview(rpt.OutputPath)

バージョン履歴

R2014b で導入

参考

mlreportgen.dom.TemplateHole | mlreportgen.dom.TemplateDocumentPart | mlreportgen.dom.Document | mlreportgen.dom.Document.createTemplate | rptview

mlreportgen.dom.Template クラス

説明

作成

説明

入力引数

sourceTemplatePath — 新しいテンプレートのベース 文字ベクトル | string スカラー

プロパティ

CurrentHoleId — ドキュメントのカレント ホールの ID '' (既定値) | 文字ベクトル | string スカラー

属性:

CurrentHoleType — カレント ホールのタイプ '' (既定値) | "Inline" | "Block"

属性:

CurrentPageLayout — このドキュメントの現在のページ レイアウト [] (既定値) | mlreportgen.dom.DOCXPageLayout オブジェクト | mlreportgen.dom.PDFPageLayout オブジェクト | []

属性:

ForceOverwrite — 既存の出力ファイルを上書きするオプション true (既定値) | false

属性:

HTMLHeadExt — HTML ヘッダーのカスタム コンテンツ '' (既定値) | 文字ベクトル | string スカラー

属性:

OpenStatus — ドキュメント要素が開かれているかどうかのステータス 'unopened' (既定値) | 'open' | 'closed'

属性:

OutputPath — 出力ファイルまたはフォルダーのパス "untitled" (既定値) | 文字ベクトル | string スカラー

属性:

PackageType — 生成されるファイルのパッケージ化 "zipped" (既定値) | "unzipped" | "both" | "single-file"

属性:

Stylesheet — テンプレート オブジェクトに適用するスタイルシート [] (既定値) | mlreportgen.dom.TemplateStylesheet オブジェクト

属性:

TemplateDocumentParts — テンプレート オブジェクトで使用するドキュメント パーツ [] (既定値) | mlreportgen.dom.TemplateDocumentPart オブジェクトの配列

TemplatePath — 使用するテンプレートのパス 文字ベクトル | string スカラー

属性:

TitleBarText — HTML ブラウザーのタイトル バーのテキスト '' (既定値) | 文字ベクトル | string スカラー

属性:

Type — 出力ファイル タイプ "html" (既定値) | "docx", | "html-file" | "html-multipage" | "pdf"

属性:

Children — mlreportgen.dom.Template オブジェクトの子 ドキュメント要素オブジェクトの配列

属性:

Tag — mlreportgen.dom.Template オブジェクトのタグ 文字ベクトル | string スカラー

属性:

Id — mlreportgen.dom.Template オブジェクトの識別子 文字ベクトル | string スカラー

属性:

メソッド

パブリック メソッド

例

テンプレートの作成およびコンテンツの追加

バージョン履歴

参考

トピック

`sourceTemplatePath` — 新しいテンプレートのベース
文字ベクトル | string スカラー

`CurrentHoleId` — ドキュメントのカレントホールの ID
`''` (既定値) | 文字ベクトル | string スカラー

`CurrentHoleType` — カレントホールのタイプ
`''` (既定値) | `"Inline"` | `"Block"`

`CurrentPageLayout` — このドキュメントの現在のページレイアウト
`[]` (既定値) | `mlreportgen.dom.DOCXPageLayout` オブジェクト | `mlreportgen.dom.PDFPageLayout` オブジェクト | `[]`

`ForceOverwrite` — 既存の出力ファイルを上書きするオプション
`true` (既定値) | `false`

`HTMLHeadExt` — HTML ヘッダーのカスタムコンテンツ
`''` (既定値) | 文字ベクトル | string スカラー

`OpenStatus` — ドキュメント要素が開かれているかどうかのステータス
`'unopened'` (既定値) | `'open'` | `'closed'`

`OutputPath` — 出力ファイルまたはフォルダーのパス
`"untitled"` (既定値) | 文字ベクトル | string スカラー

`PackageType` — 生成されるファイルのパッケージ化
`"zipped"` (既定値) | `"unzipped"` | `"both"` | `"single-file"`

`Stylesheet` — テンプレートオブジェクトに適用するスタイルシート
`[]` (既定値) | `mlreportgen.dom.TemplateStylesheet` オブジェクト

`TemplateDocumentParts` — テンプレートオブジェクトで使用するドキュメントパーツ
`[]` (既定値) | `mlreportgen.dom.TemplateDocumentPart` オブジェクトの配列

`TemplatePath` — 使用するテンプレートのパス
文字ベクトル | string スカラー

`TitleBarText` — HTML ブラウザーのタイトルバーのテキスト
`''` (既定値) | 文字ベクトル | string スカラー

`Type` — 出力ファイルタイプ
`"html"` (既定値) | `"docx"`, | `"html-file"` | `"html-multipage"` | `"pdf"`

`Children` — `mlreportgen.dom.Template` オブジェクトの子
ドキュメント要素オブジェクトの配列

`Tag` — `mlreportgen.dom.Template` オブジェクトのタグ
文字ベクトル | string スカラー

`Id` — `mlreportgen.dom.Template` オブジェクトの識別子
文字ベクトル | string スカラー

パブリックメソッド