xtd - Reference Guide 0.2.0
xtd::forms::date_range_event_args Class Reference

#include <date_range_event_args.h>

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.

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.

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

Properties

const xtd::date_timeend () const
 Gets the last date/time value in the range that the user has selected. More...
 
const xtd::date_timestart () const
 Gets the first date/time value in the range that the user has selected. 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...
 
virtual 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...
 
template<typename object_t >
std::unique_ptr< object_t > memberwise_clone () const
 Gets the type of the current instance. 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

◆ 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
inline

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
inline

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: