GetOverlayImage(DicomDecodingSettings,EventHandler<ProgressEventArgs>) Method (DicomOverlayImage)

In This Topic

Returns an overlay image.

Syntax

Visual Basic
C#
Managed Extensions for C++
C++/CLI

'Declaration

Public Overloads Function GetOverlayImage( _
   ByVal decodingSettingsDecoding settings of DICOM image.
 As Vintasoft.Imaging.Codecs.Decoders.DicomDecodingSettings, _
   ByVal progressDelegateProgress delegate.
 As System.EventHandler(Of ProgressEventArgs) _
) As Vintasoft.Imaging.VintasoftImage

public Vintasoft.Imaging.VintasoftImage GetOverlayImage(
   Vintasoft.Imaging.Codecs.Decoders.DicomDecodingSettings decodingSettings, 
   System.EventHandler<ProgressEventArgs> progressDelegate
)

public: Vintasoft.Imaging.VintasoftImage* GetOverlayImage(
   Vintasoft.Imaging.Codecs.Decoders.DicomDecodingSettings* decodingSettings, 
   System.EventHandler<ProgressEventArgs*>* progressDelegate
)

public:
Vintasoft.Imaging.VintasoftImage^ GetOverlayImage(
   Vintasoft.Imaging.Codecs.Decoders.DicomDecodingSettings^ decodingSettings, 
   System.EventHandler<ProgressEventArgs^>^ progressDelegate
)

Parameters

decodingSettings: Decoding settings of DICOM image.
progressDelegate: Progress delegate.

Return Value

The overlay image associated with DicomFrame object if overlay image was loaded successfully; otherwise, null.

Exceptions

Exception	Description
DicomFileException	Thrown if error occurred while loading of image.
System.ArgumentOutOfRangeException	Thrown if index is less than zero or greater than number of overlay images.

Requirements

Target Platforms: .NET9; .NET 8; .NET 7; .NET 6; .NET Framework 4.8, 4.7, 4.6, 4.5, 4.0, 3.5

Reference

DicomOverlayImage Class
DicomOverlayImage Members

Overload List

Send Feedback