mlreportgen.dom.Document.getImagePrefix

Class: mlreportgen.dom.Document
Package: mlreportgen.dom

Get generated image name prefix

Syntax

imagePrefix = mlreportgen.dom.Document.getImagePrefix(path,type)

Description

imagePrefix = mlreportgen.dom.Document.getImagePrefix(path,type) gets the image name prefix of a document or template package located at the specified path and of the specified type (Microsoft^® Word or HTML). The DOM interface uses the prefix when generating internal names of images appended to the document. This is a static method. Invoke it on the Document class.

Examples

Get the Image Name Prefix

Suppose that the image name prefix of an HTML document named MyDoc.htmx is image. To get the image name prefix, enter:

mlreportgen.dom.Document.getImagePrefix('MyDoc','html');

ans =

image

Input Arguments

path — Path of document or template package

character vector

Path of the document or template package

type — Type of document or package

'docx' | 'html'

Type document or template. For a Word document or template, specify 'docx'. For an HTML document or template, specify 'html'.

Output Arguments

imagePrefix — Image name prefix

character vector

The generated image name prefix.