mlreportgen.dom.OPCPart 类

命名空间: mlreportgen.dom

要包含在 OPC 包中的文档部件

全页展开

描述

要包含在 OPC 包中的文档部件。

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

创建对象

描述

opcPartObj = OPCPart 创建一个空的 OPC 部件。

opcPartObj = OPCPart(name,sourcePath) 创建一个具有指定名称的部件，其源文件位于指定的路径。使用 Document.package 方法将部分追加到文档会导致源文件的副本插入到文档包中由部分名称指定的位置。

示例

输入参量

全部展开

`name` — 部件名称
字符向量

部件的名称，指定为字符向量。

`sourcePath` — 部件源文件路径
字符向量

部件的源文件路径，指定为字符向量。

属性

全部展开

`ContentType` — 部件内容类型
字符向量

使用文件扩展名指定内容类型。有关文件内容类型的列表，请参阅 https://en.wikipedia.org/wiki/Open_Packaging_Conventions。

如果您未设置此属性并且该部件属于下列类型之一，则当您将该部件追加到文档时，DOM 接口会设置内容类型。

文件类型	文件扩展名
Windows^® 位图	`.bmp`
层叠样式表	`.css`
纯文本	`.txt`
图标	`.cur`
Windows 图元文件	`.emf`
封装的 PostScript^®	`.eps`
GIF 图像	`.gif`
HTML	`.html`
JPEG 图像	`.jpe`
JPEG 图像	`.jpeg`
JPEG	`.jpg`
JavaScript^®	`.js`
JavaScript 对象表示法	`.json`
PNG 图像	`.png`
PSD	`.psd`
富文本格式	`.rtf`
可缩放矢量图	`.svg`
TIFF 图像	`.tif`
TIFF 图像	`.tiff`
TrueType 字体	`.ttf`

`Id` — `mlreportgen.dom.OPCPart` 对象的标识符
字符向量 | 字符串标量

mlreportgen.dom.OPCPart 对象的对象标识符，指定为字符向量或字符串标量。DOM API 在创建文档元素对象时会生成一个会话唯一标识符。您可以为 Id 指定自己的值。

属性：

NonCopyable true

数据类型: char | string

`Name` — 部件路径
字符向量

该部件相对于包根的路径，指定为字符向量。例如，要将名为 myimage.jpg 的图像添加到文档图像文件夹，请将路径指定为 '/images/myimage.jpg'。仅使用 ASCII 字符指定 Name。

有关 OPC 部件名称的信息，请参阅 https://en.wikipedia.org/wiki/Open_Packaging_Conventions。

`RelatedPart` — 与指定部件相关的部件的路径名
字符向量

有关 OPC 部件名称的信息，请参阅 https://en.wikipedia.org/wiki/Open_Packaging_Conventions。

`RelationshipID` — 关系 ID
字符向量

有关 OPC 关系 ID 的信息，请参阅 https://en.wikipedia.org/wiki/Open_Packaging_Conventions。

`RelationshipType` — 关系类型
字符向量

使用文件扩展名指定关系类型。有关文件内容类型的列表，请参阅 https://en.wikipedia.org/wiki/Open_Packaging_Conventions。

如果您未设置此属性并且该部件属于这些类型之一，则当您将该部件追加到文档时，DOM 接口会设置内容类型。

文件类型	文件扩展名
Windows 位图	`.bmp`
层叠样式表	`.css`
纯文本	`.txt`
图标	`.cur`
Windows 图元文件	`.emf`
封装的 PostScript	`.eps`
GIF 图像	`.gif`
HTML	`.html`
JPEG 图像	`.jpe`
JPEG 图像	`.jpeg`
JPEG	`.jpg`
JavaScript	`.js`
JavaScript 对象表示法	`.json`
PNG 图像	`.png`
PSD	`.psd`
富文本格式	`.rtf`
可缩放矢量图	`.svg`
TIFF 图像	`.tif`
TIFF 图像	`.tiff`
TrueType 字体	`.ttf`

`SourceFilePath` — 源文件路径
字符向量

源文件路径，指定为字符向量。

`Tag` — `mlreportgen.dom.OPCPart` 对象的标签
字符向量 | 字符串标量

mlreportgen.dom.OPCPart 对象的标签，指定为字符向量或字符串标量。DOM API 在创建此对象的过程中生成一个会话唯一标签。生成的标签形式为 CLASS:ID，其中 CLASS 是对象类，ID 是对象的 Id 属性的值。指定您自己的标签值，以帮助您确定在文档生成过程中出现问题时要查找的位置。

属性：

NonCopyable true

数据类型: char | string

示例

全部折叠

将文件添加到 OPC 包

此代码将 data.json 文件的副本插入 mydoc 包的数据子文件夹中。此示例假设当前文件夹中有一个 data.json 文件。

import mlreportgen.dom.*;
d = Document('mydoc','html');
package(d,OPCPart('/data/data.json','data.json'));
close(d);

版本历史记录

在 R2014b 中推出

另请参阅

package

主题

输出类型和报告生成器包

mlreportgen.dom.OPCPart 类

描述

创建对象

描述

输入参量

name — 部件名称 字符向量

sourcePath — 部件源文件路径 字符向量

属性

ContentType — 部件内容类型 字符向量

Id — mlreportgen.dom.OPCPart 对象的标识符 字符向量 | 字符串标量

属性：

Name — 部件路径 字符向量

RelatedPart — 与指定部件相关的部件的路径名 字符向量

RelationshipID — 关系 ID 字符向量

RelationshipType — 关系类型 字符向量

SourceFilePath — 源文件路径 字符向量

Tag — mlreportgen.dom.OPCPart 对象的标签 字符向量 | 字符串标量

属性：

示例