SetSvgBackImage Method

Summary

Replaces the SVG background image for this page.

Syntax

C++

Java

public void SetSvgBackImage( 
   RasterImage image 
)

Public Sub SetSvgBackImage( 
   ByVal image As RasterImage 
)

public:  
   void SetSvgBackImage( 
      RasterImage^ image 
   )

public void setSvgBackImage(RasterImage image)

Parameters

image

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

Remarks

GetSvgBackImage is used to get a raster image that represents contains only the image elements of the SVG document for this page. Not all document types support this method, this depends on the value of DocumentImages.IsSvgSupported.

SetSvgBackImage is used to replace the SVG background image of the page. IsSvgBackImageModified is used to as flag that indicates that the SVG background image of this page has been replaced by the user.

This method works as follows (the "item" is the raster image passed by the user):

If this document does not support SVG (the value of DocumentImages.IsSvgSupported is false), then an exception will be thrown.
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.
The SVG background image previously saved for this page are purged from the cache.
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.