最新のリリースでは、このページがまだ翻訳されていません。 このページの最新版は英語でご覧になれます。

mlreportgen.dom.PageBreak クラス

パッケージ: mlreportgen.dom
スーパークラス:

改ページ オブジェクトを作成する

説明

Microsoft® Word または PDF レポートに挿入できる改ページ オブジェクトを作成します。PageBreak を使用して、レポート内の任意の場所に改ページを挿入します。

ヒント

特定の段落の前で強制的に改ページするには PageBreakBefore 形式を使用します。たとえば、PageBreakBefore を使用して強制的に新しいページで章を開始します。

構築

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

出力引数

すべて展開する

改ページ。mlreportgen.dom.PageBreak オブジェクトとして返されます。

プロパティ

すべて展開する

この読み取り専用プロパティには、このオブジェクトの子要素がリストされます。

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

このドキュメント要素の ID。文字ベクトルとして指定します。ドキュメント要素を作成するときに、DOM によってセッション固有 ID が生成されます。独自の ID を指定できます。

この読み取り専用プロパティには、このドキュメント要素の親がリストされます。

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

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

ドキュメント要素のタグ。文字ベクトルとして指定します。

セッション固有 ID は、ドキュメント要素作成の一環として生成されます。生成されたタグの形式は CLASS:ID という形式です。ここで、CLASS は要素のクラスです。ID はオブジェクトの Id プロパティの値です。タグを指定して、生成されたタグを置き換えることができます。

たとえば、ドキュメントの生成中に問題が発生した箇所の特定を容易にするために、独自のタグ値を指定できます。

メソッド

メソッド

目的

clone

このオブジェクトをコピーします。

すべて折りたたむ

この例では、PageBreak オブジェクトを PDF レポートに挿入することで強制的に改ページする方法を説明します。

import mlreportgen.dom.*;
d = Document('mydoc','pdf');
open(d);

% Create first page
h = Heading1('My First Head');
p = Paragraph('Here are some paragraphs.');
append(d,h);
append(d,p);
append(d,clone(p));
append(d,clone(p));
append(d,clone(p));
append(d,clone(p));
append(d,clone(p));

% Create and append the page break object
br = PageBreak();
append(d,br);

% Create paragraphs that appear on the page after the break
p2 = Paragraph('Here are some paragraphs after the forced page break.');
append(d,p2);
append(d,clone(p2));
append(d,clone(p2));
append(d,clone(p2));
append(d,clone(p2));

close(d);
rptview(d.OutputPath);

R2016a で導入