←Select platform

ShowOverlay Property

Summary

Indicates whether to render the optional overlay of the structured display.

Syntax
C#
VB
C++
public bool ShowOverlay { get; set; } 
Public Property ShowOverlay() As Boolean 
   Get 
   Set 
public:  
   property bool ShowOverlay 
   { 
      bool get() 
      void set(bool value) 
   } 

Property Value

true to render the optional overlay; otherwise, false. The default value is true.

Remarks

The [GetStructuredDisplayImage] returns a RasterImage of a DICOM structured display. This a single image that includes all the referenced images laid out as defined in the structured display.

An optional overlay is generated by reading the values for the following DicomTag Members in a DicomDataSet:

The ShowOverlay member indicates whether to render the optional overlay.

Example

For an example, refer to StructuredDisplayImageOptions.

Requirements

Target Platforms

Help Version 21.0.2020.8.24
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Dicom.Common Assembly