Leadtools.Dicom Requires Medical product license | Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
GetRootKey Method
See Also 
Leadtools.Dicom Namespace > DicomDataSet Class : GetRootKey Method



element
An item in the Data Set.
element
An item in the Data Set.
Returns the root of the specified item.

Syntax

Visual Basic (Declaration) 
Public Function GetRootKey( _
   ByVal element As DicomElement _
) As DicomElement
Visual Basic (Usage)Copy Code
Dim instance As DicomDataSet
Dim element As DicomElement
Dim value As DicomElement
 
value = instance.GetRootKey(element)
C# 
public DicomElement GetRootKey( 
   DicomElement element
)
C++/CLI 
public:
DicomElement^ GetRootKey( 
   DicomElement^ element
)

Parameters

element
An item in the Data Set.

Return Value

The item in the Data Set that is the root of the item specified by element, or a null reference (Nothing in Visual Basic) if the Data Set is empty or element is null.

Example

For an example, refer to Reset.

Remarks

The root is the Level 0 ancestor of element. If element points to an item on Level 0, the returned object points to that same item. Please note that the numbering of the items in the following illustration is arbitrary and does not imply order.

If the passed object points to:The method returns an object pointing to:
Item 1Item 2
Item 3Item 2
Item 4Item 4
Item 5Item 6

The following methods will also help you navigate the Data Set:

GetFirstKey

GetLastKey

GetNextKey

GetParentKey

GetChildKey

Requirements

Target Platforms: Microsoft .NET Framework 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family

See Also

Leadtools.Dicom requires a Medical toolkit server license and unlock key. For more information, refer to: Imaging Pro/Document/Medical Features