ImgArea_SetDocument¶
Assign an image document to the plug-in area.
ImgArea_SetDocument(areaRef;imgDocRef;frameIdx) ➔ success
| → | areaRef |
Longint | The plug-in area reference. |
| → | imgDocRef |
Text | The Image document reference. |
| → | frameIdx |
Longint | The image frame index. |
| ↩︎ | success |
Longint | Completion status: 1 on success, 0 otherwise. |
Assign an image document to the plug-in area.
The plug-in area is specified by imageRef.
The image document and frame to be assigned to the area are specified by imgDocRef and frameIdx
respectively.
After assigning the document, the area’s zooming is reset to the default zoom factor/auto-zoom mode
defined in the area’s properties. See ImgArea_GetProperty and
ImgArea_SetProperty for more information.
Note
The plug-in area retains the assigned document, so it is safe for caller the to release the document if no longer needed.
