このページの内容は最新ではありません。最新版の英語を参照するには、ここをクリックします。
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
に設定します。
プロパティ
出力ファイルまたはフォルダーのパス。文字ベクトルまたは string スカラーとして指定します。既定値は、現在のフォルダー内の untitled
という名前のファイルまたはフォルダーへのパスです。パスは、"C:/myreports/reportA.docx"
のように、絶対パスで指定できます。また、"reportA"
のように、現在の MATLAB フォルダーからの相対パスで指定することもできます。ファイル拡張子を指定しない場合、DOM はドキュメントの Type
プロパティに基づいて拡張子を追加します。このプロパティは、ドキュメントを開く前にのみ設定できます。
OutputPath
がファイルとフォルダーのどちらのパスを指定するかは、以下の表に示すように、PackageType
プロパティの値によって決まります。
PackageType | OutputPath の値 |
---|---|
"zipped" または "single-file" | zip ファイルまたは単一のファイルのパスと名前 |
"unzipped" | 未圧縮ファイルのフォルダー |
"both" | zip ファイルのパスと名前、および未圧縮ファイルのフォルダー |
メモ
MATLAB® Drive™ や Microsoft OneDrive™ などのクラウド ドライブで PDF レポートを生成すると、レポート生成ソフトウェアとクラウド ドライブ同期ソフトウェアとの間でファイルの競合が発生し、次のようなエラーが発生する可能性があります。
Error closing document package: Could not commit changes: removeAll failed: fl:filesystem:AccessDenied: C:\Users\jdoe\OneDrive\Documents\MATLAB\reports\temp_FO\stylesheets: Permission denied.
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
データ型: char
| string
生成されたファイルに使用されるパッケージ化。次の値のいずれかとして指定します。
値 | サポートされているレポート タイプ | 説明 |
---|---|---|
|
|
|
"unzipped" |
|
|
"both" |
| 圧縮した出力と未圧縮の出力を生成します。 |
"single-file" |
| レポートを単一のファイルとして生成します。 |
ヒント
Type
プロパティが "html"
または "html-multipage"
(R2024a 以降) の場合、解凍せずに開くことができる HTML レポートを生成するには、PackageType
を "unzipped"
または "both"
に設定します。生成されたファイルがあるフォルダーで root.html
ファイルを開きます。
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
データ型: char
| string
既存の出力ファイルを上書きするかどうか。true
または false
として指定します。既存の出力ファイルを同じ名前で上書きするには、このプロパティを true
に設定します。このプロパティが false
で、同じ名前の書き込み可能ファイルが存在する場合、このドキュメントを閉じるときにエラーが発生します。既存のファイルが読み取り専用の場合は、このプロパティの設定にかかわらず、このドキュメントを閉じるときにエラーが発生します。
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
データ型: logical
出力をディスクにストリーミングするためのオプション。true
または false
として指定します。既定では、ドキュメントが閉じられるまでは、メモリにドキュメント要素が格納されます。ドキュメントに要素が追加されたときにドキュメント要素をディスクに書き込むには、このプロパティを true
に設定します。
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
データ型: logical
HTML ブラウザーのタイトル バーのテキスト。文字ベクトルまたは string スカラーとして指定します。HTML ドキュメントの場合、このプロパティは、このドキュメントを表示するのに使用されるブラウザーのタイトル バーに表示されるテキストを指定します。Word ドキュメントと PDF ドキュメントの場合、このプロパティは無視されます。
このプロパティは、ドキュメントを開く前に設定します。
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
データ型: char
| string
HTML ヘッダーのカスタム コンテンツ。文字ベクトルまたは string スカラーとして指定します。このプロパティの値は、ドキュメント テンプレートの head セクションで指定されたコンテンツの後、このドキュメントの <head>
要素に対して追加されます。このプロパティは、ドキュメントを開く前にのみ設定します。
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
データ型: char
| string
使用するテンプレートの絶対パス (必要に応じてファイル拡張子を含めることができる)。文字ベクトルまたは string スカラーとして指定します。ファイル拡張子は、次のいずれかの値になります。
拡張子 | ファイル タイプ |
---|---|
.htmtx | 圧縮 HTML |
.dotx | Microsoft Word |
.htmt | 単一ファイルの HTML |
.pdfx |
メモ
ドキュメントを出力用に開いた後、このプロパティを変更することはできません。
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
データ型: char
| string
出力ファイル タイプ。次の値のいずれかとして指定します。
値 | ファイル タイプ |
---|---|
"docx" | Microsoft Word |
"html" | HTML ドキュメントのテキスト、イメージ、スタイル シート、および JavaScript® ファイルを含む圧縮または未圧縮のフォルダーとしての HTML 出力 |
"html-file" | レポート用にテキスト、スタイル シート、JavaScript、およびイメージを含む単一のファイルで構成される HTML 出力 |
"html-multipage" (R2024a 以降) | 複数のページに分割された HTML ドキュメントのテキスト、イメージ、スタイル シート、および JavaScript ファイルを含む圧縮または未圧縮のフォルダーとしての HTML 出力 |
"pdf" | |
"pdfa" (R2025a 以降) | PDF/A |
TemplatePath
プロパティを使用してテンプレートを指定する場合、テンプレートは Type
プロパティと一致するものでなければなりません。
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
データ型: char
| string
ドキュメントのカレント ホールの ID。文字ベクトルまたは string スカラーとして指定します。
属性:
GetAccess | public |
SetAccess | private |
Transient | true |
NonCopyable | true |
データ型: char
| string
カレント テンプレート ホールのタイプ。"Inline"
または "Block"
として指定します。
インライン ホールは、段落要素が含むことのできるドキュメント要素 (
Text
、Image
、LinkTarget
、ExternalLink
、InternalLink
、CharEntity
、またはAutoNumber
) を対象とする。ブロック ホールは、
Paragraph
、Table
、OrderedList
、UnorderedList
、DocumentPart
、またはGroup
の要素を含むことができる。
属性:
GetAccess | public |
SetAccess | private |
Transient | true |
NonCopyable | true |
データ型: char
| string
このドキュメントの現在のページ レイアウト。mlreportgen.dom.DOCXPageLayout
オブジェクト、mlreportgen.dom.PDFPageLayout
オブジェクト、または []
として指定します。このプロパティは、Word ドキュメントと PDF ドキュメントに適用されます。Word ドキュメントの場合、この値は現在のページ レイアウトを指定する DOCXPageLayout
オブジェクトになります。PDF ドキュメントの場合、ドキュメントによってページ レイアウトが現在指定されていれば、この値は PDFPageLayout
オブジェクトになります。HTML ドキュメントの場合、この値は常に []
になります。
属性:
GetAccess | public |
SetAccess | private |
Transient | true |
NonCopyable | true |
このドキュメントが開かれているかどうかのステータス。"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
R2024a 以降
ドキュメントの文末脚注オプション。mlreportgen.dom.EndnoteOptions
オブジェクトとして指定します。EndnoteOptions
のプロパティが空の場合、ドキュメントは既定値を使用します。
メモ
ページ レイアウトで文末脚注オプションが指定されている場合、ページ レイアウトの文末脚注オプションは、ここで指定されたドキュメントの文末脚注オプションをオーバーライドします。
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
R2024a 以降
ドキュメントの脚注オプション。mlreportgen.dom.FootnoteOptions
オブジェクトとして指定します。FootnoteOptions
のプロパティが空の場合、ドキュメントは既定値を使用します。
メモ
ページ レイアウトで脚注オプションが指定されている場合、ページ レイアウトの脚注オプションは、ここで指定されたドキュメントの脚注オプションをオーバーライドします。
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
このドキュメント要素の親。ドキュメント要素として指定します。ドキュメント要素の親は 1 つでなければなりません。
属性:
SetAccess | private |
Transient | true |
NonCopyable | true |
このドキュメント要素の子。ドキュメント要素オブジェクトの配列として指定します。append
メソッドを使用して追加された要素がここに追加されます。
属性:
SetAccess | private |
Transient | true |
NonCopyable | true |
タグ。文字ベクトルまたは 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
メソッド
addHTML | ドキュメントへの HTML 文字列の追加 |
addHTMLFile | ドキュメントへの HTML ファイルのコンテンツの追加 |
append | ドキュメントへの DOM オブジェクトまたは MATLAB オブジェクトの追加 |
close | ドキュメントを閉じる |
createAutoNumberStream | Create numbering stream |
mlreportgen.dom.Document.createTemplate | DOM テンプレート ファイルの作成 |
fill | ドキュメント ホールを生成コンテンツで埋める |
getAutoNumberStream | 番号付けストリームを返す |
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 | 出力ドキュメントまたはテンプレートの OPC コア プロパティの設定 |
例
Word ドキュメントを作成し、コンテンツを追加し、Word でレポートを表示します。
import mlreportgen.dom.*; d = Document("mydoc","docx"); append(d,"Hello World"); close(d); rptview(d);
イメージを含む単一の 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 で導入DOM API およびレポート API のレポートを PDF/A 形式で出力できます。
DOM API は、脚注 mlreportgen.dom.Footnote
と文末脚注 mlreportgen.dom.Endnote
の両方をサポートします。これらのオプションについては、mlreportgen.dom.FootnoteOptions
クラスと mlreportgen.dom.EndnoteOptions
クラスを使用して設定します。脚注も文末脚注も、番号付けとスタイルの両方をカスタマイズできます。脚注と文末脚注は、Microsoft Word および PDF の出力形式で使用できます。
MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
Web サイトの選択
Web サイトを選択すると、翻訳されたコンテンツにアクセスし、地域のイベントやサービスを確認できます。現在の位置情報に基づき、次のサイトの選択を推奨します:
また、以下のリストから Web サイトを選択することもできます。
最適なサイトパフォーマンスの取得方法
中国のサイト (中国語または英語) を選択することで、最適なサイトパフォーマンスが得られます。その他の国の MathWorks のサイトは、お客様の地域からのアクセスが最適化されていません。
南北アメリカ
- América Latina (Español)
- Canada (English)
- United States (English)
ヨーロッパ
- 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)