Functions
Creates design file for layout in xml file, can be used for creating lettering. Designs/Alphabets referenced must be passed through attachments if not uploaded to server.
(HTTP sample)
Inputs:
|
ProjectLayout ProjectLayout |
Xml definition of design. Can include both lettering and embroidery files. |
|
string FileExtension |
The file extension of design to generate (ie. ofm) |
|
AttachmentList AttachmentData |
Contains attachments if ProjectLayout refers to any embroidery designs/Alphabets not on server, if no attachments needed pass null. |
|
bool bGeneratePNGGraphic |
set to true to generate graphic in addition to design file |
|
int nGraphicDPI |
the dpi to generate graphic at |
Outputs:
|
base64Binary DesignFile |
Byte array containing generated design file |
|
base64Binary DesignGraphic |
Byte array containing png graphic of design, only generated if bGeneratePNGGraphic true |
|
return value |
returns 0 if success, error code if failure |
Gets list of alphabets stored on server, also includes Alphabets in Alphabets directory user uploads to server.
(HTTP sample)
Inputs:
None
Outputs:
|
ArrayOfString AlphabetList |
contains list of alphabets available on server. |
|
return value |
returns 0 if success, error code if failure |
Creates design graphic for layout in xml file, can be used for creating lettering. Designs/Alphabets referenced must be passed through attachments if not uploaded to server. (HTTP sample)
Inputs:
|
ProjectLayout ProjectLayout |
Xml definition of design. Can include both lettering and embroidery files. |
|
AttachmentList AttachmentData |
Contains attachments if ProjectLayout refers to any embroidery designs/Alphabets not on server, if no attachments needed pass null |
|
int nGraphicDPI |
the dpi to generate graphic at |
Outputs:
|
base64Binary DesignGraphic |
Byte array containing png graphic of design |
|
int GetDesignGraphicResult |
returns 0 if success, error code if failure |
Gets information for embroidery design (stitchcount,colorcount,width,height), also optionally generate png graphic for design
(HTTP sample)
Inputs:
|
Base64Binary designInput |
Byte array of design file (pass null if FileName refers to file on server) |
|
string FileName |
name of file (only extension required) |
|
Boolean bGeneratePNGGraphic |
set to true to generate graphic in addition to getting design info |
|
boolean bGenerateExpFile |
set to true to generate exp file for design |
|
int graphicDPI |
the dpi to generate graphic at |
Outputs:
|
int stitchCount |
the number of stitches |
|
int colorCount |
the number of colors |
|
int width |
the width of design (1unit = .1mm) |
|
int height |
the height of design (1unit = .1mm) |
|
ArrayOfInt argbColors |
an array of colors in design |
|
Base64Binary DesignGraphic |
Byte array containing png graphic of design, only generated if bGeneratePNGGraphic true |
|
Base64Binary ExpFile |
Byte array containing exp file of design, only generated if bGenerateExpFile true |
|
int GetDesignInfoResult |
returns 0 if success, error code if failure |
|
ProjectLayout ProjectLayout |
Defines colors in design and possible lettering objects, can be modified to edit design in CreateDesignFile or GetDesignGraphic function |
- CreateDesignFile
Creates design file for layout in xml file, can be used for creating lettering. Must include design files in attachments if xml file references any design files - GetAlphabetList
Gets list of alphabets stored on server - GetDesignGraphic
Creates design graphic for layout in xml file, can be used for creating lettering. Must include design files in attachments if xml file references any design files - GetDesignInfo
Gets information for embroidery design (stitchcount,colorcount,width,height), also optionally generate png graphic for design