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




element
An item in the Data Set.
tree
true to evaluate the Data Set as a tree; false to evaluate the Data Set as a list.
Returns the first item in the Dicom Dir Data Set.

Syntax

Visual Basic (Declaration) 
Public Function GetFirstKey( _
   ByVal element As DicomElement, _
   ByVal tree As Boolean _
) As DicomElement
Visual Basic (Usage)Copy Code
Dim instance As DicomDataSet
Dim element As DicomElement
Dim tree As Boolean
Dim value As DicomElement
 
value = instance.GetFirstKey(element, tree)
C# 
public DicomElement GetFirstKey( 
   DicomElement element,
   bool tree
)
Managed Extensions for C++ 
public: DicomElement* GetFirstKey( 
   DicomElement* element,
   bool tree
) 
C++/CLI 
public:
DicomElement^ GetFirstKey( 
   DicomElement^ element,
   bool tree
) 

Parameters

element
An item in the Data Set.
tree
true to evaluate the Data Set as a tree; false to evaluate the Data Set as a list.

Return Value

The first item in the Data Set, or a null reference (Nothing in Visual Basic) if the Data Set is empty.

Example

For an example, refer to Reset.

Remarks

If the Data Set is evaluated as a tree structure, this method returns the first item on the same level as element with the same parent as element. Please note that the numbering of the items in this first 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 4
Item 5Item 5
Item 6Item 7
nullItem 2

If the Data Set is evaluated as a list, the first item in the list is returned. Please note that the numbering of the items in the following illustration does indicate the order of the items when the Data Set is evaluated as a list.

If the passed object points to:The method returns an object pointing to:
nullItem 1
Item 12Item 1
Item 14Item 1
Item 22Item 1
Item 25Item 1

The following methods will also help you navigate the Data Set as either a tree or a list:

GetLastKey

GetNextKey

GetPreviousKey

If you evaluate the Data Set as a tree, you can also use the following methods to navigate the tree:

GetRootKey

GetParentKey

GetChildKey

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also

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