Editions
Related Transactions
Example
The ImportPage transaction adds the specified file as a new page in the specified document window.
Type XTYP_EXECUTE or XTYP_REQUEST
Syntax [ImportPage(docwinID, pageNum, relPosition, parentID, "fileName", "pageLabel", <location>)]
[ImportPage(documentID, pageNum, relPosition, parentID, "fileName", "pageLabel", <location>)]
|
Parameter |
Data type |
Values |
Meaning |
|
docwinID or documentID |
DWORD
DWORD |
0 | docwinID
documentID |
active | specific
root document identifier. See Remarks. |
|
pageNum |
WORD |
1 | 2 | … | last page |
number of page relative to which the new page is imported. Only used if relPosition equals 0 or 1. |
|
relPosition |
BOOL |
0 1 2 3 |
before pageNum after pageNum start of document end of document |
|
parentID |
DWORD |
0 |
same parent as pageNum |
|
|
|
pageID |
subordinate to specific page. See Remarks. |
|
fileName |
file name including path of the page file to import | ||
|
pageLabel |
string |
label, maximum 80 characters. See Remarks. | |
|
location |
WORD |
0 |
file on disk. Optional parameter. |
|
Reply |
Data type |
Meaning | |
|
result |
DWORD |
identifier of the new page. See Remarks. | |
Remarks
The root document identifier may have to be used instead of the docwinID, to ensure that the imported page is not embedded.
The page node identified by parentID must be an ancestor of the page identified by pageNum.
The pageLabel replaces the label previously assigned to this page.
Replies are only returned when this transaction is called as an XTYP_REQUEST.
The first time this transaction is used after a CreateDocwin transaction, the existing blank page is replaced by the imported page.
Release Information
Added in Release 3.70.
See also