FindNextDescendant Method

public DicomElement FindNextDescendant( 
   DicomElement parentElement,
   DicomElement childElement,
   bool nextLevelOnly
)

'Declaration
 

Public Function FindNextDescendant( _
   ByVal parentElement As DicomElement, _
   ByVal childElement As DicomElement, _
   ByVal nextLevelOnly As Boolean _
) As DicomElement

'Usage
 

Dim instance As DicomDataSet
Dim parentElement As DicomElement
Dim childElement As DicomElement
Dim nextLevelOnly As Boolean
Dim value As DicomElement
 
value = instance.FindNextDescendant(parentElement, childElement, nextLevelOnly)

public DicomElement FindNextDescendant( 
   DicomElement parentElement,
   DicomElement childElement,
   bool nextLevelOnly
)

 function Leadtools.Dicom.DicomDataSet.FindNextDescendant( 
   parentElement ,
   childElement ,
   nextLevelOnly 
)

public:
DicomElement^ FindNextDescendant( 
   DicomElement^ parentElement,
   DicomElement^ childElement,
   bool nextLevelOnly
) 

Parameters

parentElement

a parent item in the Data Set.

childElement

a child item of the parentElement

nextLevelOnly

if set to true search for items in the next level only; otherwise search for items recursively in all the next levels.

Return Value

Note: This function does not specify a tag to use when searching. However the tag that was used in the last call to FindFirstDescendant is used by default when searching.

This method finds the next descendant of the parentElement element that has a DICOM tag equivalent to the tag argument (FindFirstDescendant), where the entire search is rooted at the Parent element (i.e. parentElement).

The diagram below represents DICOM elements stored in a DICOM dataset.

Behavior when nextLevelOnly is true
Returns the next element on the next level of parentElement with that has a tag equivalent to the tag argument in the previous call of FindFirstDescendant. Elements included in the search include child elements in the next level only.

Example 1
nextLevelOnly is true
parentElement points to element 1
childElement points to element 8
Searches elements 11, 12 and returns the first element that matches the tag argument used in the previous call to FindFirstDescendant.

Example 2 nextLevelOnly is true
parentElement points to element 2
childElement points to element 3
Searches elements 4, 7 and returns the first element that matches the tag argument used in the previous call to FindFirstDescendant.

Example 3
nextLevelOnly is true
parentElement points to element 4
childElement points to element 5
Searches element 6 only, and returns element 6 if it has a tag equivalent to the tag argument used in the previous call to FindFirstDescendant.

Example 4
nextLevelOnly is true
parentElement points to element 11
childElement points to element 12
Returns null

Behavior when nextLevelOnly is false:
Returns the next element that matches the tag argument used in the previous call to FindFirstDescendant, using a pre-order search algorithm rooted at parentElement.

Example 5
nextLevelOnly is false
parentElement points to element 1
childElement points to element 4
Searches elements 5, 6, 7, 8, 9, 10, 11, 12 and returns the first element that has a tag equivalent to the tag argument used in the previous call to FindFirstDescendant.

Example 6
nextLevelOnly is false
parentElement points to element 2
childElement points to element 4
Searches elements 5, 6, 7 and returns the first element that has a tag equivalent to the tag argument used in the previous call to FindFirstDescendant.

Example 7
nextLevelOnly is false
parentElement points to element 4
childElement points to element 5
Searches element 6 only, and returns element 6 if is has a tag equivalent to the tag argument used in the previous call to FindFirstDescendant.

The following methods will also help you find elements in the Data Set with a specific Tag:

FindFirstDescendant

FindFirstElement

FindLastElement

FindPreviousElement

FindNextElement

The following methods will help you find specific modules in the Data Set:

FindModule

FindModuleByIndex

Target Platforms

Reference

DicomDataSet Class
DicomDataSet Members
FindNextDescendant Method
FindFirstElement Method
FindLastElement Method
FindPreviousElement Method
FindNextElement Method
FindModule Method
FindModuleByIndex Method