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

mlreportgen.dom.DOCXPageFooter 类

命名空间: mlreportgen.dom

Microsoft Word 文档的页脚定义

全页展开

描述

在 Word 文档布局的第一页、奇数页、偶数页或两者中添加页脚。

mlreportgen.dom.DOCXPageFooter 类是一个 handle 类。

创建对象

描述

docxFooter = DOCXPageFooter 根据默认的 Word 模板创建页脚。

docxFooter = DOCXPageFooter(pageType) 根据默认的 Word 模板为指定类型的页面（即奇数、偶数或第一页）创建页脚。

示例

docxFooter = DOCXPageFooter(pageType,templatePath) 根据指定的模板为指定类型的页面创建页脚。

docxFooter = DOCXPageFooter(pageType,templatePath,docPartTemplateName) 根据指定模板中的指定文档部件模板，为指定类型的页面创建页脚。

docxFooter = DOCXPageFooter(pageType,templateSrc,docPartTemplateName) 根据来自指定源的指定文档部件模板，为指定类型的页面创建页脚。源可以是文档或文档部件。

输入参量

全部展开

页脚出现的页面类型，指定为以下值之一：

  • default - 节中奇数页的页脚，如果您未指定偶数页页脚，则为偶数页，如果您未指定首页页脚，则为首页页脚。

  • first - 节中第一页的页脚。

  • even - 节中偶数页的页脚。

例如，为了使奇数页和偶数页上出现不同的页脚，可定义两个页脚。将一个设置为 pageType 为 default，将另一个设置为 even。

页脚模板的完整路径，指定为字符串标量或字符向量。

数据类型: char | string

如果该部分模板存储在由 templatePath 或 templateSrc 参量指定的模板中，则为该部分模板的名称，指定为字符向量或字符串标量。

文档或文档部件对象，其模板包含此文档部件的模板，指定为文档的 mlreportgen.dom.Document 对象或文档部件的 mlreportgen.dom.DocumentPart 对象。

属性

全部展开

此对象的子对象，指定为文档元素对象数组。此属性包含使用 append 方法追加的文档元素对象。

属性：

GetAccess
public
SetAccess
private
NonCopyable
true

此属性不适用于页脚。

属性：

GetAccess
public
SetAccess
private
Transient
true
NonCopyable
true

文档中当前空位的 ID，指定为字符向量或字符串标量。

属性：

GetAccess
public
SetAccess
private
Transient
true
NonCopyable
true

数据类型: char | string

当前模板空位的类型，指定为 "Inline" 或 "Block"。

  • 内联空位适用于段落元素可以包含的文档元素：Text、Image、LinkTarget、ExternalLink、InternalLink、CharEntity 或 AutoNumber。

  • 块状空位可以包含 Paragraph、Table、OrderedList、UnorderedList、DocumentPart 或 Group 元素。

属性：

GetAccess
public
SetAccess
private
Transient
true
NonCopyable
true

数据类型: char | string

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

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

页脚出现的页面类型，指定为以下值之一：

  • "default" - 节中奇数页的页脚，如果您未指定偶数页页脚，则为偶数页，如果您未指定首页页脚，则为首页页脚。

  • "first" - 节中第一页的页脚。

  • "even" - 节中偶数页的页脚。

为了使页脚出现在奇数页和偶数页上，请定义两个页脚，一个将 pageType 设置为 "default"，另一个将 pageType 设置为 "even"。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

此对象的父对象，指定为文档元素对象。一个文档元素必须只有一个父元素。

属性：

GetAccess
public
SetAccess
private
NonCopyable
true

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

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

页脚模板的完整路径，指定为字符串标量或字符向量。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

方法

全部展开

示例

全部折叠

打开脚本

此示例定义了 Word 文档中第一页、偶数页和奇数页的页脚。它在每个页脚中插入一个页码，并对每种页面类型使用不同的对齐方式。

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

% Create page footer objects for each type of page
% Assign a matrix of page footer objects to the current page layout
firstfooter = DOCXPageFooter('first');
evenfooter = DOCXPageFooter('even');
oddfooter = DOCXPageFooter('default');
d.CurrentPageLayout.PageFooters = [firstfooter,evenfooter,oddfooter];

% Add title to first page footer
p = Paragraph('My Document Title');
p.HAlign = 'center';
append(d.CurrentPageLayout.PageFooters(1),p);

% Add page number to even page footer
% Align even page numbers left
pg2 = Page();
p2 = Paragraph();
p2.HAlign = 'left';
append(p2,pg2);
append(d.CurrentPageLayout.PageFooters(2),p2);

% Add page number to odd page footer
% Align odd page numbers right
pg3 = Page();
p3 = Paragraph();
p3.HAlign = 'right';
append(p3,pg3);
append(d.CurrentPageLayout.PageFooters(3),p3);

% 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);

版本历史记录

在 R2014b 中推出

另请参阅

| | | |

主题