Main Content

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

mlreportgen.dom.DOCXPageLayout 类

命名空间: mlreportgen.dom

Microsoft Word 文档节的页面格式和布局

全页展开

描述

使用 mlreportgen.dom.DOCXPageLayout 对象定义 Microsoft® Word 文档节的页面格式、页眉和页脚。

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

类属性

HandleCompatible
true
ConstructOnLoad
true

有关类属性的信息，请参阅类属性。

创建对象

描述

示例

pageLayoutObj = mlreportgen.dom.DOCXPageLayout 创建一个具有默认属性值的 DOCXPageLayout 对象。

属性

全部展开

此布局的页眉，指定为 mlreportgen.dom.DOCXPageHeader 对象的数组。您最多可以为一个布局定义三个页眉，分别用于：

  • 节的第一页

  • 偶数页

  • 奇数页

属性：

NonCopyable
true

此布局的页脚，指定为 mlreportgen.dom.DOCXPageFooter 对象的数组。您最多可以为一个布局定义三个页脚，分别用于：

  • 节的第一页

  • 偶数页

  • 奇数页

属性：

NonCopyable
true

节中第一页的编号，指定为整数。

注意

页码仅呈现在您追加到文档或文档任何部分的 mlreportgen.dom.Page 对象上。要在页眉或页脚中呈现页码，请将 mlreportgen.dom.DOCXPageHeader 对象分配给 PageHeaders 属性，或将 mlreportgen.dom.DOCXPageFooter 对象分配给 PageFooters 属性。然后将 mlreportgen.dom.Page 对象追加到 DOCXPageHeader 或 DOCXPageFooter 对象。相关示例，请参阅 在 Microsoft ® Word 文档中添加和自定义页码。或者，您可以将 mlreportgen.dom.Page 对象追加到文档本身或文档中的元素，但页码仅呈现在追加 Page 对象的文档部件上。

属性：

NonCopyable
true

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

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

注意

页码仅呈现在您追加到文档或文档任何部分的 mlreportgen.dom.Page 对象上。要在页眉或页脚中呈现页码，请将 mlreportgen.dom.DOCXPageHeader 对象分配给 PageHeaders 属性，或将 mlreportgen.dom.DOCXPageFooter 对象分配给 PageFooters 属性。然后将 mlreportgen.dom.Page 对象追加到 DOCXPageHeader 或 DOCXPageFooter 对象。相关示例，请参阅 在 Microsoft ® Word 文档中添加和自定义页码。或者，您可以将 mlreportgen.dom.Page 对象追加到文档本身或文档中的元素，但页码仅呈现在追加 Page 对象的文档部件上。

属性：

NonCopyable
true

数据类型: char | string

文档尾注选项，指定为 mlreportgen.dom.EndnoteOptions 对象。如果 EndnoteOptions 的任何属性为空，则文档使用默认值。

注意

此属性将覆盖此页面布局所属文档指定的尾注选项。

属性：

NonCopyable
true

文档脚注选项，指定为 mlreportgen.dom.FootnoteOptions 对象。如果 FootnoteOptions 的任何属性为空，则文档使用默认值。

注意

此属性将覆盖此页面布局所属文档所指定的脚注选项。

属性：

NonCopyable
true

不支持的布局格式的 XML 标记，指定为字符向量元胞数组。有关 Word 格式的 XML 标记的信息，请参阅 https://ecma-international.org/publications-and-standards/standards/ecma-376/。

属性：

NonCopyable
true

数据类型: cell

此页面布局的边距、页眉、页脚和装订线边距的大小，指定为 mlreportgen.dom.PageMargins 对象。

属性：

NonCopyable
true

此布局中的页面大小，指定为 mlreportgen.dom.PageSize 对象。

属性：

NonCopyable
true

此布局的页面边框，指定为 mlreportgen.dom.PageBorder 对象。

属性：

NonCopyable
true

分节符选项，指定为以下字符向量或字符串标量之一：

  • 'Next Page' - 从下一页开始新节。

  • 'Same Page' - 从与当前节相同的页面开始新节。

  • 'Odd Page' - 从奇数页开始新节。

  • 'Even Page' - 从偶数页开始新节。

属性：

NonCopyable
true

数据类型: char | string

该类忽略此属性。

属性：

NonCopyable
true

此文档元素的格式规范，指定为格式对象数组。不适用于此元素的格式将被忽略。

属性：

NonCopyable
true

此文档元素的自定义属性，指定为 mlreportgen.dom.CustomAttribute 对象的数组。自定义属性必须被此对象所追加到的文档元素的输出格式支持。

属性：

NonCopyable
true

mlreportgen.dom.DOCXPageLayout 对象的父级，指定为文档元素对象。一个文档元素必须只有一个父元素。

属性：

SetAccess
private
NonCopyable
true

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

属性：

SetAccess
private
NonCopyable
true

mlreportgen.dom.DOCXPageLayout 对象的标签，指定为字符向量或字符串标量。DOM API 在创建此对象的过程中生成一个会话唯一标签。生成的标签形式为 CLASS:ID，其中 CLASS 是对象类，ID 是对象的 Id 属性的值。指定您自己的标签值，以帮助您确定在文档生成过程中出现问题时要查找的位置。

属性：

NonCopyable
true

数据类型: char | string

mlreportgen.dom.DOCXPageLayout 对象的对象标识符，指定为字符向量或字符串标量。DOM API 在创建文档元素对象时会生成一个会话唯一标识符。您可以为 Id 指定自己的值。

属性：

NonCopyable
true

数据类型: char | string

方法

全部展开

示例

全部折叠

打开实时脚本

使用文档的 CurrentPageLayout 属性来访问文档的布局对象。通过设置布局对象使用的 mlreportgen.dom.PageMargins 对象的 Left 和 Right 属性来更改布局的左边距和右边距。 

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

open(d);
pageLayoutObject = d.CurrentPageLayout;
pageLayoutObject.PageMargins.Left = '2in';
pageLayoutObject.PageMargins.Right = '2in';
p = Paragraph('Hello World');
append(d,p);

close(d);
rptview(d);
打开实时脚本

默认情况下，DOCXPageLayout 对象指定高度为 11 英寸、宽度为 8.5 英寸且为纵向的页面。要将方向更改为横向，请使用 DOCXPageLayout 对象的 rotate 方法。该方法更新关联的 mlreportgen.dom.PageSize 对象的属性值，使其高度为 8.5 英寸、宽度为 11 英寸并且方向为横向。

import mlreportgen.dom.*;
d = Document('myreport','docx');
open(d);
 
pageLayoutObj = d.CurrentPageLayout;
rotate(pageLayoutObj);

append(d,'This document has landscape pages');
close(d);
rptview(d);
打开实时脚本

此示例显示如何在生成的 Word 文档的页脚部分添加和自定义页码。

导入此命名空间，这样您就不必使用长且完全限定的类名。

import mlreportgen.dom.*

创建一个具有标题的 DOCX 类型的 mlreportgen.dom.Document 对象。

document = Document("my_docx_w_page_numbers_document","docx");
heading = Heading(1,"Customize Page Numbers Example");
append(document,heading);

向文档添加内容。

append(document,LineBreak);
for pageInd = 1:5
  append(document,sprintf("Content of page number %i",pageInd));
  append(document,PageBreak);
end
append(document,Paragraph("Content of last page"));

通过将 mlreportgen.dom.DOCXPageFooter 对象分配给当前页面布局的 PageFooters 属性，向文档添加页脚。然后将当前页面布局的页码格式设置为大写罗马数字。

curLayout = document.CurrentPageLayout;
curLayout.PageFooters = DOCXPageFooter();
curLayout.PageNumberFormat = "I";

将 mlreportgen.dom.Page 对象追加到页脚对象。

append(curLayout.PageFooters,Page());

关闭并查看文档。

close(document);
rptview(document);

版本历史记录

在 R2016a 中推出

另请参阅

| | | | | | | | | | |

主题