GetSvgBackImage(RasterColor,int) Method

Summary

Gets a raster image that contains only the image elements of the SVG document for this page.

Syntax

C++

Java

public RasterImage GetSvgBackImage( 
   RasterColor backColor, 
   int resolution 
)

Public Function GetSvgBackImage( 
   ByVal backColor As RasterColor, 
   ByVal resolution As Integer 
) As RasterImage

public:  
   RasterImage^ GetSvgBackImage( 
      RasterColor^ backColor, 
      int resolution 
   )

public RasterImage getSvgBackImage(RasterColor backColor, int resolution)

Parameters

backColor

Color to fill the background of the image.

resolution

Resolution to use, in dots per inch. If this value is 0, then the current page Resolution value is used.

Return Value

Raster image that contains only the image elements of the SVG document for this page if this page supports SVG, and the SVG data contains image elements; otherwise, null.

Remarks

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

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

GetSvgBackImage 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.
If an item was found in the cache, it is returned right away. This is available if the document was created using the cache system, and LEADDocument.CacheOptions contains DocumentCacheOptions.PageSvgBackImage.
The SVG data for this page is loaded with everything dropped except the image elements. If the resulting document is empty (the page does not contain any image elements in its SVG), then null is returned.
Otherwise, a new RasterImage is created and filled with backColor (assuming it is not a transparent color). Then the SVG data containing only the image elements is rendered on the surface of this image. The size of the resulting raster image is the same size as this page.
If this document uses the cache system (LEADDocument.HasCache is true), then theRasterImage object is saved to the cache before it is returned. The next time this method is called, the image will be returned from the cache directly—without loading it from the file or creating a new instance.