mlreportgen.dom.PageBreakBefore クラス

名前空間: mlreportgen.dom

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

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

説明

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

このクラスは、以下の MATLAB® Report Generator™ 出力形式にのみ対応しています。

  • "docx"

  • "pdf"

  • "pdfa" (R2025a 以降)

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

作成

説明

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

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

例

入力引数

すべて展開する

新しいページで段落を開始するかどうか。logical の 1 (true) または 0 (false) として指定します。指定内容は以下のとおりです。

  • 1 (true) — 新しいページで段落を開始する。

  • 0 (false) — 現在のページで段落を開始できるようにする。

データ型: logical

プロパティ

すべて展開する

新しいページで段落を開始するかどうか。logical の 1 (true) または 0 (false) として指定します。指定内容は以下のとおりです。

  • 1 (true) — 新しいページで段落を開始する。

  • 0 (false) — 現在のページで段落を開始できるようにする。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: logical

タグ。文字ベクトルまたは 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

例

すべて折りたたむ

スクリプトを開く

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

参考

|

トピック