The <output> element defines what files your design function will generate and
how they’re named.
XML structure
<output
trueview_file="final_design_trueview.png" <!-- TrueView preview image -->
design_file="final_design.emb" <!-- Final embroidery design
file (GenerateDesign only) -->
design_version="" <!-- Optional
design version string -->
dpi="120" <!--
Optional TrueView image DPI -->
/>
Key attributes
Attribute | Description |
trueview_file | Filename for the TrueView™ preview bitmap.
- Required for api/newDesignTrueview
- Required for api/newLetteringPreview
- Optional for api/newDesign
|
|
design_file | Filename for the final embroidery design.
- Required for api/newDesign.
- Ignored for api/newDesignTrueview and api/newLetteringPreview.
|
|
design_version | Version format for the EMB design file.
- Optional: if empty or missing, defaults to latest (e4.5).
- Must match supported Wilcom format strings (see below).
|
dpi | Image resolution (DPI) for the TrueView preview.
- Default: 96
- Max: 300
- If ≤ 0 → defaults to 96
|
Filename rules
- Allowed characters: 0-9, a-z, A-Z,
-, _ and space.
- No Unicode or special symbols —
if used, you’ll get an error.
Design versions
Optional. Specifies the version
for the saved embroidery file. Use exact strings from
the EmbroideryStudio Save As dialog:
| Version string | Saves as |
Wilcom All-in-One Designs 26.0 (Digital Edition) (*.EMB) | Latest Digital Edition |
Wilcom All-in-One Designs e4.5 (*.EMB) | e4.5 format |
Wilcom All-in-One Designs e4.2 (*.EMB) | e4.2 format |
Wilcom All-in-One Designs e4.1 (*.EMB) | e4.1 format |
Wilcom All-in-One Designs e4.0 (*.EMB) | e4.0 format |
Wilcom All-in-One Designs e3.6 (*.EMB) | Hatch compatible |
| Wilcom All-in-One Designs e3.5 (*.EMB) | Hatch compatible |
Wilcom All-in-One Designs e3 (*.EMB) | e3 format |
Wilcom All-in-One Designs e2 (*.EMB) | e2 format
|
- Backward
saving to older versions is not supported beyond e2.
- If absent or empty, the latest
version is used.
- Must match the file type
specified in design_file.
- Valid only for Wilcom native
formats — e.g. EMB.
- Not supported for machine formats
— e.g. DST.
Example