←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.2021.6.30
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Dicom.Common Assembly
Introduction
Getting Started
Namespaces
Leadtools.Dicom.Common.Anonymization Namespace
Leadtools.Dicom.Common.Attributes Namespace
Leadtools.Dicom.Common.Communication Namespace
Leadtools.Dicom.Common.Compare Namespace
Leadtools.Dicom.Common.DataTypes.HangingProtocol Namespace
Leadtools.Dicom.Common.DataTypes.MediaCreation Namespace
Leadtools.Dicom.Common.DataTypes.Modality Namespace
Leadtools.Dicom.Common.DataTypes Namespace
Leadtools.Dicom.Common.DataTypes.PatientUpdater Namespace
Leadtools.Dicom.Common.DataTypes.Status Namespace
Leadtools.Dicom.Common.Editing.Controls Namespace
Leadtools.Dicom.Common.Editing.Converters Namespace
Leadtools.Dicom.Common.Editing Namespace
Leadtools.Dicom.Common.Editing.UI Namespace
Leadtools.Dicom.Common.Extensions Namespace
Leadtools.Dicom.Common.HighLevelServices Namespace
Leadtools.Dicom.Common.Linq.BasicDirectory Namespace
Leadtools.Dicom.Common.Linq Namespace
Leadtools.Dicom.Common.Medical Namespace
Leadtools.Dicom.Common.Validation Namespace
Assemblies
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.