Interface IProgressDialog

Define a series of members to be implemented by a type that provides functionality for reporting progress of an operation in a native Microsoft Windows dialog.

Namespace: TheXDS.MCART.Helpers
Assembly: MCART.Windows.dll
Syntax
public interface IProgressDialog

Properties

| Edit this page View Source

AutoClose

Gets or sets a value indicating whether the dialog should automatically close upon reaching 100% progress.

Declaration
bool AutoClose { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

CancelMessage

Gets or sets the message displayed when the operation in progress is canceled.

Declaration
string CancelMessage { get; set; }
Property Value
Type Description
string
| Edit this page View Source

CompactPaths

Gets or sets a value indicating whether text lines should be compressed if they exceed the available width.

Declaration
bool CompactPaths { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

HasUserCancelled

Gets a value indicating whether the user has requested cancellation of the current operation.

Declaration
bool HasUserCancelled { get; }
Property Value
Type Description
bool
| Edit this page View Source

Line1

Gets or sets the value of the first line of text in the dialog.

Declaration
string Line1 { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Line2

Gets or sets the value of the second line of text in the dialog.

Declaration
string Line2 { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Line3

Gets or sets the value of the third line of text in the dialog.

Declaration
string Line3 { get; set; }
Property Value
Type Description
string
Exceptions
Type Condition
InvalidOperationException

Thrown when attempting to set this line's value while the dialog displays remaining time on the third line.
| Edit this page View Source

Maximum

Gets or sets the maximum value displayed in the progress bar.

Declaration
int Maximum { get; set; }
Property Value
Type Description
int
| Edit this page View Source

Title

Gets or sets the dialog's title.

Declaration
string Title { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Value

Gets or sets the current progress value of the dialog.

Declaration
int Value { get; set; }
Property Value
Type Description
int

Methods

| Edit this page View Source

Close()

Closes the progress dialog.

Declaration
void Close()
| Edit this page View Source

Pause()

Indicates that the operation has been paused.

Declaration
void Pause()
| Edit this page View Source

Resume()

Indicates that a previously paused operation will continue.

Declaration
void Resume()

Extension Methods