Main Content

mlreportgen.dom.PageBreakBefore クラス

パッケージ: mlreportgen.dom

新しいページで段落を開始

このページをすべて展開する

説明

関連付けられた段落を常に新しいページで開始するように指定します。このクラスは、Microsoft® Word レポートと PDF レポートに適用されます。

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

作成

説明

pageBreakBefore = PageBreakBefore() は常に新しいページで段落を開始します。

例

pageBreakBefore = PageBreakBefore(onOff) は、onOff が true の場合に、常に新しいページで段落を開始します。

入力引数

すべて展開する

新しいページで段落を開始するオプション。次の値のいずれかとして指定します。

  • true または 1 — 新しいページで段落を開始します。

  • false または 0 — 現在のページで段落を開始できるようにします。

データ型: logical

プロパティ

すべて展開する

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

このドキュメント要素のタグ。文字ベクトルまたは string スカラーとして指定します。

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

新しいページで段落を開始するオプション。次の値のいずれかとして指定します。

  • true または 1 — 新しいページで段落を開始します。

  • false または 0 — 現在のページで段落を開始できるようにします。

データ型: logical

例

すべて折りたたむ

スクリプトを開く

この例では、PageBreakBefore プロパティを見出し段落に適用する方法を示します。この例では、プロパティを適用するために 2 つの方法を使用します。1 つ目は、値が明示的に true である PageBreakBefore オブジェクトを作成します。その後、その書式オブジェクトを見出しの Style プロパティに割り当てることができます。2 番目の方法では、PageBreakBefore オブジェクトを明示的に作成せずに、見出しオブジェクトのプロパティを設定します。

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

% Create first page text
t = Heading(1,'Document Title','Title');
h = Heading(2,'My Head','Heading1');
p = Paragraph('Hello World');

append(d,t);
append(d,h);
append(d,p);

% Create a heading paragraph h1
% Create a PageBreakBefore object and set it as a Style property on h1
h1 = Heading(2,'My Second Head','Heading1');
br = {PageBreakBefore(true)};
h1.Style = br;
p1 = Paragraph('Another page');

% Create a heading paragraph h2
% Set the h2 Style property to use PageBreakBefore set to true
h2 = Heading(2,'My Third Head','Heading1');
h2.Style = {PageBreakBefore()};
p2 = Paragraph('My third page');

append(d,h1);
append(d,p1);
append(d,h2);
append(d,p2);

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

バージョン履歴

R2014b で導入

参考

|

トピック