Class GorgonOverlay

Functionality to display a translucent (like plexi-glass) panel on top of a control or form.

Inheritance
object
GorgonOverlay
Inherited Members
Namespace: Gorgon.UI
Assembly: Gorgon.Windows.dll
Syntax
public class GorgonOverlay

Properties

| Edit this page View Source

IsActive

Property to return whether the overlay is active or not.

Declaration
public bool IsActive { get; }
Property Value
Type Description
bool
| Edit this page View Source

OverlayColor

Property to set or return the color of the overlay.

Declaration
public GorgonColor OverlayColor { get; set; }
Property Value
Type Description
GorgonColor
| Edit this page View Source

TransparencyPercent

Property to set or return the amount of transparency.

Declaration
public int TransparencyPercent { get; set; }
Property Value
Type Description
int

Methods

| Edit this page View Source

Hide()

Function to hide an active overlay.

Declaration
public void Hide()
| Edit this page View Source

Show(IWin32Window)

Function to show the overlay on top of a control/form.

Declaration
public IWin32Window Show(IWin32Window parentWindow)
Parameters
Type Name Description
IWin32Window parentWindow

The control or form to use as the parent.
Returns
Type Description
IWin32Window

The handle for the overlay.
Remarks

This will only show a single overlay at a time, and multiple overlays are not supported.

Passing null to the parentWindow parameter is the same as calling Hide().

Extension Methods