Show/Hide TOC

DevProgressDialog Class

Represents a system progress dialog.

This control is a generic way to show a user how an operation is progressing.

It is typically used when deleting, uploading, copying, moving, or downloading large numbers of files.

The dialog is shown on a separate thread and will not block operations in the current thread.

Definition

Namespace: DevCase.UI.Dialogs
Assembly: DevCase.net48 (in DevCase.net48.dll) Version: 6.0.0.0 (6.0)
XMLNS for XAML: Not mapped to an xmlns.

C#Request Example

[ToolboxBitmapAttribute(typeof(ProgressBar), "ProgressBar.bmp")]
[DefaultPropertyAttribute("Title")]
public class DevProgressDialog : Component

VBRequest Example

<ToolboxBitmapAttribute(GetType(ProgressBar), "ProgressBar.bmp")>
<DefaultPropertyAttribute("Title")>
Public Class DevProgressDialog
	Inherits Component

Dim instance As DevProgressDialog

C++Request Example

[ToolboxBitmapAttribute(typeof(ProgressBar), L"ProgressBar.bmp")]
[DefaultPropertyAttribute(L"Title")]
public ref class DevProgressDialog : public Component

F#Request Example

[<ToolboxBitmapAttribute(typeof(ProgressBar), "ProgressBar.bmp")>]
[<DefaultPropertyAttribute("Title")>]
type DevProgressDialog = 
    class
        inherit Component
    end

ASP.NETRequest Example

No code example is currently available or this language may not be supported.

Inheritance: Object MarshalByRefObject Component DevProgressDialog

Example

This is a code example.

C#

No code example is currently available or this language may not be supported.

VB

Dim dlg As New DevProgressDialog With {
    .Title = "Title",
    .Description = "Description",
    .Detail = "Detail...",
    .CancelMessage = "Canceling. Please wait...",
    .AutoTimeEstimation = True,
    .CompactStrings = True,
    .HideTimeRemaining = False,
    .MinimizeBox = True,
    .Modal = True,
    .ShowCancelButton = True,
    .Style = DevProgressDialogStyle.Normal
}

Dim window As IWin32Window = Me
dlg.Start(window)

Dim current As ULong = 0
Dim total As ULong = 100

For i As ULong = 0 To total
    If (dlg.IsCancelled) Then
        Exit For
    End If

    Thread.Sleep(100)
    dlg.UpdateProgress(i, total)
    Application.DoEvents()

Next

dlg.Stop()

C++

No code example is currently available or this language may not be supported.

F#

No code example is currently available or this language may not be supported.

XAML

No code example is currently available or this language may not be supported.

ASP.NET

No code example is currently available or this language may not be supported.

Constructors

DevProgressDialog

Initializes a new instance of the DevProgressDialog class.

Properties

AutoTimeEstimation	Gets or sets a value indicating whether to automatically estimate the remaining time and display it.
CancelMessage	Gets or sets a message to be displayed if the user cancels the operation.
CompactStrings	Gets or sets a value indicating whether to compact displayed strings if they are too large to fit on a line.
Container	Gets the IContainer that contains the Component. (Inherited from Component)
Description	Gets or sets the description that appears on the first line.
Detail	Gets or sets the detail that appears on the second line.
HideTimeRemaining	Gets or sets a value indicating whether to show the "time remaining" text.
IsCancelled	Gets a value that determine whether the user has canceled the progress operation.
MinimizeBox	Gets or sets a value indicating whether the Minimize button is displayed in the caption bar of the progress dialog.
Modal	Gets a value indicating whether this form is displayed modally.
ShowCancelButton	Gets or sets a value indicating whether a Cancel button is displayed on the progress dialog.
Site	Gets or sets the ISite of the Component. (Inherited from Component)
Style	Gets or sets the style of the progress bar on the progress dialog.
Title	Gets or sets the progress dialog box title.

Methods

CreateObjRef	Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject)
Dispose	Releases all resources used by the Component. (Inherited from Component)
Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode	Serves as the default hash function. (Inherited from Object)
GetLifetimeService	Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject)
GetType	Gets the Type of the current instance. (Inherited from Object)
InitializeLifetimeService	Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject)
Start	Starts the progress dialog box.
Stop	Stops the progress dialog box and removes it from the screen.
ToString	Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component)
UpdateProgress	Updates the progress dialog box with the current state of the operation.

Events

Disposed

Occurs when the component is disposed by a call to the Dispose method.
(Inherited from Component)

Extension Methods

CanConvertTo	Determines whether the source object can be converted to the specified target type. (Defined by ObjectExtensions)
CanConvertToT	Determines whether the source object can be converted to the specified target type. (Defined by ObjectExtensions)
ConvertToT	Converts an object to the specified target type. If the conversion fails, an exception is thrown. (Defined by ObjectExtensions)
ConvertToT	Converts an object to the specified target type. If the conversion fails, returns the specified default value. (Defined by ObjectExtensions)
GetEvent	Gets a EventInfo that match the specified event name declared in the source Component. (Defined by ComponentExtensions)
GetEventHandlers	Gets all the delegates associated to the specified event raised by the source Component. (Defined by ComponentExtensions)
GetEvents	Gets all the events declared in the source Component. (Defined by ComponentExtensions)
GetSubscribedEvents	Gets a list of events declared in the source Component that are subscribed to a event-handler. (Defined by ComponentExtensions)
InvokeUITypeEditorT	Invokes the default UITypeEditor to edit the specified property. (Defined by ComponentExtensions)
InvokeUITypeEditorT	Invokes the default UITypeEditor to edit the specified property. (Defined by ComponentExtensions)
IsDisposable	Determines whether the specified object is a disposable type (i.e., it implements IDisposable interface). (Defined by ObjectExtensions)
Speak	Speaks the string representation of the source object by using the operating system integrated text-to-speech synthesizer. (Defined by ObjectExtensions)
Speak	Speaks the string representation of the source object by using the operating system integrated text-to-speech synthesizer. (Defined by ObjectExtensions)
ThrowIfNullTException	Throws the specified exception if the source object is null. (Defined by ObjectExtensions)
TryGetEvent	Tries to get a EventInfo that match the specified event name declared in the source Component. (Defined by ComponentExtensions)