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



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

Syntax

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

Parameters

index
The zero-based index of the overlay being affected.
overlayImage
Image 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 in the passed image.

This method will fail if the image width does not match the "Overlay Columns" (60xx, 0011) or if the image height does not match the "Overlay Rows" (60xx, 0011) for the overlay being updated.

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