mlreportgen.dom.PageNumber クラス

名前空間: mlreportgen.dom

ページ番号の書式設定

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

説明

Word のページ レイアウトにおけるページ番号の初期値と、ローマ数字などの番号の種類を指定します。このプロパティは、DOCXPageLayout オブジェクトまたは PDFPageLayout オブジェクトのスタイルとして設定します。この書式の効果を確認するには、mlreportgen.dom.Page を使用してページ レイアウト オブジェクトにページ番号を挿入します。

このオブジェクトを使用すると、[章番号]–[ページ番号] の形式で複合ページ番号を作成できます。区切り文字も指定できます。例については、Microsoft Word での複雑なページ番号の追加を参照してください。カスタム フッターでページ番号を使用するには、ページのヘッダーとフッターの作成を参照してください。

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

  • "docx"

  • "pdf"

  • "pdfa" (R2025a 以降)

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

作成

説明

pgnum = PageNumber は、前のページから続く数値のページ番号を指定します。

pgnum = PageNumber(number) は、指定された数値に初期値を設定します。

pgnum = PageNumber(number,format) は、ローマ数字など、指定された種類の数値を使用します。

例

入力引数

すべて展開する

このレイアウトにおける最初のページ番号。正の整数として指定します。

使用するページ番号の種類。次の値のいずれかとして指定します。

値意味DOCX でサポートPDF でサポート
"a"小文字アルファベットはいはい
"A"大文字アルファベットはいはい
"i"小文字ローマ数字はいはい
"I"大文字ローマ数字はいはい
"n", "N", "1", "decimal"アラビア数字はいはい
"numberInDash"両側ダッシュ付き数字はいいいえ
"hebrew1"ヘブライ数字はいいいえ
"hebrew2"ヘブライ文字はいいいえ
"arabicAlpha"アラビア文字はいいいえ
"arabicAbjad"アラビア文字記数法はいいいえ
"thaiLetters"タイ文字はいいいえ
"thaiNumbers"タイ数字 はいいいえ
"thaiCounting"タイ語助数詞はいいいえ

プロパティ

すべて展開する

このレイアウトにおける最初のページ番号の値。正の整数として指定します。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: double

使用するページ番号の種類。次の表のいずれかの値を文字ベクトルまたは string スカラーとして指定します。

値意味DOCX でサポートPDF でサポート
"a"小文字アルファベットはいはい
"A"大文字アルファベットはいはい
"i"小文字ローマ数字はいはい
"I"大文字ローマ数字はいはい
"n", "N", "1", "decimal"アラビア数字はいはい
"numberInDash"両側ダッシュ付き数字はいいいえ
"hebrew1"ヘブライ数字はいいいえ
"hebrew2"ヘブライ文字はいいいえ
"arabicAlpha"アラビア文字はいいいえ
"arabicAbjad"アラビア文字記数法はいいいえ
"thaiLetters"タイ文字はいいいえ
"thaiNumbers"タイ数字 はいいいえ
"thaiCounting"タイ語助数詞はいいいえ

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

章番号とページ番号を区切るために使用する文字。次の値のいずれかとして指定します。

  • "colon" または ";" — コロン。

  • "hyphen" または "-" — ハイフン。

  • "emdash" — Em ダッシュ (—)。

  • "endash" — En ダッシュ (–)。

  • "period" または "." — ピリオド。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

章で使用される見出しスタイルのレベル。正の整数の文字ベクトルまたは string スカラーとして指定します。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

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

例

すべて折りたたむ

スクリプトを開く

この例では、PageNumber を使う際の構文を示します。PageNumber は、現在のページレイアウトにスタイルとして設定します。ページ番号を有効にするには、Page を使用してページのフッターまたはヘッダーにページ番号を挿入し、Word テンプレートで複数レベルのリスト スタイルを使用する必要があります。完全な例については、Microsoft Word での複雑なページ番号の追加を参照してください。

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

open(d);
layout = d.CurrentPageLayout;

% Start on page 7 and use roman numerals
pagenumber = PageNumber(7,'I');

% Add page number object to page layout styles
layout.Style = [layout.Style {pagenumber}];

% Create the footer and add a page number to it
myfooter = DOCXPageFooter();
para = Paragraph();
para.HAlign = 'center';
append(para,Page());

% Add the page number to the footer
append(myfooter,para);
layout.PageFooters = myfooter;

% Add content
append(d,'Hello World');

close(d);
rptview(d);

バージョン履歴

R2016a で導入

参考

| | | |

トピック