GetChildElement Method

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

public DicomElement GetChildElement( 
   DicomElement element,
   bool includeVolatile
)

'Declaration
 
Public Function GetChildElement( _
   ByVal element As DicomElement, _
   ByVal includeVolatile As Boolean _
) As DicomElement

'Usage
 
Dim instance As DicomDataSet
Dim element As DicomElement
Dim includeVolatile As Boolean
Dim value As DicomElement
 
value = instance.GetChildElement(element, includeVolatile)

public DicomElement GetChildElement( 
   DicomElement element,
   bool includeVolatile
)

ObjectiveC Syntax

 function Leadtools.Dicom.DicomDataSet.GetChildElement( 
   element ,
   includeVolatile 
)

public:
DicomElement^ GetChildElement( 
   DicomElement^ element,
   bool includeVolatile
)

Parameters

element: An item in the Data Set.
includeVolatile: true to retrieve the first child element, volatile or non-volatile; false to retrieve the first non-volatile child element.

Return Value

The item in the Data Set that is the first child of the item specified by element, or a null reference (Nothing in Visual Basic) if element has no child items.

The child is the offspring one level lower than the specified item. If the specified item has no child items, this method will return a null reference (Nothing in Visual Basic). For example:

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

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

A volatile element is an element that can be changed or destroyed in the process of inserting or setting an image. A non-volatile element is an element that must be changed manually; it is not changed or destroyed by inserting or setting an image.

For example, a grayscale image has elements DicomTag.SmallestImagePixelValue, DicomTag.LargestImagePixelValue, etc. If the image is changed to a color image, these elements disappear and the following elements appear: DicomTag.RedPaletteColorLookupTableDescriptor, etc. These are volatile elements since they are changed or destroyed when an image is changed or set.

To retrieve a child element that must be changed manually, i.e., is not volatile, set includeVolatile to false. To retrieve a child element that may be either volatile or non-volatile, set includeVolatile to true.

For an example, refer to Load(String,DicomDataSetLoadFlags).

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

DicomDataSet Class
DicomDataSet Members
GetFirstElement Method
GetLastElement Method
GetNextElement Method
GetPreviousElement Method
ModuleCount Property
GetRootElement Method
GetParentElement Method
IsVolatileElement Method