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




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.
Returns the item in the Data Set that is the first child of the specified item.

Syntax

Visual Basic (Declaration) 
Public Function GetChildElement( _
   ByVal element As DicomElement, _
   ByVal includeVolatile As Boolean _
) As DicomElement
Visual Basic (Usage)Copy Code
Dim instance As DicomDataSet
Dim element As DicomElement
Dim includeVolatile As Boolean
Dim value As DicomElement
 
value = instance.GetChildElement(element, includeVolatile)
C# 
public DicomElement GetChildElement( 
   DicomElement element,
   bool includeVolatile
)
Managed Extensions for C++ 
public: DicomElement* GetChildElement( 
   DicomElement* element,
   bool includeVolatile
) 
C++/CLI 
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.

Example

For an example, refer to Load.

Remarks

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 1null
Item 2Item 3
Item 4Item 5
Item 6null

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

GetFirstElement

GetLastElement

GetNextElement

GetParentElement

GetRootElement

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 DicomTagType.SmallestImagePixelValue, DicomTagType.LargestImagePixelValue, etc. If the image is changed to a color image, these elements disappear and the following elements appear: DicomTagType.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.

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