SetImage Method

Summary

Replaces the raster image for this page.

Syntax

C++

Java

public void SetImage( 
   RasterImage image 
)

Public Sub SetImage( 
   ByVal image As RasterImage 
)

public:  
   void SetImage( 
      RasterImage^ image 
   )

public void setImage(RasterImage image)

Parameters

image

New raster image to use for this page. This value can be null.

Remarks

GetImage and GetImage(resolution) are used to get a raster image representation of this page. All document types support this method and it will always return a value object.

SetImage is used to replace the raster image of the page. IsImageModified is used as a flag that indicates that the image of this page has been replaced by the user.

This method works as follows (the "item" is a raster image with the specified resolution):

This method requires that the owner document uses a cache system (LEADDocument.HasCache is true); otherwise, an exception will be thrown.
If the value of the IsReadOnly property of LEADDocument is true, then the user cannot modify this document and an exception will be thrown.
All previously saved raster image objects for this page are purged from the cache.

4.An image is added to the cache by serializing the RasterImage object. The original object is not disposed and is still owned by the user. If image is null, then a "null" item is added to the cache.

The page Size and Resolution properties are updated to be the same value as the image. If the image set is null, then these values are set to DocumentPages.DefaultPageSize and DocumentPages.DefaultResolution.

GetImage will check the cache first, hence, subsequent calls will return the value set by this method.

The value of IsImageModified will be set to true after this method returns.

For more information, refer to Loading Using LEADTOOLS Document Library.

Requirements

Target Platforms