mlreportgen.dom.KeepWithNext 类

命名空间: mlreportgen.dom

将文档元素保留在与下一页相同的页面上

全页展开

描述

使用 mlreportgen.dom.KeepWithNext 类的对象将文档元素与其后面的文档元素保留在同一页面上。此格式适用于 Microsoft^® Word 和 PDF 文档。

此类仅与以下 MATLAB^® Report Generator™ 输出类型兼容：

"docx"
"pdf"
"pdfa" (自 R2025a 起)

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

创建对象

描述

obj = KeepWithNext 将文档元素与其后面的文档元素保留在同一页面上。文档元素必须是段落、表行或列表项。

obj = KeepWithNext(onOff) 将 Value 属性设置为 onOff。

属性

全部展开

`Value` — 是否将文档元素保留在同一页面
`1` (`true`) (默认) | `0` (`false`)

是否将该文档元素保留在与后续文档元素相同的页面上，指定为逻辑值 1 (true) 或 0 (false)。当您指定：

1 (true) - 根据 Strength 属性的值，将以下文档元素保留在同一页面上。
0 (false) - 允许以下文档元素移至下一页。

属性：

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

数据类型: logical

`Strength` — 段落保持连贯的力量
`1` (默认) | `"always"` | 整数

文档元素保持在同一页面上的强度，指定为 "always" 或整数。当您将属性指定为 "always" 时，DOM 对象始终将文档元素保持在同一页面上。当您将该属性指定为正整数时，整数的大小决定了文档元素保持在一起的强度。整数越大，文档元素出现在单独页面上的可能性就越小。

属性：

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

数据类型: double

`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

版本历史记录

在 R2014b 中推出

另请参阅

mlreportgen.dom.PageBreakBefore | mlreportgen.dom.KeepLinesTogether

主题

报告格式化方法

mlreportgen.dom.KeepWithNext 类

描述

创建对象

描述

属性

Value — 是否将文档元素保留在同一页面 1 (true) (默认) | 0 (false)

属性：

Strength — 段落保持连贯的力量 1 (默认) | "always" | 整数

属性：

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

属性：

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

属性：