LoadXmlAsync Method (DicomIodTable)

C#
Visual Basic
WinRT C#
Objective-C
Java
WinRT JavaScript
C++

public IAsyncAction LoadXmlAsync( 
   ILeadStream stream
)

'Declaration

Public Function LoadXmlAsync( _
   ByVal stream As ILeadStream _
) As IAsyncAction

'Usage

Dim instance As DicomIodTable
Dim stream As ILeadStream
Dim value As IAsyncAction
 
value = instance.LoadXmlAsync(stream)

public IAsyncAction LoadXmlAsync( 
   ILeadStream stream
)

 function Leadtools.Dicom.DicomIodTable.LoadXmlAsync( 
   stream 
)

public:
IAsyncAction^ LoadXmlAsync( 
   ILeadStream^ stream
)

Parameters

stream: A Stream that contains the name of the XML file containing the DICOM IODs and modules to load

Return Value

An asynchronous load operation on a DicomIodTable object.

Quickly and easily customize the DICOM IOD table by editing the dicTableIodModule.xml file that is found in the LEADTOOLS Sample Images folder. The dicTableIodModule.xml file is a human-readable XML file that lists all of the DICOM IODs and DICOM Modules currently defined in the DICOM Specification. You can edit this with any text editor (for example, notepad) to add or remove DICOM IODs and modules. Then call LoadXml and pass the full path of the dicTableIodModule.xml file, or pass a Stream containing the contents of this file. Note that calling LoadXml will first remove all DICOM IODs and modules that are already present in the table.

For more information, see the topic Working with DICOM Tables

This example loads the DICOM IOD table from the dicTableIodModule.xml file that is shipped with the toolkit.

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

Copy Code

Imports Leadtools
Imports Leadtools.Dicom

<TestMethod()> _
Public Sub TestDicomIodTable_LoadXml_Stream()
   DicomEngine.Startup()
   DicomIodTable.Instance.Reset()

   ' Since the table is empty, the count is zero.
   Dim count As Integer = 0
   Dim iod As DicomIod = DicomIodTable.Instance.GetFirst(Nothing, True)
   Do While iod IsNot Nothing
      iod = DicomIodTable.Instance.GetNext(iod, True)
      count += 1
   Loop

   ' Load the IOD table from the dicTableIodModule.xml file that ships with the toolkit
   Using stream As New FileStream("C:\Users\Public\Documents\LEADTOOLS Images\dicTableIodModule.xml", FileMode.Open)
      DicomIodTable.Instance.LoadXml(stream)
   End Using

   ' Get the count -- it will be 158
   iod = DicomIodTable.Instance.GetFirst(Nothing, True)
   Do While iod IsNot Nothing
      iod = DicomIodTable.Instance.GetNext(iod, True)
      count += 1
   Loop

   DicomEngine.Shutdown()
End Sub

using Leadtools;
using Leadtools.Dicom;

[TestMethod]
public void TestDicomIodTable_LoadXml_Stream()
{
   DicomEngine.Startup();
   DicomIodTable.Instance.Reset();

   // Since the table is empty, the count is zero.
   int count = 0;
   DicomIod iod = DicomIodTable.Instance.GetFirst(null, true);
   while (iod != null)
   {
      iod = DicomIodTable.Instance.GetNext(iod, true);
      count++;
   }

   // Load the IOD table from the dicTableIodModule.xml file that ships with the toolkit
   using (FileStream stream = new FileStream(@"C:\Users\Public\Documents\LEADTOOLS Images\dicTableIodModule.xml", FileMode.Open))
   {
      DicomIodTable.Instance.LoadXml(stream);
   }

   // Get the count -- it will be 158
   iod = DicomIodTable.Instance.GetFirst(null, true);
   while (iod != null)
   {
      iod = DicomIodTable.Instance.GetNext(iod, true);
      count++;
   }

   DicomEngine.Shutdown();
}

using Leadtools;
using Leadtools.Dicom;
using Leadtools.Examples;

public void TestDicomIodTable_LoadXml_Stream(FileStream stream)
{
   DicomEngine.Startup();
   DicomIodTable.Instance.Reset();

   // Since the table is empty, the count is zero.
   int count = 0;
   DicomIod iod = DicomIodTable.Instance.GetFirst(null, true);
   while (iod != null)
   {
      iod = DicomIodTable.Instance.GetNext(iod, true);
      count++;
   }

   // Load the IOD table from a stream that contains the contents of dicTableIodModule.xml file that ships with the toolkit
   DicomIodTable.Instance.LoadXml(stream);

   // Get the count -- it will be 158
   iod = DicomIodTable.Instance.GetFirst(null, true);
   while (iod != null)
   {
      iod = DicomIodTable.Instance.GetNext(iod, true);
      count++;
   }

   DicomEngine.Shutdown();
}

Imports Leadtools
Imports Leadtools.Dicom

Public Sub TestDicomIodTable_LoadXml_Stream(ByVal stream As FileStream)
  DicomEngine.Startup()
  DicomIodTable.Instance.Reset()

  ' Since the table is empty, the count is zero.
  Dim count As Integer = 0
  Dim iod As DicomIod = DicomIodTable.Instance.GetFirst(Nothing, True)
  Do While iod IsNot Nothing
    iod = DicomIodTable.Instance.GetNext(iod, True)
    count += 1
  Loop

  ' Load the IOD table from a stream that contains the contents of dicTableIodModule.xml file that ships with the toolkit
  DicomIodTable.Instance.LoadXml(stream)

  ' Get the count -- it will be 158
  iod = DicomIodTable.Instance.GetFirst(Nothing, True)
  Do While iod IsNot Nothing
    iod = DicomIodTable.Instance.GetNext(iod, True)
    count += 1
  Loop

  DicomEngine.Shutdown()
End Sub

Target Platforms

Reference

DicomIodTable Class
DicomIodTable Members
Insert(DicomIod,Boolean,DicomClassType,String,DicomIodType,DicomIodUsageType,String) Method
Delete Method
Reset Method
Default Method