SetSvg Method

Summary

Replaces the SVG document for this page.

Syntax

C++/CLI

Java

Python

public void SetSvg( 
   SvgDocument svg, 
   CodecsLoadSvgOptions options 
)

public:  
   void SetSvg( 
      SvgDocument^ svg, 
      CodecsLoadSvgOptions^ options 
   )

public void setSvg(SvgDocument svg, CodecsLoadSvgOptions options)

def SetSvg(self,svg,options):

Parameters

svg

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

options

Options to use when caching this SVG document. It can be used to drop images, text or shapes before the document is saved, if they are not needed. If this value is null, then the SVG document is saved as is without modification.

Remarks

GetSvg is used to get an SVG document representation of this page. Not all document types support this method. Support depends on the value of DocumentImages.IsSvgSupported.

SetSvg is used to replace the SVG document of the page. IsSvgModified is used as a flag that indicates that the SVG document of this page has been replaced by the user.

This method works as follows (the "item" is the SVG document 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 use 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.
SVG documents with the same options previously saved for this page are purged from the cache.
svg is added to the cache by serializing the SvgDocument object. The original object is not disposed and is still owned by the user. If svg is null, then a "null" item is added to the cache.