SolidFramework.ProgressEventArgs Class Reference

Describes and manipulates progress event arguments. More...

Inheritance diagram for SolidFramework.ProgressEventArgs:

Public Member Functions
virtual void	Dispose ()
	ProgressEventArgs ()
	Initializes a new instance of the ProgressEventArgs class.
	ProgressEventArgs (int progress, int maxProgress, SolidFramework.Interop.SolidErrorCodes statusCode, string statusDescription, global::System.IntPtr customData)
	Initializes a new instance of the ProgressEventArgs class. More...
void	Cancel ()
	Cancels the current operation and causes it to terminate at the next appropriate time.
bool	Equals (SolidFramework.ProgressEventArgs other)
override bool	Equals (object obj)
override int	GetHashCode ()

Static Public Member Functions
static bool	operator== (SolidFramework.ProgressEventArgs obj1, SolidFramework.ProgressEventArgs obj2)
static bool	operator!= (SolidFramework.ProgressEventArgs obj1, SolidFramework.ProgressEventArgs obj2)

Properties
System.Object	CustomData [getset]
string	StatusDescription [getset]
	Gets the status description. More...
int	Progress [getset]
	Gets or sets the progress. More...
SolidFramework.Interop.SolidErrorCodes	StatusCode [getset]
	Gets the status code. More...
int	MaxProgress [getset]
	Gets or sets the max progress. More...
bool	IsCanceled [get]
	Indicates whether the current operation has been canceled and will terminate at an appropriate time. More...

Detailed Description

Describes and manipulates progress event arguments.

Constructor & Destructor Documentation

ProgressEventArgs()

SolidFramework.ProgressEventArgs.ProgressEventArgs	(	int	progress,
		int	maxProgress,
		SolidFramework.Interop.SolidErrorCodes	statusCode,
		string	statusDescription,
		global::System.IntPtr	customData
	)

Initializes a new instance of the ProgressEventArgs class.

Parameters

progress	The progress.
maxProgress	The max progress.
statusCode	The status code.
statusDescription	The status description.
customData	The custom data.

Property Documentation

IsCanceled

bool SolidFramework.ProgressEventArgs.IsCanceled

get

Indicates whether the current operation has been canceled and will terminate at an appropriate time.

true if the current operation has been cancelled otherwise false

MaxProgress

int SolidFramework.ProgressEventArgs.MaxProgress

getset

Gets or sets the max progress.

The max progress.

Progress

int SolidFramework.ProgressEventArgs.Progress

getset

Gets or sets the progress.

The progress.

StatusCode

SolidFramework.Interop.SolidErrorCodes SolidFramework.ProgressEventArgs.StatusCode

getset

Gets the status code.

The status code.

StatusDescription

string SolidFramework.ProgressEventArgs.StatusDescription

getset

Gets the status description.

The status description.