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

mlreportgen.dom.Watermark 类

命名空间: mlreportgen.dom

在 PDF 报告各个节的页面上添加水印

全页展开

描述

创建一个水印对象，您可以将其添加到 PDF 报告的一个节。水印是出现在页面背景中的图像，例如字样草稿或机密。它会在您应用它的每个页面上的文本后面运行。您可以使用以下任意文件类型：

  • .emf

  • .gif

  • .jpg

  • .pdf

  • .png

  • .svg

  • .tiff

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

创建对象

描述

wm = Watermark(image) 根据指定的图像创建一个 Watermark 对象，并返回一个 Watermark 对象。

示例

输入参量

全部展开

用作水印的图像，指定为图像路径名。使用以下任意文件类型：

  • .emf

  • .gif

  • .jpg

  • .pdf

  • .png

  • .svg

  • .tiff

属性

全部展开

图像文件的路径，指定为字符向量或字符串标量。

属性：

GetAccess
public
SetAccess
private
NonCopyable
true
Transient
true

数据类型: char | string

水印高度，指定为字符向量或字符串标量，其中包含一个数字，后跟一个测量单位的缩写。例如，"10px" 指定 10 像素。有效的缩写是：

  • "px" - 像素

  • "cm" - 厘米

  • "in" - 英寸

  • "mm" - 毫米

  • "pc" - 派卡

  • "pt" - 磅

或者，您可以使用 Watermark.Style 属性指定高度。例如：

Watermark.Style = {Height("4in")};

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

水印宽度，指定为字符向量或字符串标量，包含一个数字后跟一个测量单位的缩写。例如，"10px" 指定 10 像素。有效的缩写是：

  • "px" - 像素

  • "cm" - 厘米

  • "in" - 英寸

  • "mm" - 毫米

  • "pc" - 派卡

  • "pt" - 磅

或者，您可以使用 Watermark.Style 属性指定宽度。例如：

Watermark.Style = {Width("4in")};

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

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

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

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

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

标记，指定为字符向量或字符串标量。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

示例

全部折叠

打开脚本

此示例显示如何以编程方式创建水印，然后将其应用于当前布局。以编程方式创建水印简化了文件管理，因为您不需要存储图像文件并跟踪其位置。

使用 MATLAB® 命令，以编程方式创建图像文件。使用 SVG 图像文件可以在图像缩放时保持分辨率。将图像写入文件后，您可以删除该图窗。

 wmname = 'wm';
 wmtype =  'svg';
 wmfilename = [wmname '.' wmtype];

 subplot('Position',[0, 0, 1, 1]);
 axis('off');
 text(0.25, 0.25,'Draft', ...
   'Rotation', 45, ...
   'Color', [0.85, 0.85, 0.85], ...
   'FontSize',72);

  print(wmfilename, ['-d' wmtype]);
  delete(gcf);

创建水印对象 wm 并将其应用于当前页面布局。生成报告后，您可以删除变量 wmfilename 指定的图像文件。

import mlreportgen.dom.*;

d = Document('myreport','pdf');
open(d);

wm = Watermark(wmfilename);
wm.Width = '12in';
wm.Height = [];

d.CurrentPageLayout.Watermark = wm;

append(d,'Hello');
append(d, PageBreak);
append(d,'World');

close(d);
rptview(d.OutputPath);
delete(wmfilename);

版本历史记录

在 R2016b 中推出

全部展开

另请参阅

主题