SaveXml(DicomDataSet,string,DicomDataSetSaveXmlFlags) Method

Summary

Saves the contents of the Data Set to the specified XML output file.

Syntax
C#
VB
C++
public static void SaveXml( 
   this DicomDataSet ds, 
   string fileName, 
   DicomDataSetSaveXmlFlags xmlFlags 
) 
<ExtensionAttribute()> 
Public Overloads Shared Sub SaveXml( _ 
   ByVal ds As DicomDataSet, _ 
   ByVal fileName As String, _ 
   ByVal xmlFlags As DicomDataSetSaveXmlFlags _ 
)  
[ExtensionAttribute()] 
public: 
static void SaveXml(  
   DicomDataSet^ ds, 
   String^ fileName, 
   DicomDataSetSaveXmlFlags xmlFlags 
)  

Parameters

ds
The contents of this data set to be saved

fileName
The name of the output XML file

xmlFlags
Flags that affect how binary data and other information is saved in the XML output file

Remarks

Use this method to export a DicomDataSet as a human-readable XML file. By default, all binary data is written using Base64 encoding, but this behavior can be modified by passing appropriate DicomDataSetSaveXmlFlags

Pass the DicomDataSetSaveXmlFlags.NativeDicomModel flag to save to the 'Native DICOM Model' XML format described in PS3.19.A.1 of the DICOM Specification. One of the following flags can be used together with the DicomDataSetSaveXmlFlags.NativeDicomModel flag to control how binary data is written. If DicomDataSetSaveXmlFlags.NativeDicomModel, is not also included, all of the following flags are ignored. Callers should only pass one of the three flags. If more than one of the flags is passed, precedence is given in the order that they appear below.

  • InlineBinary
  • BulkDataUri
  • BulkDataUuid

If none of these three flags is passed, the default behavior is BulkDataUuid.

Example
C#
VB
using Leadtools.Dicom; 
using Leadtools.Dicom.Common; 
using Leadtools.Dicom.Common.Extensions; 
using Leadtools; 
using Leadtools.Dicom.Common.Linq.BasicDirectory; 
using Leadtools.Dicom.Common.DataTypes; 
 
public static void SaveXmlNativeExample() 
{ 
   string dicomFileNameIn = Path.Combine(LEAD_VARS.ImagesDir, "IMAGE3.dcm"); 
   string xmlFileNameOut = Path.Combine(LEAD_VARS.ImagesDir, "test.xml"); 
 
   DicomEngine.Startup(); 
 
   DicomDataSet ds = new DicomDataSet(); 
 
   // Load an existing DICOM file 
   ds.Load(dicomFileNameIn, DicomDataSetLoadFlags.None); 
 
   // Save as NativeDicomModel 
   const DicomDataSetSaveXmlFlags xmlFlags = 
      DicomDataSetSaveXmlFlags.NativeDicomModel | 
      DicomDataSetSaveXmlFlags.TrimWhiteSpace | 
      DicomDataSetSaveXmlFlags.BulkDataUuid; 
   ds.SaveXml(xmlFileNameOut, xmlFlags); 
 
   // Load 
   ds.LoadXml(xmlFileNameOut, DicomDataSetLoadXmlFlags.None); 
 
   DicomEngine.Shutdown(); 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images"; 
} 
Imports Leadtools.Dicom 
Imports Leadtools.Dicom.Common 
Imports Leadtools.Dicom.Common.Extensions 
Imports Leadtools.Dicom.Common.Linq 
Imports Leadtools.Dicom.Common.Linq.BasicDirectory 
Imports Leadtools 
Imports Leadtools.Dicom.Common.DataTypes 
 
Public Shared Sub SaveXmlNativeExample() 
   Dim dicomFileNameIn As String = Path.Combine(LEAD_VARS.ImagesDir, "IMAGE3.dcm") 
   Dim xmlFileNameOut As String = Path.Combine(LEAD_VARS.ImagesDir, "test.xml") 
 
   DicomEngine.Startup() 
 
   Dim ds As New DicomDataSet() 
 
   ' Load an existing DICOM file 
   ds.Load(dicomFileNameIn, DicomDataSetLoadFlags.None) 
 
   ' Save as NativeDicomModel 
   Const xmlFlags As DicomDataSetSaveXmlFlags = DicomDataSetSaveXmlFlags.NativeDicomModel Or DicomDataSetSaveXmlFlags.TrimWhiteSpace Or DicomDataSetSaveXmlFlags.BulkDataUuid 
   ds.SaveXml(xmlFileNameOut, xmlFlags) 
 
   ' Load 
   ds.LoadXml(xmlFileNameOut, DicomDataSetLoadXmlFlags.None) 
 
   DicomEngine.Shutdown() 
End Sub 
 
Public NotInheritable Class LEAD_VARS 
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images" 
End Class 

Requirements

Target Platforms

Help Version 20.0.2019.9.19
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Dicom.Common Assembly