LoadXml(DicomDataSet,String,DicomDataSetLoadXmlFlags,LoadXmlBeforeElementCallback,LoadXmlAfterElementCallback) Method

Loads the contents of a DICOM encoded xml file

Syntax

Visual Basic
C#
WinRT C#
WinRT JavaScript
C++

[ExtensionAttribute()]
public static void LoadXml( 
   DicomDataSet ds,
   string fileName,
   DicomDataSetLoadXmlFlags xmlFlags,
   LoadXmlBeforeElementCallback cbBefore,
   LoadXmlAfterElementCallback cbAfter
)

'Declaration
 
<ExtensionAttribute()>
Public Overloads Shared Sub LoadXml( _
   ByVal ds As DicomDataSet, _
   ByVal fileName As String, _
   ByVal xmlFlags As DicomDataSetLoadXmlFlags, _
   ByVal cbBefore As LoadXmlBeforeElementCallback, _
   ByVal cbAfter As LoadXmlAfterElementCallback _
)

'Usage
 
Dim ds As DicomDataSet
Dim fileName As String
Dim xmlFlags As DicomDataSetLoadXmlFlags
Dim cbBefore As LoadXmlBeforeElementCallback
Dim cbAfter As LoadXmlAfterElementCallback
 
DicomExtensions.LoadXml(ds, fileName, xmlFlags, cbBefore, cbAfter)

[ExtensionAttribute()]
public static void LoadXml( 
   DicomDataSet ds,
   string fileName,
   DicomDataSetLoadXmlFlags xmlFlags,
   LoadXmlBeforeElementCallback cbBefore,
   LoadXmlAfterElementCallback cbAfter
)

ExtensionAttribute()
 function Leadtools.Dicom.Common.Extensions.DicomExtensions.LoadXml(DicomDataSet,String,DicomDataSetLoadXmlFlags,LoadXmlBeforeElementCallback,LoadXmlAfterElementCallback)( 
   ds ,
   fileName ,
   xmlFlags ,
   cbBefore ,
   cbAfter 
)

[ExtensionAttribute()]
public:
static void LoadXml( 
   DicomDataSet^ ds,
   String^ fileName,
   DicomDataSetLoadXmlFlags xmlFlags,
   LoadXmlBeforeElementCallback^ cbBefore,
   LoadXmlAfterElementCallback^ cbAfter
)

Parameters

ds: The Data Set that will be created and populated with the contents of the DICOM xml input file
fileName: The name of the input xml file
xmlFlags: Flags that affect whether to ignore binary or all data from the DICOM xml input file
cbBefore: Optional callback that allows you to modify how the input xml file elements, attributes, and values are used.
cbAfter: Optional callback that allows you to change the Leadtools.Dicom.DicomElement after it has been added to the Leadtools.Dicom.DicomDataSet.

Remarks

Use this method to read the contents of a DICOM xml file. The DICOM xml file can be created using SaveXml(DicomDataSet,Stream,DicomDataSetSaveXmlFlags,SaveXmlCallback) By default, all binary data is read from the DICOM input xml file, but this behavior can be modified by passing appropriate DicomDataSetLoadXmlFlags

The way the that this method processes the input xml file elements, attributes, and element values can be customized by passing the optional LoadXmlBeforeElementCallback delegate. For more information on this, see the documentation and example for LoadXmlBeforeElementCallback. The Leadtools.Dicom.DicomElement themselves can be modified after they have been added to the Leadtools.Dicom.DicomDataSet by passing the optional LoadXmlAfterElementCallback delegate. For more information on this, see the documentation and example for LoadXmlAfterElementCallback.

Example

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

Copy Code

Public Sub LoadXmlExample()
      Dim dicomFileNameIn As String = Path.Combine(LEAD_VARS.ImagesDir, "IMAGE3.dcm")
      Dim xmlFileNameOut As String = Path.Combine(LEAD_VARS.ImagesDir, "test.xml")

      ' Initialize DICOM engine
      DicomEngine.Startup()

      Dim ds As DicomDataSet = New DicomDataSet()

      ' Load an existing DICOM file
      ds.Load(dicomFileNameIn, DicomDataSetLoadFlags.None)

      ' Save as XML with no binary data
      ' For the demo, keep the xml output file size small by skipping the pixel data
      Dim xmlFlags As DicomDataSetSaveXmlFlags = DicomDataSetSaveXmlFlags.IgnoreBinaryData Or DicomDataSetSaveXmlFlags.TrimWhiteSpace Or DicomDataSetSaveXmlFlags.TagWithCommas
      ds.SaveXml(xmlFileNameOut, xmlFlags)

      ' Now reload the xml file.  
      ' Note that there will not be an image because we skipped the pixel data in the save
      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

public void LoadXmlExample()
   {
      string dicomFileNameIn = Path.Combine(LEAD_VARS.ImagesDir, "IMAGE3.dcm");
      string xmlFileNameOut = Path.Combine(LEAD_VARS.ImagesDir, "test.xml");

      // Initialize DICOM engine
      DicomEngine.Startup();

      DicomDataSet ds = new DicomDataSet();

      // Load an existing DICOM file
      ds.Load(dicomFileNameIn, DicomDataSetLoadFlags.None);

      // Save as XML with no binary data
      // For the demo, keep the xml output file size small by skipping the pixel data
      DicomDataSetSaveXmlFlags xmlFlags =
         DicomDataSetSaveXmlFlags.IgnoreBinaryData |
         DicomDataSetSaveXmlFlags.TrimWhiteSpace |
         DicomDataSetSaveXmlFlags.TagWithCommas;
      ds.SaveXml(xmlFileNameOut, xmlFlags);

      // Now reload the xml file.  
      // Note that there will not be an image because we skipped the pixel data in the save
      ds.LoadXml(xmlFileNameOut, DicomDataSetLoadXmlFlags.None);

      DicomEngine.Shutdown();
   }

static class LEAD_VARS
{
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images";
}

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

DicomExtensions Class
DicomExtensions Members
Overload List
LoadXml(DicomDataSet,String,DicomDataSetLoadXmlFlags,LoadXmlBeforeElementCallback,LoadXmlAfterElementCallback) Method
LoadXml(DicomDataSet,Stream,DicomDataSetLoadXmlFlags,LoadXmlBeforeElementCallback,LoadXmlAfterElementCallback) Method
LoadXml(DicomDataSet,String,DicomDataSetLoadXmlFlags) Method
LoadXml(DicomDataSet,Stream,DicomDataSetLoadXmlFlags) Method
SaveXml(DicomDataSet,String,DicomDataSetSaveXmlFlags,SaveXmlCallback) Method
SaveXml(DicomDataSet,Stream,DicomDataSetSaveXmlFlags,SaveXmlCallback) Method
SaveXml(DicomDataSet,String,DicomDataSetSaveXmlFlags) Method
SaveXml(DicomDataSet,Stream,DicomDataSetSaveXmlFlags) Method
SaveXmlCallback Delegate
LoadXmlBeforeElementCallback Delegate
LoadXmlAfterElementCallback Delegate