VintaSoft Imaging .NET SDK 14.1: Documentation for .NET developer
Vintasoft.Imaging.Codecs.ImageFiles.Dicom Namespace / DicomOverlayImage Class / GetOverlayImage Methods / GetOverlayImage() Method
Syntax Exceptions Requirements SeeAlso
In This Topic
    GetOverlayImage() Method (DicomOverlayImage)
    In This Topic
    Returns an overlay image.
    Syntax
    'Declaration
    
    Public Overloads Function GetOverlayImage() As Vintasoft.Imaging.VintasoftImage
    
    
    public Vintasoft.Imaging.VintasoftImage GetOverlayImage()
    
    
    public: Vintasoft.Imaging.VintasoftImage* GetOverlayImage()
    
    
    public:
    Vintasoft.Imaging.VintasoftImage^ GetOverlayImage()

    Return Value

    The overlay image associated with DicomFrame object if overlay image was loaded successfully; otherwise, null.
    Exceptions
    ExceptionDescription
    Thrown if error occurred while loading of image.
    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

    See Also