このページの内容は最新ではありません。最新版の英語を参照するには、ここをクリックします。
mlreportgen.dom.Document クラス
名前空間: mlreportgen.dom
ドキュメント コンテナー
説明
mlreportgen.dom.Document
クラスのオブジェクトを使用して、ドキュメント オブジェクト モデル (DOM) ドキュメントを表します。Document
オブジェクトのプロパティを使用して、以下を指定します。
生成するドキュメントの形式 (HTML、Microsoft® Word、または PDF)
生成ドキュメントの保存先と保存方法
ドキュメントの書式設定に使用するテンプレート
mlreportgen.dom.Document
クラスは handle
クラスです。
作成
説明
は、既定の HTML テンプレートを使用して、現在のフォルダーに documentObj
= mlreportgen.dom.DocumentUntitled.htmx
という名前の出力ファイルを指定する既定のプロパティ値をもつ Document
オブジェクトを作成します。
は、出力ファイルのパスと名前を指定して、OutputPath プロパティを documentObj
= mlreportgen.dom.Document(outputPath
)outputPath
に設定します。
documentObj = mlreportgen.dom.Document(outputPath,type,templatePath)
は、さらにテンプレート ファイルのパスと名前を指定して、TemplatePath
プロパティを templatePath
に設定します。
プロパティ
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 つを値として指定します。
値 | サポートされているレポート タイプ | 説明 |
---|---|---|
|
|
|
"unzipped" |
|
|
"both" |
| 圧縮した出力と未圧縮の出力を生成します。 |
"single-file" |
| レポートを単一のファイルとして生成します。 |
ヒント
Type
プロパティが "html"
または "html-multipage"
の場合、解凍せずに開くことができる HTML レポートを生成するには、PackageType
を "unzipped"
または "both"
に設定します。生成されたファイルがあるフォルダーで root.html
ファイルを開きます。
属性:
NonCopyable | true |
データ型: char
| string
ForceOverwrite
— 既存の出力ファイルを上書きするオプション
true
(既定値) | false
既存の出力ファイルを上書きするかどうか。true
または false
として指定します。既存の出力ファイルを同じ名前で上書きするには、このプロパティを true
に設定します。このプロパティが false
で、同じ名前の書き込み可能ファイルが存在する場合、このドキュメントを閉じるときにエラーが発生します。既存のファイルが読み取り専用の場合は、このプロパティの設定にかかわらず、このドキュメントを閉じるときにエラーが発生します。
属性:
NonCopyable | true |
データ型: logical
StreamOutput
— 出力をディスクにストリーミングするためのオプション
false
(既定値) | true
出力をディスクにストリーミングするためのオプション。true
または false
として指定します。既定では、ドキュメントが閉じられるまでは、メモリにドキュメント要素が格納されます。ドキュメントに要素が追加されたときにドキュメント要素をディスクに書き込むには、このプロパティを true
に設定します。
属性:
NonCopyable | true |
データ型: logical
TitleBarText
— HTML ブラウザーのタイトル バーのテキスト
''
(既定値) | 文字ベクトル | string スカラー
HTML ブラウザーのタイトル バーのテキスト。文字ベクトルまたは string スカラーとして指定します。HTML ドキュメントの場合、このプロパティは、このドキュメントを表示するのに使用されるブラウザーのタイトル バーに表示されるテキストを指定します。Word ドキュメントと PDF ドキュメントの場合、このプロパティは無視されます。
このプロパティは、ドキュメントを開く前に設定します。
属性:
NonCopyable | true |
データ型: char
| string
HTMLHeadExt
— HTML ヘッダーのカスタム コンテンツ
''
(既定値) | 文字ベクトル | string スカラー
HTML ヘッダーのカスタム コンテンツ。文字ベクトルまたは string スカラーとして指定します。このプロパティの値は、ドキュメント テンプレートの head セクションで指定されたコンテンツの後、このドキュメントの <head>
要素に対して追加されます。このプロパティは、ドキュメントを開く前にのみ設定します。
属性:
NonCopyable | true |
データ型: char
| string
TemplatePath
— 使用するテンプレートのパス
文字ベクトル | string スカラー
使用するテンプレートの絶対パス (必要に応じてファイル拡張子を含めることができる)。文字ベクトルまたは string スカラーとして指定します。ファイル拡張子は、次のいずれかの値になります。
拡張子 | ファイル タイプ |
---|---|
.htmtx | 圧縮 HTML |
.dotx | Microsoft Word |
.htmt | 単一ファイルの HTML |
.pdfx |
メモ
ドキュメントを出力用に開いた後、このプロパティを変更することはできません。
属性:
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" |
TemplatePath
プロパティを使用してテンプレートを指定する場合、テンプレートは Type
プロパティと一致するものでなければなりません。
属性:
NonCopyable | true |
データ型: char
| string
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 |
OpenStatus
— ドキュメントが開かれているかどうかのステータス
'unopened'
(既定値) | 'open'
| 'closed'
このドキュメントが開かれているかどうかのステータス。'unopened'
、'open'
、または 'closed'
として指定します。
メモ
mlreportgen.dom.Document
オブジェクトの OpenStatus
プロパティが 'open'
である場合、レポートを表示するために rptview
を呼び出すと、OpenStatus
が 'closed'
に設定されます。レポートを表示するには、DOM API の close
コマンドを実行する必要があります。これにより、レポートのメモリ内の DOM 表現が、Type プロパティで指定されたタイプのファイルに変換されます。Document.OpenStatus
が 'closed'
に設定されていない場合、rptview
は必要な close コマンドを発行します。
属性:
SetAccess | private |
Transient | true |
NonCopyable | true |
データ型: char
| string
EndnoteOptions
— ドキュメントの文末脚注オプション
[]
(既定値) | mlreportgen.dom.EndnoteOptions
オブジェクト
R2024a 以降
ドキュメントの文末脚注オプション。mlreportgen.dom.EndnoteOptions
オブジェクトとして指定します。EndnoteOptions
のプロパティが空の場合、ドキュメントは既定値を使用します。
メモ
ページ レイアウトで文末脚注オプションが指定されている場合、ページ レイアウトの文末脚注オプションは、ここで指定されたドキュメントの文末脚注オプションをオーバーライドします。
属性:
NonCopyable | true |
FootnoteOptions
— ドキュメントの脚注オプション
[]
(既定値) | mlreportgen.dom.FootnoteOptions
オブジェクト
R2024a 以降
ドキュメントの脚注オプション。mlreportgen.dom.FootnoteOptions
オブジェクトとして指定します。FootnoteOptions
のプロパティが空の場合、ドキュメントは既定値を使用します。
メモ
ページ レイアウトで脚注オプションが指定されている場合、ページ レイアウトの脚注オプションは、ここで指定されたドキュメントの脚注オプションをオーバーライドします。
属性:
NonCopyable | true |
Parent
— この mlreportgen.dom.Document
オブジェクトの親
ドキュメント要素オブジェクト
このドキュメント要素の親。ドキュメント要素として指定します。ドキュメント要素の親は 1 つでなければなりません。
属性:
SetAccess | private |
Transient | true |
NonCopyable | true |
Children
— この mlreportgen.dom.Document
オブジェクトの子
ドキュメント要素オブジェクト
このドキュメント要素の子。ドキュメント要素オブジェクトの配列として指定します。append
メソッドを使用して追加された要素がここに追加されます。
属性:
SetAccess | private |
Transient | true |
NonCopyable | true |
Tag
— mlreportgen.dom.Document
オブジェクトのタグ
文字ベクトル | string スカラー
mlreportgen.dom.Document
オブジェクトのタグ。文字ベクトルまたは string スカラーとして指定します。DOM API は、このオブジェクトを作成するときに、セッション固有タグを生成します。生成されるタグの形式は CLASS:ID
という形式です。ここで、CLASS
はオブジェクト クラスです。ID
はオブジェクトの Id
プロパティの値です。独自のタグ値を指定すると、ドキュメント生成中に問題が発生したときにどこを確認すればよいかを特定しやすくなります。
属性:
NonCopyable | true |
データ型: char
| string
Id
— mlreportgen.dom.Document
オブジェクトの識別子
文字ベクトル | string スカラー
mlreportgen.dom.Document
オブジェクトのオブジェクト識別子。文字ベクトルまたは string スカラーとして指定します。DOM API は、ドキュメント要素オブジェクトの作成時にセッション固有識別子を生成します。Id
には独自の値を指定できます。
属性:
NonCopyable | true |
データ型: char
| string
メソッド
パブリック メソッド
addHTML | ドキュメントへの HTML 文字列の追加 |
addHTMLFile | ドキュメントへの HTML ファイルのコンテンツの追加 |
append | ドキュメントへの DOM オブジェクトまたは MATLAB オブジェクトの追加 |
close | ドキュメントを閉じる |
createAutoNumberStream | Create numbering stream |
mlreportgen.dom.Document.createTemplate | DOM テンプレート ファイルの作成 |
fill | ドキュメント ホールを生成コンテンツで埋める |
getAutoNumberStream | Return numbering stream |
mlreportgen.dom.Document.getCoreProperties | ドキュメントまたはテンプレートのコア プロパティの取得 |
mlreportgen.dom.Document.getImageDirectory | ドキュメントのイメージ フォルダーの取得 |
mlreportgen.dom.Document.getImagePrefix | Get generated image name prefix |
getMainPartPath | Return path of main part of document output package |
mlreportgen.dom.Document.getOPCMainPart | Return main part of document, document part, or template |
moveToNextHole | ドキュメントの追加ポイントを次のテンプレート ホールに移動 |
open | ドキュメントを開く |
package | OPC パーツ ファイルをドキュメント パッケージに追加 |
mlreportgen.dom.Document.setCoreProperties | Set OPC core properties of output document or template |
例
Word ドキュメントの作成
Word ドキュメントを作成し、コンテンツを追加し、Word でレポートを表示します。
import mlreportgen.dom.*; d = Document("mydoc","docx"); append(d,"Hello World"); close(d); rptview(d);
単一のファイルとしての HTML ドキュメントの作成
イメージを含む単一の HTML ファイルとして HTML ドキュメントを作成します。この例では、MyImage.jpg
ファイルおよび myHTMLTemplate.htmt
HTML テンプレート ファイルがあることを前提としています。
その出力が単一の HTML ファイルであり、テンプレート myHTMLTemplate
を使用するドキュメントを作成します。レポートにテキストとイメージを追加します。ドキュメントを閉じて表示します。
import mlreportgen.dom.*; d = Document("mydoc","html-file","myHTMLTemplate.htmt"); open(d); append(d,"Hello world"); append(d,Image("C:/images/LocalSystem/MyImage.jpg")); close(d); rptview(d);
バージョン履歴
R2014b で導入R2024a: DOM API での脚注と文末脚注のサポート
DOM API は、脚注 mlreportgen.dom.Footnote
と文末脚注 mlreportgen.dom.Endnote
の両方をサポートします。これらのオプションについては、mlreportgen.dom.FootnoteOptions
クラスと mlreportgen.dom.EndnoteOptions
クラスを使用して設定します。脚注も文末脚注も、番号付けとスタイルの両方をカスタマイズできます。脚注と文末脚注は、Microsoft Word および PDF の出力形式で使用できます。
MATLAB コマンド
次の MATLAB コマンドに対応するリンクがクリックされました。
コマンドを MATLAB コマンド ウィンドウに入力して実行してください。Web ブラウザーは MATLAB コマンドをサポートしていません。
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)