xtd 0.2.0
Loading...
Searching...
No Matches
xtd::forms::run_worker_completed_event_args Class Reference
Inheritance diagram for xtd::forms::run_worker_completed_event_args:
xtd::event_args xtd::object

Definition

Provides data for the xtd::forms::background_worker::run_worker_completed event handler.

Header
#include <xtd/forms/run_wrker_completed_event_args>
Namespace
xtd::forms
Library
xtd.forms
Examples
background_worker.cpp.

Public Constructors

 run_worker_completed_event_args (const std::any &result, std::optional< std::reference_wrapper< std::exception > > exception, bool cancel)
 Initializes a new instance of the DoWorkEventArgs class.
 

Public Properties

bool cancel () const noexcept
 
void cancel (bool value)
 
std::any user_state () const noexcept
 Gets a value that represents the argument of an asynchronous operation.
 
std::any result () const noexcept
 

Additional Inherited Members

- Static Public Attributes inherited from xtd::event_args
static const event_args empty
 Provides a value to use with events that do not have event data.
 
- Public Member Functions inherited from xtd::event_args
 event_args ()=default
 Initializes a new instance of the event_args class.
 
- Public Member Functions inherited from xtd::object
 object ()=default
 Create a new instance of the ultimate base class object.
 
bool equals (const object &obj) const noexcept
 Determines whether the specified object is equal to the current object.
 
virtual size_t get_hash_code () const noexcept
 Serves as a hash function for a particular type.
 
virtual type_object get_type () const noexcept
 Gets the type of the current instance.
 
template<typename object_t >
std::unique_ptr< object_t > memberwise_clone () const noexcept
 Creates a shallow copy of the current object.
 
virtual xtd::ustring to_string () const noexcept
 Returns a sxd::ustring that represents the current object.
 
- Static Public Member Functions inherited from xtd::object
static bool equals (const object &object_a, const object &object_b) noexcept
 Determines whether the specified object instances are considered equal.
 
static bool reference_equals (const object &object_a, const object &object_b) noexcept
 Determines whether the specified object instances are the same instance.
 

Constructor & Destructor Documentation

◆ run_worker_completed_event_args()

xtd::forms::run_worker_completed_event_args::run_worker_completed_event_args ( const std::any &  result,
std::optional< std::reference_wrapper< std::exception > >  exception,
bool  cancel 
)
inline

Initializes a new instance of the DoWorkEventArgs class.

Parameters
argumentSpecifies an argument for an asynchronous operation.

Member Function Documentation

◆ user_state()

std::any xtd::forms::run_worker_completed_event_args::user_state ( ) const
inlinenoexcept

Gets a value that represents the argument of an asynchronous operation.

Returns
An object representing the argument of an asynchronous operation.

The documentation for this class was generated from the following file: