Inheritance diagram for xtd::forms::native::month_calendar:

Definition

Contains month calendar native API.

Namespace: xtd::forms::native

Library: xtd.forms.native

Warning: Internal use only

Protected Static Methods

Sets the array of xtd::date_time objects that determines which annual days are displayed in bold.

Parameters

control	month calendar handle.
dates	An array of xtd::date_time objects.

Remarks: Using this property, you can assign an array of annual bold dates. When you assign an array of dates, the existing dates are first cleared.

Warning: Internal use only

static void annually_bolded_dates (intptr control, const std::vector< xtd::date_time > &dates)

static void bolded_dates (intptr control, const std::vector< xtd::date_time > &dates)

Sets the array of xtd::date_time bjects that determines which nonrecurring dates are displayed in bold.

static void calendar_dimensions (intptr control, const xtd::drawing::size &calendar_dimensions)

Sets the number of columns and rows of months displayed.

static void allowable_dates (intptr control, date_time min_date, date_time max_date)

Sets allowable date range to the calendar.

static void first_day_of_week (intptr control, uint32 day)

Sets the first day of the week as displayed in the month calendar.

static std::tuple< uint32, xtd::date_time > hit_test (intptr control, const xtd::drawing::point &point)

Returns informations on which portion of a month calendar control is at a location specified by a xtd::drawing::point.

static void max_selection_count (intptr control, uint32 value)

Sets the maximum number of days that can be selected in a month calendar control.

static void monthly_bolded_dates (intptr control, const std::vector< xtd::date_time > &dates)

Sets the array of xtd::date_time objects that determine which monthly days to bold.

static void selection_range (intptr control, date_time date_start, date_time date_end)

Sets selection range to the calendar.

static xtd::collections::generic::key_value_pair< date_time, date_time > selection_range (intptr control)

Gets selection range from the calendar.

static xtd::drawing::size single_month_size (intptr control)

Gets the minimum size to display one month of the calendar.

static void title_back_color (intptr control, const xtd::drawing::color &color)

Sets a value indicating the background color of the title area of the calendar.

static void title_fore_color (intptr control, const xtd::drawing::color &color)

Sets a value indicating the foreground color of the title area of the calendar.

static void today_date (intptr control, const xtd::date_time &value)

Sets the value that is used by month_calendar as today's date.

static void trailing_fore_color (intptr control, const xtd::drawing::color &color)

Sets a value indicating the color of days in months that are not fully displayed in the control.

Member Function Documentation

◆ bolded_dates()

static void xtd::forms::native::month_calendar::bolded_dates	(	intptr	control,
		const std::vector< xtd::date_time > &	dates
	)

staticprotected

Sets the array of xtd::date_time bjects that determines which nonrecurring dates are displayed in bold.

Parameters

control	month calendar handle.
dates	An array of xtd::date_time objects.

Remarks: Using this property, you can assign an array of bold dates. When you assign an array of dates, the existing dates are first cleared.

Warning: Internal use only

◆ calendar_dimensions()

static void xtd::forms::native::month_calendar::calendar_dimensions	(	intptr	control,
		const xtd::drawing::size &	calendar_dimensions
	)

staticprotected

Sets the number of columns and rows of months displayed.

Parameters

control	month calendar handle.
calendar_dimensions	A xtd::drawing::size with the number of columns and rows to use to display the calendar.

Warning: Internal use only

◆ allowable_dates()

static void xtd::forms::native::month_calendar::allowable_dates	(	intptr	control,
		date_time	min_date,
		date_time	max_date
	)

staticprotected

Sets allowable date range to the calendar.

Parameters

control	month calendar handle.
min_date	The minimum date allowable to the calendar.
max_date	The maximum date allowable to the calendar.

Warning: Internal use only

◆ first_day_of_week()

static void xtd::forms::native::month_calendar::first_day_of_week	(	intptr	control,
		uint32	day
	)

staticprotected

Sets the first day of the week as displayed in the month calendar.

Parameters

day

One of following day values :

value	day
0	monday
1	tuesday
2	wednesday
3	thursday
4	friday
5	saturday
6	sunday
7	default_day

Warning: Internal use only

◆ hit_test()

static std::tuple< uint32, xtd::date_time > xtd::forms::native::month_calendar::hit_test	(	intptr	control,
		const xtd::drawing::point &	point
	)

staticprotected

Returns informations on which portion of a month calendar control is at a location specified by a xtd::drawing::point.

Parameters

point A xtd::drawing::point containing the xtd::drawing::point::x and xtd::drawing::point::y coordinates of the point to be hit tested.

Returns: A std:tuple<uint32, xtd::date_time> that contains information about the specified point on the month calendar.

Remarks

The value uint32 represents the strike zone, see the following table for the correspondence:

Value	hit area
0	nowhere
1	title_background
2	title_month
3	title_year
4	next_month_button
5	prev_month_button
6	calendar_background
7	date
8	next_month_date
9	prev_month_date
10	day_of_week
11	week_numbers
12	today_link

◆ max_selection_count()

static void xtd::forms::native::month_calendar::max_selection_count	(	intptr	control,
		uint32	value
	)

staticprotected

Sets the maximum number of days that can be selected in a month calendar control.

Parameters

control	month calendar handle.
value	The maximum number of days that you can select. The default is 7.

◆ monthly_bolded_dates()

static void xtd::forms::native::month_calendar::monthly_bolded_dates	(	intptr	control,
		const std::vector< xtd::date_time > &	dates
	)

staticprotected

Sets the array of xtd::date_time objects that determine which monthly days to bold.

Parameters

control	month calendar handle.
dates	An array of xtd::date_time objects.

Remarks: Using this property, you can assign an array of annual bold dates. When you assign an array of dates, the existing dates are first cleared.

Warning: Internal use only

◆ selection_range() [1/2]

static void xtd::forms::native::month_calendar::selection_range	(	intptr	control,
		date_time	date_start,
		date_time	date_end
	)

staticprotected

Sets selection range to the calendar.

Parameters

control	month_calendar handle.
date_start	The range date start.

Warning: Internal use only

◆ selection_range() [2/2]

static xtd::collections::generic::key_value_pair< date_time, date_time > xtd::forms::native::month_calendar::selection_range ( intptr control )

staticprotected

Gets selection range from the calendar.

Parameters

control month_calendar handle.

Returns: selection range.

Warning: Internal use only

◆ single_month_size()

static xtd::drawing::size xtd::forms::native::month_calendar::single_month_size ( intptr control )

staticprotected

Gets the minimum size to display one month of the calendar.

Parameters

control month_calendar handle.

Returns: The size, in pixels, necessary to fully display one month in the calendar.

Warning: Internal use only

◆ title_back_color()

static void xtd::forms::native::month_calendar::title_back_color	(	intptr	control,
		const xtd::drawing::color &	color
	)

staticprotected

Sets a value indicating the background color of the title area of the calendar.

Parameters

control	month_calendar handle.
color	A xtd::drawing::color.

Warning: Internal use only

◆ title_fore_color()

static void xtd::forms::native::month_calendar::title_fore_color	(	intptr	control,
		const xtd::drawing::color &	color
	)

staticprotected

Sets a value indicating the foreground color of the title area of the calendar.

Parameters

control	month_calendar handle.
color	A xtd::drawing::color.

Warning: Internal use only

◆ today_date()

static void xtd::forms::native::month_calendar::today_date	(	intptr	control,
		const xtd::date_time &	value
	)

staticprotected

Sets the value that is used by month_calendar as today's date.

Parameters

control	month_calendar handle.
value	A xtd::date_time representing today's date.

Warning: Internal use only

◆ trailing_fore_color()

static void xtd::forms::native::month_calendar::trailing_fore_color	(	intptr	control,
		const xtd::drawing::color &	color
	)

staticprotected

Sets a value indicating the color of days in months that are not fully displayed in the control.

Parameters

control	month_calendar handle.
color	A xtd::drawing::color.

Warning: Internal use only

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

xtd.forms.native/include/xtd/forms/native/month_calendar.h