mlreportgen.dom.DOCXPageHeader 类

命名空间: mlreportgen.dom

Microsoft Word 文档的页眉定义

全页展开

描述

将页眉添加到节中的第一页或奇数页、偶数页或两者。

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

创建对象

描述

docxHeader = DOCXPageHeader 根据默认的 Word 模板创建页眉。

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

docxHeader = DOCXPageHeader(pageType,templatePath) 根据指定的模板为指定类型的页面创建页眉。

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

docxHeader = DOCXPageHeader(pageType,templateSrc,docPartTemplateName) 根据指定源使用的指定文档部件模板，为指定类型的页面创建页眉。源可以是文档或文档部件。

输入参量

全部展开

`pageType` — 页眉出现的页面类型
`[]` (默认) | `default` | `first` | `even`

页眉所显示的类型，指定为以下值之一：

default - 节中奇数页的页眉，如果您未指定偶数页页眉，则为偶数页的页眉，如果您未指定首页页眉，则为首页的页眉。
first - 节中第一页的页眉。
even - 节中偶数页的页眉。

例如，若要使节中第一页显示空白页眉，而其他页面显示不同的页眉，请定义两个页眉，一个将 pageType 设置为 first，另一个将 pageType 设置为 default。

`templatePath` — 页眉模板的完整路径
字符向量 | 字符串标量

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

数据类型: char | string

`docPartTemplateName` — 文档部件模板名称
字符向量

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

`templateSrc` — 包含文档部件模板的文档或文档部件
`mlreportgen.dom.Document` 对象 | `mlreportgen.dom.DocumentPart` 对象

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

属性

全部展开

`CurrentHoleId` — 文档中当前空位的 ID
`""` (默认) | 字符向量 | 字符串标量

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

属性：

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

数据类型: char | string

`CurrentHoleType` — 当前空位类型
`""` (默认) | `"Inline"` | `"Block"`

当前模板空位的类型，指定为 "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

`CurrentPageLayout` — 本文档的当前页面布局
`[]` (默认) | `mlreportgen.dom.DOCXPageLayout` 对象 | `mlreportgen.dom.PDFPageLayout` 对象 | `[]`

该文档的当前页面布局，指定为 mlreportgen.dom.DOCXPageLayout 对象、mlreportgen.dom.PDFPageLayout 对象或 []。此属性适用于 Word 和 PDF 文档。对于 Word 文档，该值是一个指定当前页面布局的 DOCXPageLayout 对象。对于 PDF 文档，如果文档当前指定了页面布局，则该值为 PDFPageLayout 对象。对于 HTML 文档，该值始终为 []。

属性：

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

`PageType` — 页眉出现的页面类型
`[]` (默认) | `"default"` | `"first"` | `"even"`

页眉所显示的类型，指定为以下值之一：

"default" - 节中奇数页的页眉，如果您未指定偶数页页眉，则为偶数页的页眉，如果您未指定首页页眉，则为首页的页眉。
"first" - 节中第一页的页眉。
"even" - 节中偶数页的页眉。

例如，要在第一页上显示空白页眉，并在其他页面上显示不同的页眉，请定义两个页眉，一个将 pageType 设置为 "first"，另一个将 pageType 设置为 "default"。

属性：

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

数据类型: char | string

`TemplatePath` — 页眉模板的完整路径
字符向量 | 字符串标量

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

属性：

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

数据类型: char | string

`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

方法

全部展开

公共方法

使用 DOCXPageHeader 方法就像使用相应的 Document 方法一样。

方法	用途
`append`	将其中一个 DOM 对象追加到页眉： `CustomElement` `DOCXPageLayout` `FormalTable` `Group` `ExternalLink` `Image` `InternalLink` `OrderedList` `Paragraph` `RawText` `Table` `Text` `UnorderedList`
`close`	关闭页眉。
`fill`	填补模板空位。
`moveToNextHole`	移至下一个模板空位。
`open`	打开页眉。

版本历史记录

在 R2014b 中推出

另请参阅

mlreportgen.dom.DOCXPageFooter | mlreportgen.dom.DOCXPageLayout | mlreportgen.dom.PDFPageHeader | mlreportgen.dom.PDFPageFooter | mlreportgen.dom.PDFPageLayout

主题

创建页脚和页眉

mlreportgen.dom.DOCXPageHeader 类

描述

创建对象

描述

输入参量

pageType — 页眉出现的页面类型 [] (默认) | default | first | even

templatePath — 页眉模板的完整路径 字符向量 | 字符串标量

docPartTemplateName — 文档部件模板名称 字符向量

templateSrc — 包含文档部件模板的文档或文档部件 mlreportgen.dom.Document 对象 | mlreportgen.dom.DocumentPart 对象

属性

CurrentHoleId — 文档中当前空位的 ID "" (默认) | 字符向量 | 字符串标量

属性：

CurrentHoleType — 当前空位类型 "" (默认) | "Inline" | "Block"

属性：

CurrentPageLayout — 本文档的当前页面布局 [] (默认) | mlreportgen.dom.DOCXPageLayout 对象 | mlreportgen.dom.PDFPageLayout 对象 | []

属性：

PageType — 页眉出现的页面类型 [] (默认) | "default" | "first" | "even"

属性：

TemplatePath — 页眉模板的完整路径 字符向量 | 字符串标量

属性：

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

属性：

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

属性：

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

属性：

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

属性：

方法

公共方法

版本历史记录

另请参阅

主题

`pageType` — 页眉出现的页面类型
`[]` (默认) | `default` | `first` | `even`

`templatePath` — 页眉模板的完整路径
字符向量 | 字符串标量

`docPartTemplateName` — 文档部件模板名称
字符向量

`templateSrc` — 包含文档部件模板的文档或文档部件
`mlreportgen.dom.Document` 对象 | `mlreportgen.dom.DocumentPart` 对象

`CurrentHoleId` — 文档中当前空位的 ID
`""` (默认) | 字符向量 | 字符串标量

`CurrentHoleType` — 当前空位类型
`""` (默认) | `"Inline"` | `"Block"`

`CurrentPageLayout` — 本文档的当前页面布局
`[]` (默认) | `mlreportgen.dom.DOCXPageLayout` 对象 | `mlreportgen.dom.PDFPageLayout` 对象 | `[]`

`PageType` — 页眉出现的页面类型
`[]` (默认) | `"default"` | `"first"` | `"even"`

`TemplatePath` — 页眉模板的完整路径
字符向量 | 字符串标量

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

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

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

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