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 は改ページ オブジェクトを作成します。

プロパティ

すべて展開する

スタイル名。文字ベクトルまたは string スカラーとして指定します。スタイル名は、この要素を追加するドキュメントまたはドキュメント パーツのスタイル シートで指定したスタイルの名前です。指定されたスタイルは、この要素の Style プロパティで指定された書式によってオーバーライドされない限り、出力ドキュメントでのこの要素の外観を定義します。スタイル シートの使用の詳細については、スタイル シートのスタイルの使用を参照してください。

メモ

Microsoft Word 出力ではスタイル名が無視されます。

属性:

NonCopyable
true

データ型: char | string

このドキュメント要素オブジェクトの書式指定。書式オブジェクトの配列として指定します。このプロパティで指定された書式は、この要素の StyleName プロパティで指定された対応する書式をオーバーライドします。この要素に適用されない書式は無視されます。

属性:

NonCopyable
true

データ型: cell

このドキュメント要素のカスタム属性。mlreportgen.dom.CustomAttribute オブジェクトの配列として指定します。カスタム属性は、このオブジェクトが追加されるドキュメント要素の出力形式でサポートされていなければなりません。

属性:

NonCopyable
true

mlreportgen.dom.PageBreak オブジェクトの親。ドキュメント要素オブジェクトとして指定します。ドキュメント要素の親は 1 つでなければなりません。

属性:

SetAccess
private
NonCopyable
true

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

属性:

SetAccess
private
NonCopyable
true

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

属性:

NonCopyable
true

データ型: char | string

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

属性:

NonCopyable
true

データ型: char | string

メソッド

すべて展開する

例

すべて折りたたむ

ライブ スクリプトを開く

この例では、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 で導入

参考

| | | |

トピック