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 对象。

示例

属性

全部展开

`PageHeaders` — 此布局的页眉
`mlreportgen.dom.DOCXPageHeader` 对象数组

您最多可以为一个布局定义三个页眉，分别用于：

节的第一页
偶数页
奇数页

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`PageFooters` — 此布局的页脚
`mlreportgen.dom.DOCXPageFooter` 对象数组

您最多可以为一个布局定义三个页脚，分别用于：

节的第一页
偶数页
奇数页

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`FirstPageNumber` — 节的首页编号
`[]` (默认) | 整数

部分中的第一页的编号，指定为空数组或整数。要从上一节继续编号，请指定一个空数组。例如，如果上一部分的最后一页的页码为 4，则此布局的第一页的页码为 5。要从特定的页码开始此布局的页码编号，请将起始页码指定为一个整数。

注意

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

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`PageNumberFormat` — 页码类型
`[]` (默认) | 字符向量 | 字符串标量

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

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

注意

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: char | string

`EndnoteOptions` — 文档尾注选项
`[]` (默认) | `mlreportgen.dom.EndnoteOptions` 对象

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

注意

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

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`FootnoteOptions` — 文档脚注选项
`[]` (默认) | `mlreportgen.dom.FootnoteOptions` 对象

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

注意

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

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`PageMargins` — 页边距、页眉、页脚和装订线边距的大小
`mlreportgen.dom.PageMargins` 对象

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

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`PageSize` — 布局中的页面大小
`mlreportgen.dom.PageSize` 对象

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

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`PageBorder` — 布局的页面边框
`[]` (默认) | `mlreportgen.dom.PageBorder` 对象

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

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`SectionBreak` — 分节符选项
`"Next Page"` (默认) | `"Same Page"` | `"Odd Page"` | `"Even Page"`

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

"Next Page" - 从下一页开始新节。
"Same Page" - 从与当前节相同的页面开始新节。
"Odd Page" - 从奇数页开始新节。
"Even Page" - 从偶数页开始新节。

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: char | string

`RawFormats` — 不支持的布局格式的 XML 标记
`{}` (默认) | 元胞数组 | 字符向量 | 字符串标量

不支持的布局格式的 XML 标记，指定为字符向量或字符串标量元胞数组。

有关 Word 格式的 XML 标记的信息，请参阅 https://ecma-international.org/publications-and-standards/standards/ecma-376/。

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: cell | char | string

`StyleName` — 忽略此属性
不适用

该类忽略此属性。

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`Style` — 应用于布局的格式
DOM 格式对象数组

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

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`CustomAttributes` — 文档元素的自定义属性
`[]` (默认) | `mlreportgen.dom.CustomAttribute` 对象数组

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

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`Parent` — 此对象的父对象
文档元素对象

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

属性：

`GetAccess`	`public`
`SetAccess`	`private`
`NonCopyable`	`true`

`Children` — 此对象的子对象
文档元素对象数组

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

属性：

`GetAccess`	`public`
`SetAccess`	`private`
`NonCopyable`	`true`

`Tag` — 标记
字符向量 | 字符串标量

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

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: char | string

`Id` — 目标标识符
字符向量 | 字符串标量

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

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: char | string

方法

全部展开

公共方法

rotate

rotate(pageLayoutObj) 在纵向和横向之间切换页面的方向。该方法切换与 pageLayoutObj 的 Height 属性关联的 PageSize 对象的 Width 和 PageSize 属性的值。该方法还将 PageSize 对象的 Orientation 属性的值在 "portrait" 和 "landscape" 之间切换。

示例

全部折叠

更改文档节的页边距

打开实时脚本

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

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 英寸且为纵向的页面。要将方向更改为横向，请使用 rotate 对象的 DOCXPageLayout 方法。该方法更新关联的 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);

在 Microsoft Word 文档中添加和自定义页码

打开实时脚本

此示例显示如何在生成的 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 中推出

另请参阅

主题

报告格式化方法

mlreportgen.dom.DOCXPageLayout 类

描述

类属性

创建对象

描述

属性

PageHeaders — 此布局的页眉 mlreportgen.dom.DOCXPageHeader 对象数组

属性：

PageFooters — 此布局的页脚 mlreportgen.dom.DOCXPageFooter 对象数组

属性：

FirstPageNumber — 节的首页编号 [] (默认) | 整数

属性：

PageNumberFormat — 页码类型 [] (默认) | 字符向量 | 字符串标量

属性：

EndnoteOptions — 文档尾注选项 [] (默认) | mlreportgen.dom.EndnoteOptions 对象

属性：

FootnoteOptions — 文档脚注选项 [] (默认) | mlreportgen.dom.FootnoteOptions 对象

属性：

PageMargins — 页边距、页眉、页脚和装订线边距的大小 mlreportgen.dom.PageMargins 对象

属性：

PageSize — 布局中的页面大小 mlreportgen.dom.PageSize 对象

属性：

PageBorder — 布局的页面边框 [] (默认) | mlreportgen.dom.PageBorder 对象

属性：

SectionBreak — 分节符选项 "Next Page" (默认) | "Same Page" | "Odd Page" | "Even Page"

属性：

RawFormats — 不支持的布局格式的 XML 标记 {} (默认) | 元胞数组 | 字符向量 | 字符串标量

属性：

StyleName — 忽略此属性 不适用

属性：

Style — 应用于布局的格式 DOM 格式对象数组

属性：

CustomAttributes — 文档元素的自定义属性 [] (默认) | mlreportgen.dom.CustomAttribute 对象数组

属性：

Parent — 此对象的父对象 文档元素对象

属性：

Children — 此对象的子对象 文档元素对象数组

属性：

Tag — 标记 字符向量 | 字符串标量

属性：

Id — 目标标识符 字符向量 | 字符串标量

属性：

方法

公共方法

示例

更改文档节的页边距

更改页面方向

在 Microsoft Word 文档中添加和自定义页码

版本历史记录

另请参阅

主题

`PageHeaders` — 此布局的页眉
`mlreportgen.dom.DOCXPageHeader` 对象数组

`PageFooters` — 此布局的页脚
`mlreportgen.dom.DOCXPageFooter` 对象数组

`FirstPageNumber` — 节的首页编号
`[]` (默认) | 整数

`PageNumberFormat` — 页码类型
`[]` (默认) | 字符向量 | 字符串标量

`EndnoteOptions` — 文档尾注选项
`[]` (默认) | `mlreportgen.dom.EndnoteOptions` 对象

`FootnoteOptions` — 文档脚注选项
`[]` (默认) | `mlreportgen.dom.FootnoteOptions` 对象

`PageMargins` — 页边距、页眉、页脚和装订线边距的大小
`mlreportgen.dom.PageMargins` 对象

`PageSize` — 布局中的页面大小
`mlreportgen.dom.PageSize` 对象

`PageBorder` — 布局的页面边框
`[]` (默认) | `mlreportgen.dom.PageBorder` 对象

`SectionBreak` — 分节符选项
`"Next Page"` (默认) | `"Same Page"` | `"Odd Page"` | `"Even Page"`

`RawFormats` — 不支持的布局格式的 XML 标记
`{}` (默认) | 元胞数组 | 字符向量 | 字符串标量

`StyleName` — 忽略此属性
不适用

`Style` — 应用于布局的格式
DOM 格式对象数组

`CustomAttributes` — 文档元素的自定义属性
`[]` (默认) | `mlreportgen.dom.CustomAttribute` 对象数组

`Parent` — 此对象的父对象
文档元素对象

`Children` — 此对象的子对象
文档元素对象数组

`Tag` — 标记
字符向量 | 字符串标量

`Id` — 目标标识符
字符向量 | 字符串标量