mlreportgen.dom.OPCPart Class
Namespace: mlreportgen.dom
Document part to include in OPC package
Description
Document part to include in an OPC package.
The mlreportgen.dom.OPCPart
class is a handle
class.
Creation
Description
creates an empty OPC part.opcPartObj
= OPCPart
creates a part having the specified name whose
source file is located at the specified path.
Appending the part to a document using the
opcPartObj
= OPCPart(name
,sourcePath
)Document.package
method causes
a copy of the source file to be inserted in the
document package at the location specified by the
part name.
Input Arguments
name
— Name of part
character vector
Name of part, specified as a character vector or string scalar.
sourcePath
— Path of source file for part
character vector
Path of source file for part, specified as a character vector or string scalar.
Properties
ContentType
— Content type of part
''
(default) | character vector | string scalar
Specifies the content type using a file extension, specified as a character vector or string scalar. For a list of file content types, see https://en.wikipedia.org/wiki/Open_Packaging_Conventions.
If you do not set this property and the part is one of the types listed below, the DOM interface sets the content type when you append the part to a document.
File Type | File Extension |
---|---|
Cascading style sheet |
|
Icon |
|
Windows® metafile |
|
Encapsulated PostScript® |
|
GIF image |
|
HTML |
|
JPEG image |
|
JavaScript® |
|
JavaScript object Notation |
|
PNG image |
|
PSD |
|
Rich Text Format |
|
Scalable Vector Graphics |
|
TIFF image |
|
TrueType font |
|
Plain text |
|
Attributes:
NonCopyable | true |
Name
— Path of part
''
(default) | character vector | string scalar
Path of this part relative to the root of
the package, specified as a character vector or string scalar. For
example, to add an image named
myimage.jpg
to a document
images folder, specify the path as
'/images/myimage.jpg'
. Specify
Name
using only ASCII
characters.
For information about OPC part names, see https://en.wikipedia.org/wiki/Open_Packaging_Conventions.
Attributes:
NonCopyable | true |
RelatedPart
— Path name of part to which specified part is related
''
(default) | character vector | string scalar
For information about OPC part names, see https://en.wikipedia.org/wiki/Open_Packaging_Conventions.
Attributes:
NonCopyable | true |
RelationshipID
— Relationship ID
''
(default) | character vector | string scalar
For information about OPC relationship IDs, see https://en.wikipedia.org/wiki/Open_Packaging_Conventions.
Attributes:
NonCopyable | true |
RelationshipType
— Relationship type
''
(default) | character vector | string scalar
Specifies a relationship type using a file extension, specified as a character vector or string scalar. For a list of file content types, see https://en.wikipedia.org/wiki/Open_Packaging_Conventions.
If you do not set this property and the part is one of these types, the DOM interface sets the content type when you append the part to a document.
File Type | File Extension |
---|---|
Cascading style sheet |
|
Icon |
|
Windows metafile |
|
Encapsulated PostScript |
|
GIF image |
|
HTML |
|
JPEG image |
|
JavaScript |
|
JavaScript object Notation |
|
PNG image |
|
PSD |
|
Rich Text Format |
|
Scalable Vector Graphics |
|
TIFF image |
|
TrueType font |
|
Plain text |
|
Attributes:
NonCopyable | true |
SourceFilePath
— Source file path
''
(default) | character vector | string scalar
Source file path, specified as a character vector or string scalar.
Attributes:
NonCopyable | true |
Data Types: char
| string
Tag
— Tag for mlreportgen.dom.OPCPart
object
character vector | string scalar
Tag for the mlreportgen.dom.OPCPart
object, specified as a character vector or
string scalar. The DOM API generates a session-unique tag as part of the creation of
this object. The generated tag has the form
CLASS:ID
, where
CLASS
is the object class and
ID
is the value of the
Id
property of the object. Specify your own tag value to help
you identify where to look when an issue occurs during document generation.
Attributes:
NonCopyable | true |
Data Types: char
| string
Id
— Object identifier for mlreportgen.dom.OPCPart
object
character vector | string scalar
Object identifier for the mlreportgen.dom.OPCPart
object, specified as a
character vector or string scalar. The DOM API generates a session-unique identifier
when it creates the document element object. You can specify your own value for
Id
.
Attributes:
NonCopyable | true |
Data Types: char
| string
Examples
Add a File to an OPC Package
This code inserts a copy of
the data.json
file in the data
subfolder of the mydoc
package.
This example assumes that there is a
data.json
file in the current
folder.
import mlreportgen.dom.*; d = Document('mydoc','html'); package(d,OPCPart('/data/data.json','data.json')); close(d);
Version History
Introduced in R2014bR2024b: Removal of BMP for image output
Report Generator no longer supports BMP (bitmap) as an output image format. This affects
snapshots, images from files, and watermarks in both the Report Explorer and the Report,
DOM, and PPT APIs. See print
for more information.
MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)