UnembedSvgImages Property

Summary

Unembed the image elements inside the SVG.

Syntax

C++/CLI

Java

Python

public bool UnembedSvgImages { get; set; }

public:  
   property bool UnembedSvgImages 
   { 
      bool get() 
      void set(bool value) 
   }

public boolean getUnembedSvgImages() 
public void setUnembedSvgImages(boolean value)

UnembedSvgImages # get and set (DocumentImages)

Property Value

true to unembed the image elements inside the SVG; otherwise, false. Default value is false.

Remarks

If the value of UnembedSvgImages is false (the default), the result SVG will be self-contained with no references to any external resources. For example, all the <image> elements inside the SVG will be in a data URI format with the image pixel data embedded as a base 64 string.

If the value of UnembedSvgImages is true, then the engine will extract the pixel data of the embedded images from the SVG document, save them to the cache and replace them with a URL. This requires the cache system to be setup with a virtual directory otherwise an error will occur.

UnembedSvgImages should not be used if CodecsLoadSvgOptions.DropImages is used along with DocumentPage.GetSvgBackImage to return the images portion of the page separately than the main SVG.

The LEADTOOLS Document Viewer leaves this value to the default of false.

Note that setting this property to a value will update the same value in each child document.

Requirements

Target Platforms