xtd::forms::cancel_event_args Class Reference

#include <cancel_event_args.h>

Definition

Provides data for a cancelable event.

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.

Inherits xtd::event_args.

Inherited by xtd::forms::do_work_event_args, and xtd::forms::form_closing_event_args.

Public Member Functions
	cancel_event_args ()=default
	Initializes a new instance of the cancel_event_args class with the cancel property set to false.
	cancel_event_args (bool cancel)
	Initializes a new instance of the cancel_event_args class with the cancel property set to the given value.
virtual bool	cancel () const
	Gets a value indicating whether the event should be canceled.
virtual void	cancel (bool cancel)
	Sets a value indicating whether the event should be canceled.
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.
virtual 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.
template<typename object_t >
std::unique_ptr< object_t >	memberwise_clone () const
	Gets the type of the current instance.
virtual xtd::ustring	to_string () const noexcept
	Returns a std::string that represents the current object.

Protected Attributes
bool	cancel_

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.
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

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

inlinevirtual

Gets a value indicating whether the event should be canceled.

Returns

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

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