RemoveWrapImage

PowerScript function

Description

Removes an image that the current PDFRichText object wraps
around.

Applies to

PDFRichText object in Objects and Controls

Syntax

long RemoveWrapImage(long index)

1	long RemoveWrapImage(long index)

long RemoveWrapImage(string name)

1	long RemoveWrapImage(string name)

Argument	Description
index	The index of the image that the PDFRichText object wraps around. The index of the images are determined by the orders the WrapImage function is called to wrap it, starting at 1. If the wrapping for one image is removed, the indexes of the remaining objects will be reordered.
name	The name of the image that the PDFRichText object wraps around.

Return value

Long. Returns 1 if it succeeds, or returns -1 if it fails. For more
errors, see the Error Codes.

Examples

The following example removes a wrapped image with index = 1:

//Remove the wrapped image with index = 1
lpdf_rtext.removewrapimage (1)

1 2	//Remove the wrapped image with index = 1 lpdf_rtext.removewrapimage (1)

The following example removes a wrapped image with name =
“image”:

lpdf_image.name= "image"
lpdf_page.AddContent( lpdf_image)
lpdf_rtext.wrapimage( lpdf_image)

//Remove the wrapped image with name ="image"
lpdf_rtext.removewrapimage ("image ")