Main Content

mlreportgen.dom.PageBreak クラス

パッケージ: mlreportgen.dom

Word または PDF レポートでの改ページ

説明

mlreportgen.dom.PageBreak を使用して、Microsoft® Word または PDF レポート内の任意の場所に改ページを挿入します。

ヒント

特定の段落の前で強制的に改ページするには mlreportgen.dom.PageBreakBefore オブジェクトを使用します。たとえば、PageBreakBefore を使用して強制的に新しいページで章を開始します。

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

クラス属性

HandleCompatible
true
ConstructOnLoad
true

作成

説明

break = mlreportgen.dom.PageBreak() は改ページ オブジェクトを作成します。

プロパティ

すべて展開する

この DOM API オブジェクトの子。DOM API オブジェクトの配列として指定します。

属性:

GetAccess
public
SetAccess
private
NonCopyable
true

この要素のカスタム属性。mlreportgen.dom.CustomAttribute オブジェクトの配列として指定します。出力形式でサポートされているカスタム属性を使用します。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

この DOM API オブジェクトの ID。文字ベクトルまたは string スカラーとして指定します。ドキュメント要素を作成するときに、DOM によってセッション固有 ID が生成されます。独自の ID を指定できます。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

この DOM API オブジェクトの親。DOM API オブジェクトとして指定します。

属性:

GetAccess
public
SetAccess
private
NonCopyable
true

ドキュメント要素の書式設定を指定する書式オブジェクト。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

スタイル シートから適用するスタイルの名前。文字ベクトルまたは string スカラーとして指定します。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

この DOM API オブジェクトのタグ。文字ベクトルまたは string スカラーとして指定します。

DOM は、このオブジェクトを作成するときに、セッション固有タグを生成します。生成されたタグの形式は CLASS:ID という形式です。ここで、CLASS はオブジェクト クラスです。ID はオブジェクトの Id プロパティの値です。独自のタグ値を指定すると、ドキュメントの生成中に問題が発生した箇所を容易に特定できるようになります。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

メソッド

すべて展開する

すべて折りたたむ

この例では、PageBreak オブジェクトを使用して、PDF レポートで改ページを挿入する方法を説明します。

長い完全修飾名を使用せずに済むよう、DOM API パッケージをインポートします。

import mlreportgen.dom.*;

Document オブジェクトを作成し、それを開きます。

d = Document("mydoc","pdf");
open(d);

見出しといくつかの段落で構成される最初のページを作成します。

h = Heading1("My First Heading");
append(d,h);
p = Paragraph("Here are some paragraphs.");
append(d,p);
for i = 1:5
append(d,clone(p));
end

PageBreak オブジェクトを使用して改ページを挿入します。

br = PageBreak();
append(d,br);

新しく作成した 2 番目のページに、いくつかの段落を追加します。

p2 = Paragraph("Here are some paragraphs after the forced page break.");
append(d,p2);
for i = 1:5
append(d,clone(p2));
end

ドキュメントを閉じて表示します。

close(d);
rptview(d);

バージョン履歴

R2016a で導入