ProgressDialog Class

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

Inheritance Hierarchy

SystemObject
  SystemMarshalByRefObject
    System.ComponentModelComponent
      Ookii.DialogsProgressDialog

Namespace: Ookii.Dialogs
Assembly: Ookii.Dialogs (in Ookii.Dialogs.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

C++

Copy

public class ProgressDialog : Component

Public Class ProgressDialog
	Inherits Component

public ref class ProgressDialog : public Component

type ProgressDialog =  
    class
        inherit Component
    end

The ProgressDialog type exposes the following members.

Constructors

	Name	Description
	ProgressDialog	Initializes a new instance of the ProgressDialog class.
	ProgressDialog(IContainer)	Initializes a new instance of the ProgressDialog class, adding it to the specified container.

Top

Properties

	Name	Description
	Animation	Gets or sets the animation to show on the progress dialog.
	CancellationPending	Gets a value indicating whether the user has requested cancellation of the operation.
	CancellationText	Gets or sets the text that will be shown after the Cancel button is pressed.
	CanRaiseEvents	Gets a value indicating whether the component can raise an event. (Inherited from Component.)
	Container	Gets the IContainer that contains the Component. (Inherited from Component.)
	Description	Gets or sets additional details about the operation being carried out.
	DesignMode	Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component.)
	Events	Gets the list of event handlers that are attached to this Component. (Inherited from Component.)
	IsBusy	Gets a value that indicates whether the ProgressDialog is running an asynchronous operation.
	MinimizeBox	Gets or sets a value that indicates whether the progress dialog has a minimize button.
	ProgressBarStyle	Gets or sets a value that indicates whether a regular or marquee style progress bar should be used.
	ShowCancelButton	Gets or sets a value that indicates whether the dialog has a cancel button.
	ShowTimeRemaining	Gets or sets a value that indicates whether an estimate of the remaining time will be shown.
	Site	Gets or sets the ISite of the Component. (Inherited from Component.)
	Text	Gets or sets a short description of the operation being carried out.
	UseCompactPathsForDescription	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.
	UseCompactPathsForText	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.
	WindowTitle	Gets or sets the text in the progress dialog's title bar.

Top

Methods

	Name	Description
	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.)
	Dispose(Boolean)	Clean up any resources being used. (Overrides ComponentDispose(Boolean).)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component.)
	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.)
	GetService	Returns an object that represents a service provided by the Component or by its Container. (Inherited from Component.)
	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.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	MemberwiseClone(Boolean)	Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
	OnDoWork	Raises the DoWork event.
	OnProgressChanged	Raises the ProgressChanged event.
	OnRunWorkerCompleted	Raises the RunWorkerCompleted event.
	ReportProgress(Int32)	Updates the dialog's progress bar.
	ReportProgress(Int32, String, String)	Updates the dialog's progress bar.
	ReportProgress(Int32, String, String, Object)	Updates the dialog's progress bar.
	Show	Displays the progress dialog as a modeless dialog.
	Show(Object)	Displays the progress dialog as a modeless dialog.
	ShowDialog	Displays the progress dialog as a modal dialog.
	ShowDialog(IWin32Window)	Displays the progress dialog as a modal dialog.
	ShowDialog(IWin32Window, Object)	Displays the progress dialog as a modal dialog.
	ToString	Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component.)

Top

Events

	Name	Description
	Disposed	Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)
	DoWork	Event raised when the dialog is displayed.
	ProgressChanged	Event raised when ReportProgress(Int32, String, String, Object) is called.
	RunWorkerCompleted	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.

Reference

Ookii.Dialogs Namespace