Date: Thu, 28 Mar 2024 10:54:05 +0100 (CET) Message-ID: <511082101.119.1711619645437@nm-docs> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_118_310369131.1711619645437" ------=_Part_118_310369131.1711619645437 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
$file allows generating an output report file in a template file.
A shortcut to create a file, the output filename of which is the templat= e name, not an import context object. For example:
$file.s= ilentCreate('overview.html')
Name | Type | Description | |
---|---|---|---|
Parameter(s) | templateFilename | java.lang.String |
|
Return | - | void |
A shortcut to create a file, the output filename of which is the templat= e name, not an import context object. For example:
$file.s= ilentCreate($attachedFile)
Name | Type | Description | |
---|---|---|---|
Parameter(s) | attachedFile | com.nomagic.uml2.ext.magicdraw.classes.mdkernel.= Element | An Attached File Element. |
Return | - | void |
A shortcut to create a file, the output filename of which is the templat= e name. For example:
$file.s= ilentCreate('overview.html','')
Name | Type | Description | |
---|---|---|---|
Parameter(s) | templateFilename | java.lang.String
|
|
importObject | java.lang.Object | An object reference, which will be $importer in = the template file. You can use the $importer variable in the template file = to get data. | |
Return | - | void | - |
A shortcut to create a file, the output filename of which is the templat= e name. For example:
$file.s= ilentCreate($attachedFile,'')
Name | Type | Description | |
---|---|---|---|
Parameter(s) | attachedFile |
com.nomagic.uml2.ext.magicdraw.classes.mdkern= el.Element |
An Attached File Element. |
importObject | java.lang.Object | An object reference, which will be $importer in = the template file. You can use the $importer variable in the template file = to get data. | |
Return | - | void | - |
Generate a report output from a given template name. For example:
$file.s= ilentCreate('overview.html','overview.html','')
Name | Type | Description | |
---|---|---|---|
Parameter(s) |
templateFilename | java.lang.String |
|
outputFileName | java.lang.String | The output filename. | |
importObject | java.lang.Object | An object reference, which will be $importer in = the template file. You can use the $importer variable in the template file = to get data. | |
Return | - | void | - |
Generate a report output from a given template name. For example:
$file.s= ilentCreate($attachedFile,'overview.html','')
Name | Type | Description | |
---|---|---|---|
Parameter(s) |
attachedFile |
com.nomagic.uml2.ext.magicdraw.classes.mdkernel.= Element | An Attached File Element. |
outputFileName | java.lang.String | The output filename. | |
importObject | java.lang.Object | An object reference, which will be $importer in = the template file. You can use the $importer variable in the template file = to get data. | |
Return | - | void | - |
Generate a report output from a given template name. For example:
$file.s= ilentCreate('html','overview','overview','')
Name | Type | Description | |
---|---|---|---|
Parameter(s) <= br> |
templateType | java.lang.String | A template type such as rtf, html, or htm. |
templateFilename | java.lang.String |
|
|
outputFileName | java.lang.String | An output filename without a filename extension.= | |
importObject | java.lang.Object | An object reference, which will be $importer in = the template file. You can use the $importer variable in the template file = to get data. | |
Return | - | void | - |
Generate a report output from a given template name. For example:
$file.s= ilentCreate('html',$attachedFile,'overview','')
Name | Type | Description | |
---|---|---|---|
Parameter(s) <= br> |
templateType | java.lang.String | A template type such as rtf, html, or htm. |
attachedFile |
com.nomagic.uml2.ext.magicdraw.classes.mdkernel.= Element | An Attached File Element. | |
outputFileName | java.lang.String | An output filename without a filename extension.= | |
importObject | java.lang.Object | An object reference, which will be $importer in = the template file. You can use the $importer variable in the template file = to get data. | |
Return | - | void | - |
A shortcut to create a file, the output filename of which is the templat= e name, not an import context object. For example:
$file.c= reate('overview.html')
Name | Type | Description | |
---|---|---|---|
Parameter(s) | templateFilename | java.lang.String |
|
Return | - | java.lang.String | An output pathname. It will return an empty stri= ng if there is an error. |
A shortcut to create a file, the output filename of which is the templat= e name, not an import context object. For example:
$file.c= reate($attachedFile)
Name | Type | Description | |
---|---|---|---|
Parameter(s) | attachedFile |
com.nomagic.uml2.ext.magicdraw.classes.mdkernel.= Element | An Attached File Element. |
Return | - | java.lang.String | An output pathname. It will return an empty stri= ng if there is an error. |
A shortcut to create a file, the output filename of which is the templat= e name. For example:
$file.= create('overview.html','')
Name | Type | Description | |
---|---|---|---|
Parameter(s) | templateFilename | java.lang.String |
|
importObject | java.lang.Object | An object reference, which will be importer in t= he template file. You can use the $importer variable in the template file t= o get data. | |
Return | - | java.lang.String | An output pathname. It will return an empty stri= ng if there is an error. |
A shortcut to create a file, the output filename of which is the templat= e name. For example:
$file.= create($attachedFile,'')
Name | Type | Description | |
---|---|---|---|
Parameter(s) | attachedFile |
com.nomagic.uml2.ext.magicdraw.classes.mdkernel.= Element | An Attached File Element. |
importObject | java.lang.Object | An object reference, which will be importer in t= he template file. You can use the $importer variable in the template file t= o get data. | |
Return | - | java.lang.String | An output pathname. It will return an empty stri= ng if there is an error. |
Generate a report output from a given template name. For example:
$file.c= reate('overview.html','overview.html','')
Name | Type | Description | |
---|---|---|---|
Parameter(s) |
templateFilename | java.lang.String |
|
outputFileName | java.lang.String | An output filename. | |
importObject | java.lang.Object | An object reference, which will be $importer in = the template file. You can use the $importer variable in the template file = to get data. | |
Return | - | java.lang.String | An output pathname. It will return an empty stri= ng if there is an error. |
Generate a report output from a given template name. For example:
$file.c= reate($attachedFile,'overview.html','')
Name | Type | Description | |
---|---|---|---|
Parameter(s) |
attachedFile |
com.nomagic.uml2.ext.magicdraw.classes.mdkernel.= Element | An Attached File Element. |
outputFileName | java.lang.String | An output filename. | |
importObject | java.lang.Object | An object reference, which will be $importer in = the template file. You can use the $importer variable in the template file = to get data. | |
Return | - | java.lang.String | An output pathname. It will return an empty stri= ng if there is an error. |
Generate a report output from a given template name. For example:
$file.c= reate('html','overview','overview','')
Name | Type | Description | |
---|---|---|---|
Parameter(s) |
templateType | java.lang.String | A template type such rtf, html, and htm. = td> |
templateFilename | java.lang.String |
|
|
outputname | java.lang.String | An output filename without a filename extension.= | |
importObject | java.lang.Object | An object reference, which will be $importer in = the template file. You can use the $importer variable in the template file = to get data. | |
Return | - | java.lang.String | An output pathname. It will return an empty stri= ng if there is an error. |
Generate a report output from a given template name. For example:
$file.c= reate('html',$attachedFile,'overview','')
Name | Type | Description | |
---|---|---|---|
Parameter(s) |
templateType | java.lang.String | A template type such rtf, html, and htm. = td> |
attachedFile <= /td> | com.nomagic.uml2.ext.magicdraw.classes.mdkernel.= Element | An Attached File Element. | |
outputname | java.lang.String | An output filename without a filename extension.= | |
importObject | java.lang.Object | An object reference, which will be $importer in = the template file. You can use the $importer variable in the template file = to get data. | |
Return | - | java.lang.String | An output pathname. It will return an empty stri= ng if there is an error. |
Open a new template engine to generate a report and return a path to gen= erate the file. The generated report will be given the template filename. F= or example:
$file.c= reateAndWait('overview.html')
Name | Type | Description | |
---|---|---|---|
Parameter(s) | templateFilename | java.lang.String |
|
Return | - | java.lang.String | An absolute path to generate a file. |
Open a new template engine to generate a report and return a path to gen= erate the file. The generated report will be given the template filename. F= or example:
$file.c= reateAndWait($attachedFile)
Name | Type | Description | |
---|---|---|---|
Parameter(s) | attachedFile |
com.nomagic.uml2.ext.magicdraw.classes.mdkernel.= Element | An Attached File Element. |
Return | - | java.lang.String | An absolute path to generate a file. |
Open a new template engine to generate a report and return a path to gen= erate the file. The generated report will be named after the template filen= ame. For example:
$file.c= reateAndWait('overview.html',$var)
Name | Type | Description | |
---|---|---|---|
Parameter(s) | templateFilename | java.lang.String |
|
contextValue | java.lang.Object | An additional object added to a new template con= text with a default $importer name. | |
Return | java.lang.String |
Open a new template engine to generate a report and return a path to gen= erate the file. The generated report will be named after the template filen= ame. For example:
$file.c= reateAndWait($attachedFile,$var)
Name | Type | Description | |
---|---|---|---|
Parameter(s) | attachedFile | com.nomagic.uml2.ext.magicdraw.classes.mdkernel.= Element | An Attached File Element. |
contextValue | java.lang.Object | An additional object added to a new template con= text with a default $importer name. | |
Return | java.lang.String |
Open a new template engine to generate a report and return a path to gen= erate the file. "importer" will be used as the name of a context value. For= example:
$file.c= reateAndWait('overview.html','overview.html',$var)
Name | Type | Description | |
---|---|---|---|
Parameter(s) &n= bsp; | templateFilename | java.lang.String |
|
outputFilename | java.lang.String | An output report filename. | |
contextValue | java.lang.Object | An additional object added to a new template con= text with a default $importer name. | |
Return | java.lang.String | An absolute path to generate a file. |
Open a new template engine to generate a report and return a path to gen= erate the file. "importer" will be used as the name of a context value. For= example:
$file.c= reateAndWait($attachedFile,'overview.html',$var)
Name | Type | Description | |
---|---|---|---|
Parameter(s) &n= bsp; | attachedFile |
com.nomagic.uml2.ext.magicdraw.classes.mdkernel.= Element | An Attached File Element. |
outputFilename | java.lang.String | An output report filename. | |
contextValue | java.lang.Object | An additional object added to a new template con= text with a default $importer name. | |
Return | java.lang.String | An absolute path to generate a file. |
Open a new template engine to generate a report and return a path to gen= erate the file. For example:
$file.c= reateAndWait('overview.html','overview.html','var',$var)
Name | Type | Description | |
---|---|---|---|
Parameter(s) &n= bsp; | templateFilename | java.lang.String |
|
outputFilename | java.lang.String | An output report filename. | |
contextName | java.lang.String | Add an object context's name. | |
contextValue | java.lang.Object | An additional object added to a new template con= text with a default $importer name. | |
Return | - | java.lang.String | An absolute path to generate a file. |
Open a new template engine to generate a report and return a path to gen= erate the file. For example:
$file.c= reateAndWait($attachedFile,'overview.html','var',$var)
Name | Type | Description | |
---|---|---|---|
Parameter(s) &n= bsp; | attachedFile | com.nomagic.uml2.ext.magicdraw.classes.mdkernel.= Element | An Attached File Element. |
outputFilename | java.lang.String | An output report filename. | |
contextName | java.lang.String | Add an object context's name. | |
contextValue | java.lang.Object | An additional object added to a new template con= text with a default $importer name. | |
Return | - | java.lang.String | An absolute path to generate a file. |
Open a new template engine to generate a report and return a path to gen= erate the file. For example:
$file.c= reateAndWait('overview.html','overview.html',$map)
Name | Type | Description | |
---|---|---|---|
Parameter(s) &n= bsp; | templateFilename | java.lang.String |
|
outputFilename | java.lang.String | An output report filename. |
|
context | java.util.Map<String, Object> | An additional context added to a new template. |
|
Return | - | java.lang.String | An absolute path to generate a file. |
Open a new template engine to generate a report and return a path to gen= erate the file. For example:
$file.c= reateAndWait($attachedFile,'overview.html',$map)
Name | Type | Description | |
---|---|---|---|
Parameter(s) &n= bsp; | attachedFile | com.nomagic.uml2.ext.magicdraw.classes.mdkernel.= Element | An Attached File Element. |
outputFilename | java.lang.String | An output report filename. | |
context | java.util.Map<String, Object> | An additional context added to a new template.&n= bsp; | |
Return | - | java.lang.String | An absolute path to generate a file. |
Copy an input file to an output file using the same name in the binary f= ormat. For example:
$file.c= opy('icon.gif')
Name | Type | Description | |
---|---|---|---|
Parameter(s) | inputFilename | java.lang.String | An input filename |
Return | - | java.lang.String | An output pathname. It will return an empty string if there is an error. |
Copy an input file to an output file in the binary format. For example:<= /p>
$file.= copy('icon.gif','icon.gif')
Name | Type | Description | |
---|---|---|---|
Parameter(s) = strong> | inputFilename | java.lang.String | An input filename. |
outputFilename | java.lang.String | An output filename. |
|
Return | - | java.lang.String | An output pathname. It will return an empty string if there is an error. |
Test if a file denoted by a specific pathname exists. By default, the cu= rrent directory refers to a template location. For example:
$file.e= xists("$template.resourcesLocation/myimage.png") $file.exists("C:/myfolder/myimage.png") $file.exists("mytemplate.txt")
Name | Type | Description | |
---|---|---|---|
Parameter(s) | pathname | java.lang.String | A pathname string. |
Return | - | java.lang.String | True if and only if a file or directory denoted by a specific pathname exists; otherwise, false. |
Create a pathname string from a given directory and name.
Name | Type | Description | |
---|---|---|---|
Parameter(s) | directory | java.lang.String | A parent directory of a file. |
name | java.lang.String | A filename (excludes the filename extension). |
|
Return | - | java.lang.String | A pathname from the given directory and name. |
For example:
$file.c= omputeName('actors', $ac.ID, 'html') output: 'actor/_123456789.html'
Create a pathname string from a given directory, name, and file type.
Name | Type | Description | |
---|---|---|---|
Parameter(s) | directory | java.lang.String | A parent directory of a file. |
name | java.lang.String | A filename (excluding the extension). |
|
fileType | java.lang.String | A file type, such as rtf, txt, and html. |
|
Return | - | java.lang.String | A pathname from the given directory, name, and file type. |