L_SvgSetFlatDocument

Summary

Sets the flat flag of the specified SVG document.

Syntax

L_LTSVG_API L_INT L_SvgSetFlatDocument(docHandle, flatDoc)

Parameters

L_SvgNodeHandle docHandle

The SVG document handle referencing the SVG document to be updated.

L_BOOL flatDoc

TRUE to force the flat-state of the SVG document; FALSE to clear it.

Returns

Comments

Support for SVG is only available in the Document and Medical Imaging toolkits.

For more information on flat SVG documents and bounds and resolution, refer to SVG Size, Bounds and Flat.

Required DLLs and Libraries

• LTSVG
• For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Platforms

Win32, x64, Linux.

See Also

Functions

• L_SvgFlatDocument
• L_SvgIsFlatDocument
• L_SvgCreateDocument
• L_LoadSvg
• L_SvgLoadDocument
• L_SvgFreeNode

Topics

• Working with SVG
• SVG Size, Bounds and Flat

Example

This example loads a PDF file as SVG and then sets the flat flag of the specified document to true.

L_INT SvgSetFlatDocumentExample(L_VOID) 
{ 
   L_INT nRet = ERROR_FILE_FORMAT; 
 
   LOADSVGOPTIONS options; 
   memset(&options, 0, sizeof(LOADSVGOPTIONS)); 
   options.uStructSize = sizeof(LOADSVGOPTIONS); 
   options.uFlags = L_LOADSVGOPTIONS_NONE; 
   options.SvgHandle = NULL; 
 
   /* Load the document as SVG */ 
   L_TCHAR filename[L_MAXPATH] = MAKE_IMAGE_PATH(TEXT("Leadtools.pdf")); 
 
   L_BOOL canLoad = FALSE; 
   nRet = L_CanLoadSvg(filename, &canLoad, NULL); 
   if (canLoad) 
   { 
      nRet = L_LoadSvg(filename, &options, NULL); 
      if (nRet != SUCCESS) 
         return nRet; 
 
      nRet = L_SvgSetFlatDocument(options.SvgHandle, L_TRUE); 
 
      L_SvgFreeNode(options.SvgHandle); 
   } 
 
   return nRet; 
}