Inheritance diagram for xtd::forms::month_calendar::hit_test_info:

Definition

Contains information about an area of a xtd::forms::month_calendar control. This class cannot be inherited.

Remarks: xtd::forms::month_calendar::hit_test_info objects are returned by xtd::forms::month_calendar controls in response to the xtd::forms::month_calendar::hit_test method.

Warning: xtd::forms::month_calendar::hit_test_info is for informational purposes only; you should not construct these objects and cannot modify any of the members.

Public Member Functions
xtd::forms::month_calendar::hit_area	hit_area () const noexcept
	Gets the xtd::forms::month_calendar::hit_area that represents the area of the calendar evaluated by the hit-test operation.

const xtd::drawing::point &	point () const noexcept
	Gets the point that was hit-tested.

const xtd::date_time &	time () const noexcept
	Gets the time information specific to the location that was hit-tested.

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

Additional Inherited Members
Static Public Member Functions inherited from xtd::object
template<class object_a_t , class 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<class object_a_t , class 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.

Member Function Documentation

xtd::forms::month_calendar::hit_area xtd::forms::month_calendar::hit_test_info::hit_area ( ) const

noexcept

Gets the xtd::forms::month_calendar::hit_area that represents the area of the calendar evaluated by the hit-test operation.

Returns: One of the xtd::forms::month_calendar::hit_area values. The default is xtd::forms::month_calendar::hit_area::nowhere.

const xtd::drawing::point & xtd::forms::month_calendar::hit_test_info::point ( ) const

noexcept

Gets the point that was hit-tested.

Returns: A xtd::drawing::point containing the xtd::drawing::point::x and xtd::drawing::point::y values tested.

const xtd::date_time & xtd::forms::month_calendar::hit_test_info::time ( ) const

noexcept

Gets the time information specific to the location that was hit-tested.

Remarks: The xtd::forms::month_calendar::hit_test_info::time property contains a valid date when the xtd::forms::month_calendar::hit_area property is set to xtd::forms::month_calendar::hit_area::date or xtd::forms::month_calendar::hit_area::week_numbers.

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