Main Content

mlreportgen.dom.Page クラス

パッケージ: mlreportgen.dom

ページ番号のプレースホルダーの作成

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

説明

ページ番号のプレースホルダーを作成します。このオブジェクトは、Word 出力や PDF 出力にのみ適用されます。Word 出力の場合、Word ドキュメントを開くと、Word はこのオブジェクトを現在のページ番号に置き換えます。PDF 出力の場合、DOM API は、ドキュメントの書き込み時にこのオブジェクトを現在のページ番号に置き換えます。

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

作成

説明

例

PageNum = Page() は、現在のページ番号のオブジェクトを作成します。

プロパティ

すべて展開する

このドキュメント要素の子。DOM オブジェクトの配列として指定します。このプロパティは読み取り専用です。

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

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

このドキュメント要素の親。DOM オブジェクトとして指定します。このプロパティは読み取り専用です。

属性:

GetAccess
public
SetAccess
private
NonCopyable
true

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

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

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

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

例

すべて折りたたむ

スクリプトを開く

この例では、mlreportgen.dom.Page を使用して、ドキュメントのフッターに現在のページ番号を挿入します。

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

% Create page footer
footer = PDFPageFooter('default');
d.CurrentPageLayout.PageFooters = footer;

% Define page number string and add to footer.
d.CurrentPageLayout.FirstPageNumber = 1;
t = Text('Page ');
pageinfo = Paragraph();
pageinfo.WhiteSpace = 'preserve';
pageinfo.HAlign = 'center';
append(pageinfo,t);
append(pageinfo,Page());
append(footer,pageinfo);

% Create several pages.
p = Paragraph('Hello World');
append(d,p);
p = Paragraph('Another page');
p.Style = {PageBreakBefore(true)};
append(d,p);
append(d,clone(p));

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

バージョン履歴

R2016a で導入

参考

| | |

トピック