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

Definition

Provides data for the xtd::forms::month_calendar::date_changed or xtd::forms::month_calendar::date_selected events of the xtd::forms::month_calendar control.

Header
#include <xtd/forms/date_range_event_args>
Namespace
xtd::forms
Library
xtd.forms
Remarks
The xtd::forms::month_calendar::date_changed event occurs when the currently selected date or range of dates changes; for example, when the user explicitly changes a selection within the current month or when the selection is implicitly changed in response to next/previous month navigation. The xtd::forms::month_calendar::date_selected event occurs when the user explicitly changes a selection. The xtd::forms::date_range_event_args constructor specifies the start and end for the new date range that has been selected.
Note
If a single date is selected, the xtd::forms::date_range_event_args::start and xtd::forms::date_range_event_args::end property values will be equal.
Remarks
For more information about handling events, see Handling and Raising Events.

Public Constructors

 date_range_event_args (const xtd::date_time &start, const xtd::date_time &end)
 Initializes a new instance of the xtd::forms::date_range_event_args class.
 

Public Properties

const xtd::date_timeend () const noexcept
 Gets the last date/time value in the range that the user has selected.
 
const xtd::date_timestart () const noexcept
 Gets the first date/time value in the range that the user has selected.
 

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.
 
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.
 
virtual type_object get_type () const noexcept
 Gets the type of the current instance.
 
template<typename object_t >
xtd::uptr< object_t > memberwise_clone () const
 Creates a shallow copy of the current object.
 
virtual xtd::string to_string () const noexcept
 Returns a xtd::string that represents the current object.
 
- Static Public Member Functions inherited from xtd::object
template<typename object_a_t , typename object_b_t >
static bool equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
 Determines whether the specified object instances are considered equal.
 
template<typename object_a_t , typename object_b_t >
static bool reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
 Determines whether the specified object instances are the same instance.
 

Constructor & Destructor Documentation

◆ date_range_event_args()

xtd::forms::date_range_event_args::date_range_event_args ( const xtd::date_time start,
const xtd::date_time end 
)
inline

Initializes a new instance of the xtd::forms::date_range_event_args class.

Parameters
controlThe control to store in this event.

Member Function Documentation

◆ end()

const xtd::date_time & xtd::forms::date_range_event_args::end ( ) const
inlinenoexcept

Gets the last date/time value in the range that the user has selected.

Returns
A xtd::date_time that represents the last date in the date range that the user has selected.

◆ start()

const xtd::date_time & xtd::forms::date_range_event_args::start ( ) const
inlinenoexcept

Gets the first date/time value in the range that the user has selected.

Returns
A xtd::date_time that represents the first date in the date range that the user has selected.

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