Leadtools.Dicom Requires Medical product license | Send comments on this topic. | Back to Introduction - All Topics | Help Version 15.10.31
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.
Sets the "Overlay Data" (60xx,3000) for the specified overlay index.

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
)
Managed Extensions for 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 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: 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