Class GorgonProgressPanel
The progress meter panel.
Inheritance
Implements
Inherited Members
Namespace: Gorgon.UI
Assembly: Gorgon.Windows.dll
Syntax
public class GorgonProgressPanel : UserControl, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, IContainerControl
Constructors
| Edit this page View SourceGorgonProgressPanel()
Initializes a new instance of the GorgonProgressPanel class.
Declaration
public GorgonProgressPanel()
Properties
| Edit this page View SourceAllowCancellation
Property to set or return whether cancellation of an operation is supported
Declaration
[Browsable(true)]
public bool AllowCancellation { get; set; }
Property Value
Type | Description |
---|---|
bool |
CurrentValue
Property to set or return the current value for the progress.
Declaration
[Browsable(false)]
public float CurrentValue { get; set; }
Property Value
Type | Description |
---|---|
float |
MeterStyle
Property to set or return the style of the progress meter.
Declaration
[Browsable(true)]
public ProgressBarStyle MeterStyle { get; set; }
Property Value
Type | Description |
---|---|
ProgressBarStyle |
ProgressBoxForeColor
Gets or sets the foreground color of progress message box.
Declaration
[Browsable(true)]
public Color ProgressBoxForeColor { get; set; }
Property Value
Type | Description |
---|---|
Color |
ProgressBoxTitleForeColor
Gets or sets the foreground color of progress message box.
Declaration
[Browsable(true)]
public Color ProgressBoxTitleForeColor { get; set; }
Property Value
Type | Description |
---|---|
Color |
ProgressMessage
Property to set or return the message to display in the progress box.
Declaration
[Browsable(true)]
public string ProgressMessage { get; set; }
Property Value
Type | Description |
---|---|
string |
ProgressMessageFont
Property to set or return the font to use for the progress message.
Declaration
[Browsable(true)]
public Font ProgressMessageFont { get; set; }
Property Value
Type | Description |
---|---|
Font |
ProgressTitle
Property to set or return the title to display in the progress box.
Declaration
[Browsable(true)]
public string ProgressTitle { get; set; }
Property Value
Type | Description |
---|---|
string |
ProgressTitleFont
Property to set or return the font to use for the progress message title.
Declaration
[Browsable(true)]
public Font ProgressTitleFont { get; set; }
Property Value
Type | Description |
---|---|
Font |
Methods
| Edit this page View SourceCancel()
Function to cancel the operation.
Declaration
public void Cancel()
Dispose(bool)
Clean up any resources being used.
Declaration
protected override void Dispose(bool disposing)
Parameters
Type | Name | Description |
---|---|---|
bool | disposing | true if managed resources should be disposed; otherwise, false. |
Overrides
| Edit this page View SourceOnGotFocus(EventArgs)
Raises the GotFocus event.
Declaration
protected override void OnGotFocus(EventArgs e)
Parameters
Type | Name | Description |
---|---|---|
EventArgs | e | An EventArgs that contains the event data. |
Overrides
| Edit this page View SourceOnKeyUp(KeyEventArgs)
Raises the KeyUp event.
Declaration
protected override void OnKeyUp(KeyEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
KeyEventArgs | e | A KeyEventArgs that contains the event data. |
Overrides
| Edit this page View SourceOnLoad(EventArgs)
Raises the Load event.
Declaration
protected override void OnLoad(EventArgs e)
Parameters
Type | Name | Description |
---|---|---|
EventArgs | e | An EventArgs that contains the event data. |
Overrides
Events
| Edit this page View SourceOperationCancelled
Event triggered when an operation is cancelled.
Declaration
public event EventHandler OperationCancelled
Event Type
Type | Description |
---|---|
EventHandler |