In This Topic ▼

SaveXmlCallback Delegate

Summary

Optional delegate method that is used with the SaveXml methods.

Syntax

C++/CLI

public delegate bool SaveXmlCallback( 
   SaveXmlData data 
)

public delegate bool SaveXmlCallback(  
   SaveXmlData^ data 
)

Parameters

data
An instance of the SaveXmlData interface containing the progress callback data.

Return Value

true to write this DICOM element to the output XML file; false to skip writing this element to the output XML file.

Remarks

This delegate is called once for each DICOM element before it is written to the XML file.

Example

This example loads a sample DICOM file, and saves the contents as an XML file. The XML file output is customized by using the SaveXmlCallback delegate.

The 'element' is changed to 'element_newname'
The 'tag' attribute is changed to 'tag_newname'
An attribute is added to the 'dataset' element: 'new_attribute'
A comment is added: 'NEW COMMENT: customized XML file using the SaveXmlCallback'

Then the customized XML file is read into a DicomDataSet object using the LoadXmlCallback

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; 
 
using Leadtools.Codecs; 
 
public void SaveXmlCallbackExample() 
{ 
   string dicomFileNameIn = Path.Combine(LEAD_VARS.ImagesDir, "DICOM", "image3.dcm"); 
   string xmlFileNameOut = Path.Combine(LEAD_VARS.ImagesDir, "test.xml"); 
   string dicomFileNameOut = Path.Combine(LEAD_VARS.ImagesDir, "test.dcm"); 
 
   // Initialize DICOM engine 
   DicomEngine.Startup(); 
 
   DicomDataSet ds = new DicomDataSet(); 
 
   // Load an existing DICOM file 
   ds.Load(dicomFileNameIn, DicomDataSetLoadFlags.None); 
 
   // Save as XML to a file with no binary data 
   // For the demo, keep the XML output file size small by skipping the pixel data 
   // Use the SaveXmlCallback delegate to customize the XML file 
   DicomDataSetSaveXmlFlags xmlFlags = 
      DicomDataSetSaveXmlFlags.IgnoreBinaryData | 
      DicomDataSetSaveXmlFlags.TrimWhiteSpace | 
      DicomDataSetSaveXmlFlags.TagWithCommas; 
 
   ds.SaveXml(xmlFileNameOut, xmlFlags, new SaveXmlCallback(MySaveXmlCallback)); 
 
   // Use a LoadmlCallback to read the customized XML file 
   ds.LoadXml(xmlFileNameOut, DicomDataSetLoadXmlFlags.None, new LoadXmlBeforeElementCallback(MyLoadXmlBeforeElementCallback), new LoadXmlAfterElementCallback(MyLoadXmlAfterElementCallback)); 
 
   // Save the result -- there will be no pixel data 
   ds.Save(dicomFileNameOut, DicomDataSetSaveFlags.None); 
 
   DicomEngine.Shutdown(); 
} 
 
private static bool MySaveXmlCallback(SaveXmlData data) 
{ 
   //string sTag = data.attributes["tag"]; 
   //if (sTag.StartsWith("0008")) 
   //   return false; 
   if (data.NodeType == DicomXmlNodeType.Comment) 
   { 
      data.Comment = "COMMENT: customized xml file using the SaveXmlCallback"; 
      return false; 
   } 
 
   if (data.ElementName == "dataset") 
   { 
      data.Attributes.Add("new_attribute", "some_value"); 
   } 
   else if (data.ElementName == "element") 
   { 
      data.ElementName = "element_newname"; 
      string sTagValue = data.Attributes["tag"]; 
      data.Attributes.Remove("tag"); 
      data.Attributes.Add("tag_newname", sTagValue); 
   } 
   return true; 
} 
 
private static bool MyLoadXmlBeforeElementCallback(LoadXmlBeforeElementData data) 
{ 
   string sTagValue = data.Attributes["tag_newname"]; 
   long tag = 0; 
   sTagValue = sTagValue.Replace(",", string.Empty); 
   if (long.TryParse(sTagValue, System.Globalization.NumberStyles.HexNumber, null, out tag)) 
      data.Tag = tag; 
   return true; 
} 
 
private static void MyLoadXmlAfterElementCallback(LoadXmlAfterElementData data) 
{ 
   if (data.DicomElement.Tag == DicomTag.PixelData) 
   { 
      // here you could call one of the following to set the pixel data 
      //    data.DicomDataSet.SetBinaryValue  
      //    data.DicomDataSet.SetImage() 
   } 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS22\Resources\Images"; 
}