The SaveDocument transaction saves the complete document in the specified document window. This transaction is used to save multipages or multilayer pages--particularly those containing new layers or pages--or to save single layers under the Spicer Document format. You can optionally specify a new file name and output file format, and choose whether to prompt the user about a conflict between the new file name and an existing one.
Type XTYP_EXECUTE
Syntax [SaveDocument(docwinID, saveAs, "fileName", "documentLabel", docFormat, checkExistence)]
|
Parameter |
Data type |
Values |
Meaning |
|
docwinID |
DWORD |
0 | docwinID |
active | specific |
|
saveAs |
BOOL |
0 | 1 |
existing | fileName |
|
fileName |
file name including path to save the document under | ||
|
documentLabel |
string |
label, maximum 80 characters | |
|
docFormat |
WORD |
0 |
Spicer Multipage (.das) or Spicer Multilayer Page (.clf). See Remarks. |
|
|
|
1 |
Spicer Document (.smf) |
|
|
|
2 |
Multipage TIFF |
|
|
|
3 |
DCX |
|
checkExistence |
BOOL |
0 | 1 |
do not check | check. See Remarks. |
Remarks
If you choose docFormat 0, all pages and layers in the document must have been assigned file names before you use this transaction.
If the checkExistence parameter is set to 1 and a file with the specified name already exists, Imagenation will prompt the user before overwriting it.
Release Information
Added in Release 3.70.
See also