本页采用了机器翻译。点击此处可查看最新英文版本。

mlreportgen.dom.PageNumber 类

命名空间: mlreportgen.dom

设置页码格式

全页展开

描述

指定 Word 页面布局中页码的初始值和数值类型，例如罗马数字。将此属性设置为 DOCXPageLayout 或 PDFPageLayout 对象上的样式。使用 mlreportgen.dom.Page 在页面布局对象中插入页码以查看此格式的效果。

该对象使您能够以 [章节号]-[页码] 的形式创建复合页码并指定分隔符。相关示例，请参阅在 Microsoft Word 中添加复杂页码。

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"阿拉伯 abjad 数字是否
"thaiLetters"泰语字母是否
"thaiNumbers"泰语数字 是否
"thaiCounting"泰国计数系统是否

属性

全部展开

用于分隔章节号和页码的字符，指定为以下值之一：

  • "colon" 或 ";" - 冒号。

  • "hyphen" 或 "-" - 连字符。

  • "emdash" - 长破折号 (—)。

  • "endash" - 短破折号 (–)。

  • "period" 或 "." - 句号。

章节使用的标题样式的级别，指定为正整数字符向量。

要使用的页码类型，指定为表中的字符向量或字符串标量之一。

值含义支持 DOCX支持 PDF
"a"小写字母是是
"A"大写字母是是
"i"小写罗马数字是是
"I"大写罗马数字是是
"n", "N", "1", "decimal"阿拉伯数字是是
"numberInDash"两边带有短横线的数字是否
"hebrew1"希伯来数字是否
"hebrew2"希伯来字母是否
"arabicAlpha"阿拉伯字母是否
"arabicAbjad"阿拉伯 abjad 数字是否
"thaiLetters"泰语字母是否
"thaiNumbers"泰语数字 是否
"thaiCounting"泰国计数系统是否

目标标识符，指定为字符向量或字符串标量。DOM API 在创建文档元素对象时会生成一个会话唯一标识符。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

此布局中首页页码的值，指定为正整数。

标记，指定为字符向量或字符串标量。DOM API 在创建此对象的过程中生成一个会话唯一标记。生成的标记形式为 CLASS:ID，其中 CLASS 是对象类，ID 是对象的 Id 属性的值。使用此值来帮助确定在文档生成过程中出现的问题的位置。

属性：

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 中推出

另请参阅

| | | |

主题