←Select platform

GetFirstKey Method

Summary

Returns the first item in the Dicom Dir Data Set.

Syntax

C#
VB
Java
WinRT C#
C++
public DicomElement GetFirstKey( 
   DicomElement element, 
   bool tree 
) 
Public Function GetFirstKey( _ 
   ByVal element As Leadtools.Dicom.DicomElement, _ 
   ByVal tree As Boolean _ 
) As Leadtools.Dicom.DicomElement 
public DicomElement getFirstKey(DicomElement element, boolean tree) 
 function Leadtools.Dicom.DicomDataSet.GetFirstKey(  
   element , 
   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 VB) if the Data Set is empty.

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 1 Item 2
Item 3 Item 4
Item 5 Item 5
Item 6 Item 7
null Item 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:
null Item 1
Item 12 Item 1
Item 14 Item 1
Item 22 Item 1
Item 25 Item 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

Example

For an example, refer to Reset.

Requirements

Target Platforms

Help Version 19.0.2017.10.27
Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Dicom Assembly