LEADTOOLS Medical (Leadtools.Dicom assembly)
Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.5.11.19
| Leadtools.Dicom Namespace > DicomDataSet Class : GetFirstElement Method |
public DicomElement GetFirstElement( DicomElement element, bool tree, bool includeVolatile )
'Declaration Public Function GetFirstElement( _ ByVal element As DicomElement, _ ByVal tree As Boolean, _ ByVal includeVolatile As Boolean _ ) As DicomElement
'Usage Dim instance As DicomDataSet Dim element As DicomElement Dim tree As Boolean Dim includeVolatile As Boolean Dim value As DicomElement value = instance.GetFirstElement(element, tree, includeVolatile)
public DicomElement GetFirstElement( DicomElement element, bool tree, bool includeVolatile )
ObjectiveC Syntax
function Leadtools.Dicom.DicomDataSet.GetFirstElement( element , tree , includeVolatile )
public: DicomElement^ GetFirstElement( DicomElement^ element, bool tree, bool includeVolatile )
| 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 this 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:
If you evaluate the Data Set as a tree, you can also use the following methods to navigate the tree:
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 the first element that must be changed manually, i.e., is not volatile, set includeVolatile to false. To retrieve the first element, either volatile or non-volatile, set includeVolatile to true.
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