LEADTOOLS Medical (Leadtools.Dicom assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
SetOverlayImages Method
See Also 
Leadtools.Dicom Namespace > DicomDataSet Class : SetOverlayImages Method



index
The zero-based index of the overlay being affected.
overlayImages
Images which will be used to update the overlay data. Cannot be null.
index
The zero-based index of the overlay being affected.
overlayImages
Images which will be used to update the overlay data. Cannot be null.
Sets the "Overlay Data" (60xx,3000) for the specified overlay index. Supported in Silverlight, Windows Phone 7.

Syntax

Visual Basic (Declaration) 
Public Sub SetOverlayImages( _
   ByVal index As Integer, _
   ByVal overlayImages As RasterImage _
) 
Visual Basic (Usage)Copy Code
Dim instance As DicomDataSet
Dim index As Integer
Dim overlayImages As RasterImage
 
instance.SetOverlayImages(index, overlayImages)
C# 
public void SetOverlayImages( 
   int index,
   RasterImage overlayImages
)
C++/CLI 
public:
void SetOverlayImages( 
   int index,
   RasterImage^ overlayImages
) 

Parameters

index
The zero-based index of the overlay being affected.
overlayImages
Images which will be used to update the overlay data. Cannot be null.

Example

For an example, refer to OverlayCount.

Remarks

This method will update the stream of bytes under the "Overlay Data" (60xx, 3000) element with the data of the images included in overlayImages.

Before calling this method, you must call DicomDataSet.SetOverlayAttributes to set the attributes of the image you are trying to update. Make sure that the number of images in overlayImages does not exceed the value of the "Number of Frames in Overlay" (60xx,0015) element.

Requirements

Target Platforms: Silverlight 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7, MAC OS/X (Intel Only)

See Also

Leadtools.Dicom requires a Medical toolkit server license and unlock key. For more information, refer to: Imaging Pro/Document/Medical Features