xtd::forms::cancel_event_args Class Reference

Definition

Provides data for a cancelable event.

Header

#include <xtd/forms/cancel_event_args> 

Namespace

xtd::forms

Library

xtd.forms

Remarks

A cancelable event is raised by a component when it is about to perform an action that can be canceled, such as the closing event of a form.

Protected Attributes
bool	cancel_ = false

Constructors
	cancel_event_args ()=default
	Initializes a new instance of the cancel_event_args class with the cancel property set to false. More...
	cancel_event_args (bool cancel)
	Initializes a new instance of the cancel_event_args class with the cancel property set to the given value. More...

Properties
virtual bool	cancel () const noexcept
	Gets a value indicating whether the event should be canceled. More...
virtual void	cancel (bool cancel)
	Sets a value indicating whether the event should be canceled. More...

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. More...
Public Member Functions inherited from xtd::event_args
	event_args ()=default
	Initializes a new instance of the event_args class. More...
Public Member Functions inherited from xtd::object
	object ()=default
	Create a new instance of the ultimate base class object. More...
bool	equals (const object &obj) const noexcept
	Determines whether the specified object is equal to the current object. More...
virtual size_t	get_hash_code () const noexcept
	Serves as a hash function for a particular type. More...
virtual type_object	get_type () const noexcept
	Gets the type of the current instance. More...
template<typename object_t >
std::unique_ptr< object_t >	memberwise_clone () const noexcept
	Creates a shallow copy of the current object. More...
virtual xtd::ustring	to_string () const noexcept
	Returns a sxd::ustring that represents the current object. More...
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. More...
static bool	reference_equals (const object &object_a, const object &object_b) noexcept
	Determines whether the specified object instances are the same instance. More...

Constructor & Destructor Documentation

cancel_event_args() [1/2]

xtd::forms::cancel_event_args::cancel_event_args ( )

default

Initializes a new instance of the cancel_event_args class with the cancel property set to false.

cancel_event_args() [2/2]

xtd::forms::cancel_event_args::cancel_event_args ( bool  cancel )

inlineexplicit

Initializes a new instance of the cancel_event_args class with the cancel property set to the given value.

Parameters

cancel

true to cancel the event; otherwise, false.

Member Function Documentation

cancel() [1/2]

virtual bool xtd::forms::cancel_event_args::cancel ( ) const

inlinevirtualnoexcept

Gets a value indicating whether the event should be canceled.

Returns

true if the event should be canceled; otherwise, false.

Examples:

application_enable_dark_mode.cpp, application_enable_light_mode.cpp, context_menu.cpp, form.cpp, main_menu.cpp, some_controls.cpp, some_system_controls.cpp, and themes.cpp.

cancel() [2/2]

virtual void xtd::forms::cancel_event_args::cancel ( bool  cancel )

inlinevirtual

Sets a value indicating whether the event should be canceled.

Parameters

cancel

true if the event should be canceled; otherwise, false.

---

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

• xtd.forms/include/xtd/forms/cancel_event_args.h