SaveXmlCallback Delegate

C#
Visual Basic
Objective-C
Java
C++

public delegate bool SaveXmlCallback( 
   SaveXmlData data
)

'Declaration

Public Delegate Function SaveXmlCallback( _
   ByVal data As SaveXmlData _
) As Boolean

'Usage

Dim instance As New SaveXmlCallback(AddressOf HandlerMethod)

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.

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

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

C#
Visual Basic
WinRT C#
WinRT JavaScript
Silverlight C#
Silverlight VB

Copy Code

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

<TestMethod()> _
Public Sub SaveXmlCallbackExample()
   Dim dicomFileNameIn As String = Path.Combine(LEAD_VARS.ImagesDir, "IMAGE3.dcm")
   Dim xmlFileNameOut As String = Path.Combine(LEAD_VARS.ImagesDir, "test.xml")
   Dim dicomFileNameOut As String = Path.Combine(LEAD_VARS.ImagesDir, "test.dcm")
      ' Initialize the DICOM engine
   DicomEngine.Startup()

   Dim ds As DicomDataSet = 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
   Dim xmlFlags As DicomDataSetSaveXmlFlags = DicomDataSetSaveXmlFlags.IgnoreBinaryData Or DicomDataSetSaveXmlFlags.TrimWhiteSpace Or DicomDataSetSaveXmlFlags.TagWithCommas

   ds.SaveXml(xmlFileNameOut, xmlFlags, New SaveXmlCallback(AddressOf MySaveXmlCallback))

      ' Use a LoadmlCallback to read the customized XML file
   ds.LoadXml(xmlFileNameOut, DicomDataSetLoadXmlFlags.None, New LoadXmlBeforeElementCallback(AddressOf MyLoadXmlBeforeElementCallback), New LoadXmlAfterElementCallback(AddressOf MyLoadXmlAfterElementCallback))

   ' Save the result -- there will be no pixel data
   ds.Save(dicomFileNameOut, DicomDataSetSaveFlags.None)

   DicomEngine.Shutdown()
End Sub

Private Function MySaveXmlCallback(ByVal data As SaveXmlData) As Boolean
   'string sTag = data.attributes["tag"];
   'if (sTag.StartsWith("0008"))
   '   return false;
   If data.NodeType = DicomXmlNodeType.Comment Then
      data.Comment = "COMMENT: customized xml file using the SaveXmlCallback"
      Return False
   End If

   If data.ElementName = "dataset" Then
      data.Attributes.Add("new_attribute", "some_value")
   ElseIf data.ElementName = "element" Then
      data.ElementName = "element_newname"
      Dim sTagValue As String = data.Attributes("tag")
      data.Attributes.Remove("tag")
      data.Attributes.Add("tag_newname", sTagValue)
   End If
   Return True
End Function

Private Function MyLoadXmlBeforeElementCallback(ByVal data As LoadXmlBeforeElementData) As Boolean
   Dim sTagValue As String = data.Attributes("tag_newname")
   Dim tag As Long = 0
   sTagValue = sTagValue.Replace(",", String.Empty)
   If Long.TryParse(sTagValue, System.Globalization.NumberStyles.HexNumber, Nothing, tag) Then
      data.Tag = tag
   End If
   Return True
End Function

Private Sub MyLoadXmlAfterElementCallback(ByVal data As LoadXmlAfterElementData)
   If data.DicomElement.Tag = DicomTag.PixelData Then
      ' here you could call one of the following to set the pixel data
      '    data.DicomDataSet.SetBinaryValue 
      '    data.DicomDataSet.SetImage()
   End If
End Sub

Public NotInheritable Class LEAD_VARS
Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images"
End Class

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;

[TestMethod]
public void SaveXmlCallbackExample()
{
   string dicomFileNameIn = Path.Combine(LEAD_VARS.ImagesDir, "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:\Users\Public\Documents\LEADTOOLS Images";
}

Target Platforms

Reference