Load Document
Command property:
Asynchronous command.
The Interface Status must be Ready to perform this operation.
If the status is different than Ready, the system reply with:
<command valid="false" error="Laser module not ready" />
Command action:
Load an existing Beamp file inside the editor.
The laser pens inside the Beamp file are NOT loaded, will be used the system standard laser pens.
WARNING: The entities inside the document must have an unique ID, including optional other layout already loaded.
Syntax:
<command name="loaddocument" Rotation="[Integer]" TemplateName="[String]" Template="[String]" />
Parameters:
Name |
Mandatory |
Description |
Format |
Standard value |
TemplateName |
Yes |
The name of the layout, used for Mark Layout command |
String |
--------------------- |
Template |
Yes |
Beamp file coded on Base64 |
String |
--------------------- |
Rotation |
No |
Rotation of the layout, in degree |
Integer |
0 |
Reply:
<command valid="true" />
During the command execution the Interface Status goes to Loading.
When the command is executed, the system reply with:
<command name="LoadDocument" executed="true" >
If the document creation is done, the Interface Status goes to Ready.
If the command execution fails, the system reply with:
<command name="LoadDocument" executed="false" >
If the document creation fails, the Interface Status goes to Error.
Command purpose:
This command is used to load an existing Beamp file.