ImgDoc_InsertFrame¶
imgDocRef | Text | The image document reference. |
frameIdx | Longint | The image frame index. |
srcDocRef | Text | The source image document reference. |
srcFrameIdx | Longint | The source image frame index. |
options | Object | Options. |
success | Longint | Completion status: 1 on success, 0 otherwise. |
Insert an image frame to an image document.
Parameter imgDocRef
is the reference to the image document that will receive the
new frame. Parameter frameIdx
is the index in the document’s frame array where the
new frame will be inserted.
Parameter srcDocRef
is the reference of the source image document.
Parameter srcFrameIdx
is the index of the source frame.
Note that srcDocRef
may be the same as imgDocRef
, in which case the image frame is
duplicated within the same document.
Parameter options
is optional, and can be used to specify the rendering resolution
(DPI size) when inserting a page from a PDF document into a raster document.
It is a 4D object and may contain the following property and value:
Property name | Type | Default | Description |
---|---|---|---|
RenderDPISize |
SizeObj object |
{"Width": 300, "Height": 300} |
The resolution at which the PDF page will be rendered. |
If the method completes successfully, 1
is returned in success
, 0
otherwise.
Note
This method is a convenience wrapper for the ImgDoc_InsertFrame_JSN
plug-in method.