RenderOnImage Method

Summary

Renders the container into the specified image.

Syntax

C++/CLI

public RasterImage RenderOnImage( 
   RasterImage image, 
   int pageNumber 
)

public:  
   RasterImage^ RenderOnImage( 
      RasterImage^ image, 
      Int32 pageNumber 
   )

image

The target RasterImage.

pageNumber

The container page number to render on the specified image.

The resulting image containing the original image data plus the objects of the container overlaid on top.

Remarks

The method can be used to quickly accomplish the following:

Render the container on a smaller image, for example to create a thumbnail: Create a smaller version of the original image at the desired size and then pass it to RenderOnImage.
Render the container on an image used for printing. Create a temporary image, renders the container on it and then prints the resulting image.
Render the container on an image for saving to an external file or taking a screenshot of the current container.

Requirements

Help Version 23.0.2024.2.29