Class GorgonWaitOverlay

Functionality to display a translucent (like plexi-glass) panel on top of a control or form with a message and spinning icon to indicate that the system is busy.

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

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, string, string, Image)

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

Declaration
public IWin32Window Show(IWin32Window parentWindow, string title = null, string message = null, Image image = null)
Parameters
Type Name Description
IWin32Window parentWindow

The control or form to use as the parent.
string title

[Optional] The title for the progress meter.
string message

[Optional] A message to display above the progress bar.
Image image

[Optional] A custom image to display on the wait panel control.
Returns
Type Description
IWin32Window

The handle to the wait panel window.
Remarks

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

When passing a image, ensure that it is sized to 48x48, otherwise it may cause the panel to look incorrect.

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

Extension Methods