System::ComponentModel::BackgroundWorker Class Reference

#include "system/component_model/background_worker.h"

Inherits System::ComponentModel::Component.

Public Member Functions

 BackgroundWorker ()
 RTTI information. More...
 
 ~BackgroundWorker ()
 Destructor. More...
 
void RunWorkerAsync ()
 Starts execution of a background operation. More...
 
void RunWorkerAsync (System::SharedPtr< System::Object > argument)
 
void ReportProgress (int percentProgress)
 
void ReportProgress (int percentProgress, System::SharedPtr< System::Object > userState)
 
bool get_WorkerReportsProgress () const
 
void set_WorkerReportsProgress (bool value)
 
- Public Member Functions inherited from System::ComponentModel::Component
 Component ()
 RTTI information. More...
 
void Dispose (bool disposing=false)
 
bool get_DesignMode ()
 
- Public Member Functions inherited from System::Object
 Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ~Object ()
 Destroys object. Frees all internal data structures. More...
 
 Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared refernce counter. More...
 
void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () ASPOSE_CONST
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual void SetTemplateWeakPtr (unsigned int argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 

Public Attributes

System::MulticastDelegate< void(System::SharedPtr< System::Object >, System::SharedPtr< System::ComponentModel::DoWorkEventArgs >) > DoWork
 Occurs when System::ComponentModel::BackgroundWorker::RunWorkerAsync is called. More...
 
System::MulticastDelegate< void(System::SharedPtr< System::Object >, System::SharedPtr< System::ComponentModel::RunWorkerCompletedEventArgs >)> RunWorkerCompleted
 Occurs when the background operation has completed, has been canceled, or has raised an exception. More...
 
System::MulticastDelegate< void(System::SharedPtr< System::Object >, System::SharedPtr< System::ComponentModel::ProgressChangedEventArgs >)> ProgressChanged
 Occurs when System::ComponentModel::BackgroundWorker::ReportProgress(int) is called. More...
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. More...
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Impleemnts C# typeof(System.Object) construct. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 
template<>
bool Equals (double const &objA, double const &objB)
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

Detailed Description

Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument.

Constructor & Destructor Documentation

◆ BackgroundWorker()

System::ComponentModel::BackgroundWorker::BackgroundWorker ( )

RTTI information.

Constructor.

◆ ~BackgroundWorker()

System::ComponentModel::BackgroundWorker::~BackgroundWorker ( )

Destructor.

Member Function Documentation

◆ get_WorkerReportsProgress()

bool System::ComponentModel::BackgroundWorker::get_WorkerReportsProgress ( ) const
inline

Gets a value indicating whether the System::ComponentModel::BackgroundWorker can report progress updates.

Returns
true if the System::ComponentModel::BackgroundWorker supports progress updates otherwise false. The default is false.

◆ ReportProgress() [1/2]

void System::ComponentModel::BackgroundWorker::ReportProgress ( int  percentProgress)

Raises the System::ComponentModel::BackgroundWorker::ProgressChanged event.

Parameters
percentProgressThe percentage, from 0 to 100, of the background operation that is complete.

◆ ReportProgress() [2/2]

void System::ComponentModel::BackgroundWorker::ReportProgress ( int  percentProgress,
System::SharedPtr< System::Object userState 
)

Raises the System::ComponentModel::BackgroundWorker::ProgressChanged event with userState object.

Parameters
percentProgressThe percentage, from 0 to 100, of the background operation that is complete.
userStateThe state object passed to System::ComponentModel::BackgroundWorker::RunWorkerAsync(System::Object).

◆ RunWorkerAsync() [1/2]

void System::ComponentModel::BackgroundWorker::RunWorkerAsync ( )

Starts execution of a background operation.

◆ RunWorkerAsync() [2/2]

void System::ComponentModel::BackgroundWorker::RunWorkerAsync ( System::SharedPtr< System::Object argument)

Starts execution of a background operation.

Parameters
argumentA parameter for use by the background operation to be executed in the System::ComponentModel::BackgroundWorker::DoWork event handler.

◆ set_WorkerReportsProgress()

void System::ComponentModel::BackgroundWorker::set_WorkerReportsProgress ( bool  value)
inline

Sets a value indicating whether the System::ComponentModel::BackgroundWorker can report progress updates.

Parameters
valueThe true or false.

Member Data Documentation

◆ DoWork

◆ ProgressChanged

◆ RunWorkerCompleted

Occurs when the background operation has completed, has been canceled, or has raised an exception.