Click or drag to resize

ProgressDialog Class

Represents a dialog that can be used to report progress to the user.
Inheritance Hierarchy

Namespace:  Ookii.Dialogs.Wpf
Assembly:  Ookii.Dialogs.Wpf (in Ookii.Dialogs.Wpf.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
public class ProgressDialog : Component

The ProgressDialog type exposes the following members.

Constructors
  NameDescription
Public methodProgressDialog
Initializes a new instance of the ProgressDialog class.
Public methodProgressDialog(IContainer)
Initializes a new instance of the ProgressDialog class, adding it to the specified container.
Top
Properties
  NameDescription
Public propertyAnimation
Gets or sets the animation to show on the progress dialog.
Public propertyCancellationPending
Gets a value indicating whether the user has requested cancellation of the operation.
Public propertyCancellationText
Gets or sets the text that will be shown after the Cancel button is pressed.
Protected propertyCanRaiseEvents
Gets a value indicating whether the component can raise an event.
(Inherited from Component.)
Public propertyContainer
Gets the IContainer that contains the Component.
(Inherited from Component.)
Public propertyDescription
Gets or sets additional details about the operation being carried out.
Protected propertyDesignMode
Gets a value that indicates whether the Component is currently in design mode.
(Inherited from Component.)
Protected propertyEvents
Gets the list of event handlers that are attached to this Component.
(Inherited from Component.)
Public propertyIsBusy
Gets a value that indicates whether the ProgressDialog is running an asynchronous operation.
Public propertyMinimizeBox
Gets or sets a value that indicates whether the progress dialog has a minimize button.
Public propertyProgressBarStyle
Gets or sets a value that indicates whether a regular or marquee style progress bar should be used.
Public propertyShowCancelButton
Gets or sets a value that indicates whether the dialog has a cancel button.
Public propertyShowTimeRemaining
Gets or sets a value that indicates whether an estimate of the remaining time will be shown.
Public propertySite
Gets or sets the ISite of the Component.
(Inherited from Component.)
Public propertyText
Gets or sets a short description of the operation being carried out.
Public propertyUseCompactPathsForDescription
Gets or sets a value that indicates whether path strings in the Description property should be compacted if they are too large to fit on one line.
Public propertyUseCompactPathsForText
Gets or sets a value that indicates whether path strings in the Text property should be compacted if they are too large to fit on one line.
Public propertyWindowTitle
Gets or sets the text in the progress dialog's title bar.
Top
Methods
  NameDescription
Public methodCreateObjRef
Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
(Inherited from MarshalByRefObject.)
Public methodDispose
Releases all resources used by the Component.
(Inherited from Component.)
Protected methodDispose(Boolean)
Clean up any resources being used.
(Overrides ComponentDispose(Boolean).)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection.
(Inherited from Component.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetLifetimeService
Retrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Protected methodGetService
Returns an object that represents a service provided by the Component or by its Container.
(Inherited from Component.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInitializeLifetimeService
Obtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodMemberwiseClone(Boolean)
Creates a shallow copy of the current MarshalByRefObject object.
(Inherited from MarshalByRefObject.)
Protected methodOnDoWork
Raises the DoWork event.
Protected methodOnProgressChanged
Raises the ProgressChanged event.
Protected methodOnRunWorkerCompleted
Raises the RunWorkerCompleted event.
Public methodReportProgress(Int32)
Updates the dialog's progress bar.
Public methodReportProgress(Int32, String, String)
Updates the dialog's progress bar.
Public methodReportProgress(Int32, String, String, Object)
Updates the dialog's progress bar.
Public methodShow
Displays the progress dialog as a modeless dialog.
Public methodShow(Object)
Displays the progress dialog as a modeless dialog.
Public methodShowDialog
Displays the progress dialog as a modal dialog.
Public methodShowDialog(Window)
Displays the progress dialog as a modal dialog.
Public methodShowDialog(Window, Object)
Displays the progress dialog as a modal dialog.
Public methodToString
Returns a String containing the name of the Component, if any. This method should not be overridden.
(Inherited from Component.)
Top
Events
  NameDescription
Public eventDisposed
Occurs when the component is disposed by a call to the Dispose method.
(Inherited from Component.)
Public eventDoWork
Event raised when the dialog is displayed.
Public eventProgressChanged
Event raised when ReportProgress(Int32, String, String, Object) is called.
Public eventRunWorkerCompleted
Event raised when the operation completes.
Top
Remarks

This class provides a wrapper for the native Windows IProgressDialog API.

The ProgressDialog class requires Windows 2000, Windows Me, or newer versions of Windows.

Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also