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

mlreportgen.dom.WhiteSpace 类

命名空间: mlreportgen.dom

空白类型

全页展开

描述

指定文本中空白和换行符的行为。

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

创建对象

描述

ws = WhiteSpace(option) 将指定的空白选项应用于 Text 或 Paragraph 对象中的空白。对于 PDF，您只能为 WhiteSpace 对象指定 Paragraph。

示例

输入参量

全部展开

空白行为，指定为这些值之一。

注意

只有 "preserve" 和 "normal" 影响 Word 输出。

值描述

"normal"（默认值）

对于 HTML 和 PDF，删除前导和尾随空格并将文本内的多个空白折叠为一个空白，忽略换行符。

对于 Word，删除前导和尾随空格，忽略换行符。

"nowrap"

一系列的空白合并为一个单独的空白。文本不会换到下一行。文本继续在同一行上，直到遇到 <br /> 标记。

"pre"

保留空白。文本仅在换行处换行。作用类似于 HTML 中的 <pre> 标记。

"preserve"

保留空格和换行符。

"pre-line"

一系列的空白合并为一个单独的空白。文本在必要时换行和换行。

"pre-wrap"

保留空白。文本在必要时换行和换行。

属性

全部展开

如何处理文本中的空白和换行符，指定为此表中的一个值。当 WhiteSpace 对象的 Type 属性为 PDF 时，Document 属性不适用。

值描述支持的输出类型

"normal"

对于 HTML 和 PDF，此值会删除文本开头和结尾的空白。文本中的多个空白折叠为一个空白。

对于 Microsoft® Word，此值将删除文本开头和结尾的空白。

全部

"nowrap"

一系列的空白合并为一个单独的空白。文本永远不会换到下一行。

HTML

"pre"

保留空白。文本仅在换行处换行。作用类似于 HTML 中的 <pre> 标记。

HTML 和 PDF

"preserve"

与 "pre" 相同。全部

"pre-line"

一系列的空白合并为一个单独的空白。文本在必要时换行和换行。

HTML 和 PDF

"pre-wrap"

保留空白。文本在必要时换行和换行。

HTML 和 PDF

注意

设置 WhiteSpace 属性会将相应的 mlreportgen.dom.WhiteSpace 格式对象添加到 Style 属性。将 WhiteSpace 属性设置为空值将删除该对象。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

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

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

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

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

示例

全部折叠

打开实时脚本

此示例显示了在每种输出格式中使用 "preserve" 选项的效果。保留尾随空格很有用，例如，当您创建章节标题时。通常，您在文本 "Chapter: " 之后添加一个自动编号。使用 "preserve" 可保留尾随空格。

HTML 输出

当您选择 HTML 作为输出格式时，多个空格会折叠，但尾随空格会保留。 

import mlreportgen.dom.*;
doctype = "html";
d = Document("testHTML",doctype);
open(d);
     
p = Paragraph(...
    "This paragraph has extra spaces    and one after the colon: ");
% p.Style = {WhiteSpace("preserve")};

append(p,"XX");
append(d,p);
     
close(d);
rptview(d.OutputPath);

Word 输出

当您选择 Word 作为输出格式时，多个空格不会折叠，并且尾随空格会被保留。尝试注释掉 WhiteSpace 属性。多个空格被保留，但冒号后的尾随空格被删除。

import mlreportgen.dom.*;
doctype = "docx";
d = Document("test",doctype);
open(d);
     
p = Paragraph(...
    "This paragraph has extra spaces    and one after the colon: ");
p.Style = {WhiteSpace("preserve")};

append(p,"XX");
append(d,p);
     
close(d);
rptview(d.OutputPath);

PDF 输出

第二个代码块的描述

import mlreportgen.dom.*;
doctype = "pdf";
d = Document("test",doctype);
open(d);
     
p = Paragraph(...
    "This paragraph has extra spaces    and one after the colon: ");
p.Style = {WhiteSpace("preserve")};

append(p,"XX");
append(d,p);
     
close(d);
rptview(d.OutputPath);

版本历史记录

在 R2014b 中推出

另请参阅

|

主题