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

#include <month_calendar.h>

Definition

Represents a control that displays a month calendar.

Namespace
xtd::forms
Library
xtd.forms
Examples
The following code example demonstrates the use of month_calendar control.
#include <xtd/xtd>
using namespace std::chrono;
using namespace xtd;
using namespace xtd::forms;
class form1 : public form {
public:
form1() {
text("Month calendar example");
month_calendar1.parent(*this);
month_calendar1.location({10, 10});
month_calendar1.date_changed += [&](object&, const event_args & e) {
label1.text(ustring::format("selection range: [{:d}, {:d}]", month_calendar1.selection_start(), month_calendar1.selection_end()));
};
month_calendar1.selection_range({date_time::now(), date_time::now()});
month_calendar1.min_date(date_time::now().subtract(months(3)));
month_calendar1.max_date(date_time::now().add(months(3)));
label1.parent(*this);
label1.auto_size(true);
label1.location({10, 180});
label1.text(ustring::format("selection range: [{:d}, {:d}]", month_calendar1.selection_start(), month_calendar1.selection_end()));
}
private:
month_calendar month_calendar1;
label label1;
};
int main() {
application::run(form1 {});
}
Remarks
The xtd::forms::month_calendar control allows the user to select a date using a visual display. You can limit the date and times that can be selected by setting the xtd::forms::month_calendar::min_date and xtd::forms::month_calendar::max_date properties.
You can change the look of the calendar portion of the control by setting the xtd::forms::month_calendar::fore_color, xtd::forms::month_calendar::font, xtd::forms::month_calendar::title_back_color, xtd::forms::month_calendar::title_fore_color, xtd::forms::month_calendar::trailing_fore_color, and xtd::forms::month_calendar::back_color properties.
Note
The xtd::forms::month_calendar control only supports Gregorian calendars.
Remarks
The xtd::forms::month_calendar control is drawn by the operating system, so the xtd::forms::month_calendar::paint event is never raised. If you need to provide a customized look to the xtd::forms::month_calendar control, you should override the xtd::forms::month_calendar::on_print method, call the base implementation of xtd::forms::control::on_print, and then perform custom painting.
If you need custom date formatting and a selection limited to just one date, you might consider using a xtd::forms::month_calendar::date_time_picker control instead of a xtd::forms::month_calendar. Using the xtd::forms::month_calendar::date_time_picker eliminates much of the need for validating date/time values.

Classes

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

Public Types

enum  hit_area {
  hit_area::nowhere,
  hit_area::title_background,
  hit_area::title_month,
  hit_area::title_year,
  hit_area::next_month_button,
  hit_area::prev_month_button,
  hit_area::calendar_background,
  hit_area::date,
  hit_area::next_month_date,
  hit_area::prev_month_date,
  hit_area::day_of_week,
  hit_area::week_numbers,
  hit_area::today_link
}
 Defines constants that represent areas in a xtd::forms::month_calendar control. More...
 

Constructors

 month_calendar ()
 Initializes a new instance of the month_calendar class. More...
 

Properties

std::vector< xtd::date_timeannually_bolded_dates () const
 Gets the array of xtd::date_time objects that determines which annual days are displayed in bold. More...
 
month_calendarannually_bolded_dates (const std::vector< xtd::date_time > &value)
 Sets the array of xtd::date_time objects that determines which annual days are displayed in bold. More...
 
std::vector< xtd::date_timebolded_dates () const
 Gets the array of xtd::date_time bjects that determines which nonrecurring dates are displayed in bold. More...
 
month_calendarbolded_dates (const std::vector< xtd::date_time > &value)
 Sets the array of xtd::date_time bjects that determines which nonrecurring dates are displayed in bold. More...
 
const xtd::drawing::sizecalendar_dimensions () const
 Gets the number of columns and rows of months displayed. More...
 
month_calendarcalendar_dimensions (const xtd::drawing::size &value)
 Sets the number of columns and rows of months displayed. More...
 
xtd::forms::day first_day_of_week () const
 Gets the first day of the week as displayed in the month calendar. More...
 
month_calendarfirst_day_of_week (xtd::forms::day value)
 Sets the first day of the week as displayed in the month calendar. More...
 
xtd::date_time max_date () const
 Gets the maximum date that can be selected in the control. More...
 
month_calendarmax_date (xtd::date_time value)
 Sets the maximum date that can be selected in the control. More...
 
uint32_t max_selection_count () const
 Gets the maximum number of days that can be selected in a month calendar control. More...
 
month_calendarmax_selection_count (uint32_t value)
 Sets the maximum number of days that can be selected in a month calendar control. More...
 
xtd::date_time min_date () const
 Gets the minimum date that can be selected in the control. More...
 
month_calendarmin_date (xtd::date_time value)
 Sets the minimum date that can be selected in the control. More...
 
std::vector< xtd::date_timemonthly_bolded_dates () const
 Gets the array of xtd::date_time objects that determine which monthly days to bold. More...
 
month_calendarmonthly_bolded_dates (const std::vector< xtd::date_time > &value)
 Sets the array of xtd::date_time objects that determine which monthly days to bold. More...
 
xtd::date_time selection_end () const
 Gets the end date of the selected range of dates. More...
 
month_calendarselection_end (xtd::date_time value)
 Sets the end date of the selected range of dates. More...
 
xtd::forms::selection_range selection_range () const
 Gets the selected range of dates for a month calendar control. More...
 
month_calendarselection_range (const xtd::forms::selection_range &value)
 Sets the selected range of dates for a month calendar control. More...
 
xtd::date_time selection_start () const
 Gets the start date of the selected range of dates. More...
 
month_calendarselection_start (xtd::date_time value)
 Sets the start date of the selected range of dates. More...
 
bool show_today () const
 Gets a value indicating whether the date represented by the xtd::today_date property is displayed at the bottom of the control. More...
 
month_calendarshow_today (bool value)
 Sets a value indicating whether the date represented by the xtd::today_date property is displayed at the bottom of the control. More...
 
bool show_today_circle () const
 Gets a value indicating whether today's date is identified with a circle or a square. More...
 
month_calendarshow_today_circle (bool value)
 Sets a value indicating whether today's date is identified with a circle or a square. More...
 
bool show_week_numbers () const
 Gets a value indicating whether the month calendar control displays week numbers (1-52) to the left of each row of days. More...
 
month_calendarshow_week_numbers (bool value)
 Sets a value indicating whether the month calendar control displays week numbers (1-52) to the left of each row of days. More...
 
xtd::drawing::size single_month_size () const
 Gets the minimum size to display one month of the calendar. More...
 
xtd::drawing::color title_back_color () const
 Gets a value indicating the background color of the title area of the calendar. More...
 
month_calendartitle_back_color (const xtd::drawing::color &value)
 Sets a value indicating the background color of the title area of the calendar. More...
 
xtd::drawing::color title_fore_color () const
 Gets a value indicating the foreground color of the title area of the calendar. More...
 
month_calendartitle_fore_color (const xtd::drawing::color &value)
 Sets a value indicating the foreground color of the title area of the calendar. More...
 
const xtd::date_timetoday_date () const
 Gets the value that is used by xtd::forms::month_calendar as today's date. More...
 
month_calendartoday_date (const xtd::date_time &value)
 Sets the value that is used by xtd::forms::month_calendar as today's date. More...
 
bool today_date_set () const
 Gets a value indicating whether the xtd::forms::month_calendar::today_date property has been explicitly set. More...
 
xtd::drawing::color trailing_fore_color () const
 Gets a value indicating the color of days in months that are not fully displayed in the control. More...
 
month_calendartrailing_fore_color (const xtd::drawing::color &value)
 Sets a value indicating the color of days in months that are not fully displayed in the control. More...
 

Events

event< month_calendar, xtd::forms::date_range_event_handlerdate_changed
 Occurs when the date selected in the xtd::forms::month_calendar changes. More...
 
event< month_calendar, xtd::forms::date_range_event_handlerdate_selected
 Occurs when the user makes an explicit date selection using the mouse. More...
 

Protected methods

void add_annually_bolded_date (const xtd::date_time &date)
 Adds a day that is displayed in bold on an annual basis in the month calendar. More...
 
void add_bolded_date (const xtd::date_time &date)
 Adds a day to be displayed in bold in the month calendar. More...
 
void add_monthly_bolded_date (const xtd::date_time &date)
 Adds a day that is displayed in bold on a monthly basis in the month calendar. More...
 
xtd::forms::month_calendar::hit_test_info hit_test (int32_t x, int32_t y) const
 Returns a xtd::forms::month_calendar::hit_test_info with information on which portion of a month calendar control is at a specified x- and y-coordinate. More...
 
xtd::forms::month_calendar::hit_test_info hit_test (const xtd::drawing::point &point) const
 Returns an object with information on which portion of a month calendar control is at a location specified by a xtd::drawing::point. More...
 
void remove_all_annually_bolded_dates ()
 Removes all the annually bold dates. More...
 
void remove_all_bolded_dates ()
 Removes all the nonrecurring bold dates. More...
 
void remove_all_monthly_bolded_dates ()
 Removes all the monthly bold dates. More...
 
void remove_annually_bolded_dates (const xtd::date_time &date)
 Removes the specified date from the list of annually bold dates. More...
 
void remove_bolded_dates (const xtd::date_time &date)
 Removes the specified date from the list of the nonrecurring bold dates. More...
 
void remove_monthly_bolded_dates (const xtd::date_time &date)
 Removes the specified date from the list of monthly bold dates. More...
 
void set_calendar_dimensions (int32_t x, int32_t y)
 Sets the number of columns and rows of months to display. More...
 
void set_date (const xtd::date_time &date)
 Sets a date as the currently selected date. More...
 
void set_selection_range (const xtd::date_time &date1, const xtd::date_time &date2)
 Sets the selected dates in a month calendar control to the specified date range. More...
 
xtd::ustring to_string () const noexcept override
 Returns a string containing the name of the control, if any. More...
 
void update_bolded_dates ()
 Repaints the bold dates to reflect the dates set in the lists of bold dates. More...
 
xtd::forms::create_params create_params () const override
 Gets the required creation parameters when the control handle is created. More...
 
xtd::drawing::color default_back_color () const override
 Gets the default background color of the control. More...
 
xtd::drawing::color default_fore_color () const override
 Gets the default foreground color of the control. More...
 
virtual void on_date_changed (const xtd::forms::date_range_event_args &e)
 Raises the xtd::forms::month_calendar::date_changed event. More...
 
virtual void on_date_selected (const xtd::forms::date_range_event_args &e)
 Raises the xtd::forms::month_calendar::date_selected event. More...
 
void on_handle_created (const xtd::event_args &e) override
 Raises the xtd::forms::control::handle_created event. More...
 
void wnd_proc (xtd::forms::message &message) override
 Processes Windows messages. More...
 

Additional Inherited Members

- Public Attributes inherited from xtd::forms::control
event< control, event_handlerauto_size_changed
 Occurs when the value of the xtd::forms::control::auto_size property changes. More...
 
event< control, event_handlerback_color_changed
 Occurs when the value of the xtd::forms::control::back_color property changes. More...
 
event< control, event_handlerbackground_image_changed
 Occurs when the value of the xtd::forms::control::background_image property changes. More...
 
event< control, event_handlerbackground_image_layout_changed
 Occurs when the value of the xtd::forms::control::background_image_layout property changes. More...
 
event< control, event_handlercontrol_appearance_changed
 Occurs when the value of the xtd::forms::control::control_appearance property changes. More...
 
event< control, event_handlerclick
 Occurs when the xtd::forms::control is clicked. More...
 
event< control, event_handlerclient_size_changed
 Occurs when the value of the xtd::forms::control::client_size property changes. More...
 
event< control, event_handlercursor_changed
 Occurs when the value of the xtd::forms::control::cursor property changes. More...
 
event< control, control_event_handlercontrol_added
 Occurs when a new xtd::forms::control::control is added to the xtd::forms::control::control_collection. More...
 
event< control, control_event_handlercontrol_removed
 Occurs when a new xtd::forms::control:: is removed to the xtd::forms::control::control_collection. More...
 
event< control, event_handlerdock_changed
 Occurs when the value of the xtd::forms::control::dock property changes. More...
 
event< control, event_handlerdouble_click
 Occurs when the xtd::forms::control is double-clicked. More...
 
event< control, event_handlergot_focus
 Occurs when the xtd::forms::control receives focus. More...
 
event< control, event_handlerhandle_created
 Occurs when a handle is created for the xtd::forms::control. More...
 
event< control, event_handlerhandle_destroyed
 Occurs when the control's handle is in the process of being destroyed. More...
 
event< control, event_handlerenabled_changed
 Occurs when the value of the xtd::forms::control::enabled property changes. More...
 
event< control, event_handlerfore_color_changed
 Occurs when the value of the xtd::forms::control::fore_color property changes. More...
 
event< control, event_handlerfont_changed
 Occurs when the value of the xtd::forms::control::font property changes. More...
 
event< control, help_event_handlerhelp_requested
 Occurs when the user requests help for a xtd::forms::control. More...
 
event< control, key_event_handlerkey_down
 Occurs when a key is pressed while the xtd::forms::control has focus. More...
 
event< control, key_press_event_handlerkey_press
 Occurs when a character. space or backspace key is pressed while the xtd::forms::control has focus. More...
 
event< control, key_event_handlerkey_up
 Occurs when a key is released while the xtd::forms::control has focus. More...
 
event< control, event_handlerlayout
 Occurs when a xtd::forms::control should reposition its child controls. More...
 
event< control, event_handlerlocation_changed
 Occurs when the value of the xtd::forms::control::location property changes. More...
 
event< control, event_handlerlost_focus
 Occurs when the xtd::forms::control loses focus. More...
 
event< control, mouse_event_handlermouse_click
 Occurs when the xtd::forms::control is clicked by the mouse. More...
 
event< control, mouse_event_handlermouse_double_click
 Occurs when the xtd::forms::control is double clicked by the mouse. More...
 
event< control, mouse_event_handlermouse_down
 Occurs when the mouse pointer is over the xtd::forms::control and a mouse button is pressed. More...
 
event< control, event_handlermouse_enter
 Occurs when the mouse pointer enters the xtd::forms::control. More...
 
event< control, mouse_event_handlermouse_horizontal_wheel
 Occurs when the mouse horizontal wheel moves while the xtd::forms::control has focus. More...
 
event< control, event_handlermouse_leave
 Occurs when the mouse pointer leaves the xtd::forms::control. More...
 
event< control, mouse_event_handlermouse_move
 Occurs when the mouse pointer is moved over the xtd::forms::control. More...
 
event< control, mouse_event_handlermouse_up
 Occurs when the mouse pointer is over the xtd::forms::control and a mouse button is released. More...
 
event< control, mouse_event_handlermouse_wheel
 Occurs when the mouse wheel moves while the xtd::forms::control has focus. More...
 
event< control, paint_event_handlerpaint
 Occurs when the xtd::forms::control is redrawn. More...
 
event< control, event_handlerparent_changed
 Occurs when the value of the xtd::forms::control::parent property changes. More...
 
event< control, event_handlerregion_changed
 Occurs when the value of the xtd::forms::control::region property changes. More...
 
event< control, event_handlerresize
 Occurs when the xtd::forms::control is resized. More...
 
event< control, event_handlersize_changed
 Occurs when the value of the xtd::forms::control::size property changes. More...
 
event< control, event_handlertab_stop_changed
 Occurs when the xtd::forms::control::tab_stop property value changes. More...
 
event< control, event_handlertext_changed
 Occurs when the value of the xtd::forms::control::text property changes. More...
 
event< control, event_handlervisible_changed
 Occurs when the value of the xtd::forms::control::visible property changes. More...
 
- Public Member Functions inherited from xtd::forms::control
 control ()
 Initializes a new instance of the xtd::forms::control class with default settings. More...
 
 control (const xtd::ustring &text)
 Initializes a new instance of the xtd::forms::control class with specific text. More...
 
 control (const control &parent, const xtd::ustring &text)
 Initializes a new instance of the xtd::forms::control class as a child control, with specific text. More...
 
 control (const xtd::ustring &text, int32_t left, int32_t top, int32_t width, int32_t height)
 Initializes a new instance of the control class with specific text, size, and location. More...
 
 control (const control &parent, const xtd::ustring &text, int32_t left, int32_t top, int32_t width, int32_t height)
 Initializes a new instance of the xtd::forms::control class as a child control, with specific text, size, and location. More...
 
virtual anchor_styles anchor () const
 Gets the edges of the container to which a control is bound and determines how a control is resized with its parent. More...
 
virtual controlanchor (anchor_styles anchor)
 Gets the edges of the container to which a control is bound and determines how a control is resized with its parent. More...
 
virtual drawing::point auto_scroll_point () const
 Gets where this control is scrolled to in scroll_control_into_view(control). More...
 
virtual bool auto_size () const
 Gets a value that indicates whether the control resizes based on its contents. More...
 
virtual controlauto_size (bool auto_size)
 Sets a value that indicates whether the control resizes based on its contents. More...
 
virtual drawing::color back_color () const
 Gets the background color for the control. More...
 
virtual controlback_color (const drawing::color &color)
 Sets the background color for the control. More...
 
virtual const xtd::drawing::imagebackground_image () const
 Gets the background image displayed in the control. More...
 
virtual controlbackground_image (const xtd::drawing::image &background_image)
 Sets the background image displayed in the control. More...
 
virtual xtd::forms::image_layout background_image_layout () const
 Gets the background image layout as defined in the xtd::forms::image_layout enumeration. More...
 
virtual controlbackground_image_layout (xtd::forms::image_layout background_image_layout)
 Sets the background image layout as defined in the xtd::forms::image_layout enumeration. More...
 
virtual int32_t bottom () const
 Gets the distance, in pixels, between the bottom edge of the control and the top edge of its container's client area. More...
 
virtual drawing::rectangle bounds () const
 Gets the size and location of the control including its nonclient elements, in pixels, relative to the parent control. More...
 
virtual controlbounds (const drawing::rectangle &bounds)
 Sets the size and location of the control including its nonclient elements, in pixels, relative to the parent control. More...
 
virtual bool can_focus () const
 Gets a value indicating whether the control can receive focus. More...
 
virtual bool can_select () const
 Gets a value indicating whether the control can be selected. More...
 
bool can_raise_events () const override
 Determines if events can be raised on the control. More...
 
virtual const drawing::rectangleclient_rectangle () const
 Gets the rectangle that represents the client area of the control. More...
 
virtual const drawing::sizeclient_size () const
 Gets the height and width of the client area of the control. More...
 
virtual controlclient_size (const drawing::size &client_size)
 Sets the height and width of the client area of the control. More...
 
virtual xtd::ustring company_name () const
 Gets the name of the company or creator of the application containing the control. More...
 
virtual std::optional< std::reference_wrapper< xtd::forms::context_menu > > context_menu () const
 Gets the xtd::forms::context_menu that is displayed in the control. More...
 
virtual controlcontext_menu (xtd::forms::context_menu &value)
 Sets the xtd::forms::context_menu that is displayed in the control. More...
 
virtual controlcontext_menu (std::nullptr_t)
 Sets the xtd::forms::context_menu that is displayed in the control. More...
 
virtual forms::control_appearance control_appearance () const
 Gets control appearance. More...
 
virtual controlcontrol_appearance (forms::control_appearance value)
 Sets control appearance. More...
 
virtual control_collectioncontrols ()
 Gets the collection of controls contained within the control. More...
 
virtual const control_collectioncontrols () const
 Gets the collection of controls contained within the control. More...
 
virtual bool created ()
 Gets a value indicating whether the control has been created. More...
 
virtual forms::cursor cursor () const
 Gets the cursor that is displayed when the mouse pointer is over the control. More...
 
virtual controlcursor (const forms::cursor &cursor)
 Sets the cursor that is displayed when the mouse pointer is over the control. More...
 
virtual forms::cursor default_cursor () const
 Gets the default cursor for the control. More...
 
virtual drawing::font default_font () const
 Gets the default font of the control. More...
 
virtual drawing::size default_size () const
 Gets the default size of the control. More...
 
virtual drawing::rectangle display_rectangle () const
 Gets the rectangle that represents the display area of the control. More...
 
virtual dock_style dock () const
 Gets which control borders are docked to its parent control and determines how a control is resized with its parent. More...
 
virtual controldock (dock_style dock)
 Sets which control borders are docked to its parent control and determines how a control is resized with its parent. More...
 
virtual bool double_buffered () const
 Gets a value indicating whether this control should redraw its surface using a secondary buffer to reduce or prevent flicker. More...
 
virtual controldouble_buffered (bool double_buffered)
 Sets a value indicating whether this control should redraw its surface using a secondary buffer to reduce or prevent flicker. More...
 
virtual bool enabled () const
 Gets a value indicating whether the control can respond to user interaction. More...
 
virtual controlenabled (bool enabled)
 Sets a value indicating whether the control can respond to user interaction. More...
 
virtual bool focused () const
 Gets a value indicating whether the control has input focus. More...
 
virtual drawing::font font () const
 Gets the font of the text displayed by the control. More...
 
virtual controlfont (const drawing::font &font)
 Sets the font of the text displayed by the control. More...
 
virtual drawing::color fore_color () const
 Gets the foreground color of the control. More...
 
virtual controlfore_color (const drawing::color &color)
 Sets the foreground color of the control. More...
 
intptr_t handle () const override
 Gets the window handle that the control is bound to. More...
 
virtual int32_t height () const
 Gets the height of the control. More...
 
virtual controlheight (int32_t height)
 Sets the height of the control. More...
 
bool invoke_required () const
 Gets a value indicating whether the caller must call an invoke method when making method calls to the control because the caller is on a different thread than the one the control was created on. More...
 
bool is_handle_created () const
 Gets a value indicating whether the control has a handle associated with it. More...
 
virtual int32_t left () const
 Gets the distance, in pixels, between the left edge of the control and the left edge of its container's client area. More...
 
virtual controlleft (int32_t left)
 Sets the distance, in pixels, between the left edge of the control and the left edge of its container's client area. More...
 
virtual drawing::point location () const
 Gets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container. More...
 
virtual controllocation (const drawing::point &location)
 Sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container. More...
 
virtual forms::padding margin () const
 Gets the space between controls. More...
 
virtual controlmargin (const forms::padding &margin)
 Sets the space between controls. More...
 
virtual const drawing::sizemaximum_client_size () const
 Gets the client size that is the upper limit that xtd::forms::control::get_preferred_size can specify. More...
 
virtual controlmaximum_client_size (const drawing::size &size)
 Sets the client size that is the upper limit that xtd::forms::control::get_preferred_size can specify. More...
 
virtual const drawing::sizemaximum_size () const
 Gets the size that is the upper limit that xtd::forms::control::get_preferred_size can specify. More...
 
virtual controlmaximum_size (const drawing::size &size)
 Sets the size that is the upper limit that xtd::forms::control::get_preferred_size can specify. More...
 
virtual const drawing::sizeminimum_client_size () const
 Gets the client size that is the lower limit that xtd::forms::control::get_preferred_size can specify. More...
 
virtual controlminimum_client_size (const drawing::size &size)
 Sets the client size that is the lower limit that xtd::forms::control::get_preferred_size can specify. More...
 
virtual const drawing::sizeminimum_size () const
 Gets the size that is the lower limit that xtd::forms::control::get_preferred_size can specify. More...
 
virtual controlminimum_size (const drawing::size &size)
 Sets the size that is the lower limit that xtd::forms::control::get_preferred_size can specify. More...
 
intptr_t native_handle () const
 Gets the native handle that the control is bound to. More...
 
virtual const xtd::ustringname () const
 Gets the name of the control. More...
 
virtual controlname (const xtd::ustring &name)
 Sets the name of the control. More...
 
virtual forms::padding padding () const
 Gets padding within the control. More...
 
virtual controlpadding (const forms::padding &padding)
 Sets padding within the control. More...
 
virtual std::optional< control_refparent () const
 Gets the parent container of the control. More...
 
virtual controlparent (const control &parent)
 Sets the parent container of the control. More...
 
virtual controlparent (std::nullptr_t)
 Resets the parent container of the control. More...
 
virtual xtd::ustring product_name () const
 Gets the product name of the assembly containing the control. More...
 
bool recreating_handle () const
 Gets a value indicating whether the control is currently re-creating its handle. More...
 
virtual const xtd::drawing::regionregion () const
 Gets the window region associated with the control. More...
 
virtual controlregion (const xtd::drawing::region &value)
 Sets the window region associated with the control. More...
 
virtual int32_t right () const
 Gets the distance, in pixels, between the right edge of the control and the left edge of its container's client area. More...
 
virtual drawing::size size () const
 Gets the height and width of the control. More...
 
virtual controlsize (const drawing::size &size)
 Sets the height and width of the control. More...
 
virtual style_sheets::style_sheet style_sheet () const
 Gets the contol style sheet. More...
 
virtual controlstyle_sheet (const style_sheets::style_sheet &value)
 Sets the contol style sheet. More...
 
virtual controlstyle_sheet (const xtd::ustring &value)
 Sets the contol style sheet. More...
 
virtual bool tab_stop () const
 Gets a value indicating whether the user can give the focus to this control using the TAB key. More...
 
virtual controltab_stop (bool value)
 Sets a value indicating whether the user can give the focus to this control using the TAB key. More...
 
virtual std::any tag () const
 Gets the object that contains data about the control. More...
 
virtual controltag (std::any tag)
 Sets the object that contains data about the control. More...
 
virtual const xtd::ustringtext () const
 Gets the text associated with this control. More...
 
virtual controltext (const xtd::ustring &text)
 Sets the text associated with this control. More...
 
intptr_t toolkit_handle () const
 Gets the toolkit handle that the control is bound to. More...
 
virtual int32_t top () const
 Gets the distance, in pixels, between the top edge of the control and the top edge of its container's client area. More...
 
virtual controltop (int32_t top)
 Sets the distance, in pixels, between the top edge of the control and the top edge of its container's client area. More...
 
virtual std::optional< control_reftop_level_control () const
 Gets the parent control that is not parented by another Windows Forms control. Typically, this is the outermost Form that the control is contained in. More...
 
virtual bool visible () const
 Gets a value indicating whether the control and all its child controls are displayed. More...
 
virtual controlvisible (bool visible)
 Sets a value indicating whether the control and all its child controls are displayed. More...
 
virtual int32_t width () const
 Gets the width of the control. More...
 
virtual controlwidth (int32_t width)
 Sets the width of the control. More...
 
std::shared_ptr< xtd::iasync_resultbegin_invoke (delegate< void()> value)
 Executes the specified delegate asynchronously on the thread that the control's underlying handle was created on. More...
 
std::shared_ptr< xtd::iasync_resultbegin_invoke (delegate< void(std::vector< std::any >)> value, const std::vector< std::any > &args)
 Executes the specified delegate asynchronously with the specified arguments, on the thread that the control's underlying handle was created on. More...
 
virtual void bring_to_front ()
 Brings the control to the front of the z-order. More...
 
void create_control ()
 Forces the creation of the visible control, including the creation of the handle and any visible child controls. More...
 
drawing::graphics create_graphics () const
 Creates the xtd::drawing::graphics for the control. More...
 
virtual void destroy_control ()
 Forces the destruction of the visible control, including the destruction of the handle and any visible child controls. More...
 
void end_invoke (std::shared_ptr< xtd::iasync_result > async)
 Retrieves the return value of the asynchronous operation represented by the async_result_invoke passed. More...
 
bool focus ()
 Sets input focus to the control. More...
 
auto_size_mode get_auto_size_mode () const
 Gets a value indicating how a control will behave when its auto_size property is enabled. More...
 
size_t get_child_index (intptr_t child) const
 Retrieves the index of a control within the control collection. More...
 
size_t get_child_index (intptr_t child, bool &throw_exception) const
 Retrieves the index of the specified child control within the control collection, and optionally raises an exception if the specified control is not within the control collection. More...
 
virtual void hide ()
 Conceals the control from the user. More...
 
virtual void invalidate () const
 Invalidates the entire surface of the control and causes the control to be redrawn. More...
 
virtual void invalidate (bool invalidate_children) const
 Invalidates a specific region of the control and causes a paint message to be sent to the control. Optionally, invalidates the child controls assigned to the control. More...
 
virtual void invalidate (const drawing::rectangle &rect) const
 Invalidates the specified region of the control (adds it to the control's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control. More...
 
virtual void invalidate (const drawing::rectangle &rect, bool invalidate_children) const
 Invalidates the specified region of the control (adds it to the control's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control. Optionally, invalidates the child controls assigned to the control. More...
 
void invoke (delegate< void()> value)
 Executes the specified delegate on the thread that owns the control's underlying window handle. More...
 
void invoke (delegate< void(std::vector< std::any >)> value, const std::vector< std::any > &args)
 Executes the specified delegate, on the thread that owns the control's underlying window handle, with the specified list of arguments. More...
 
void invoke (delegate< void(std::vector< std::any >)> value, std::any arg)
 Executes the specified delegate, on the thread that owns the control's underlying window handle, with the specified list of arguments. More...
 
void perform_layout ()
 Forces the control to apply layout logic to all its child controls. More...
 
xtd::drawing::point point_to_client (const xtd::drawing::point &p) const
 Computes the location of the specified screen point into client coordinates. More...
 
xtd::drawing::point point_to_screen (const xtd::drawing::point &p) const
 Computes the location of the specified client point into screen coordinates. More...
 
virtual bool pre_process_message (xtd::forms::message &message)
 Preprocesses keyboard or input messages within the message loop before they are dispatched. More...
 
virtual void refresh () const
 Forces the control to invalidate its client area and immediately redraw itself and any child controls. More...
 
void resume_layout ()
 Resumes usual layout logic. More...
 
void resume_layout (bool perform_layout)
 Resumes usual layout logic, optionally forcing an immediate layout of pending layout requests. More...
 
intptr_t send_message (intptr_t hwnd, int32_t msg, intptr_t wparam, intptr_t lparam) const
 Send a message with specified hwnd, message, wparam and lparam. More...
 
void set_auto_size_mode (auto_size_mode auto_size_mode)
 Sets a value indicating how a control will behave when its auto_size property is enabled. More...
 
void set_bounds (int32_t x, int32_t y, int32_t width, int32_t height)
 Sets the bounds of the control to the specified location and size. More...
 
void set_bounds (int32_t x, int32_t y, int32_t width, int32_t height, bounds_specified specified)
 Sets the specified bounds of the control to the specified location and size. More...
 
virtual void show ()
 Displays the control to the user. More...
 
void suspend_layout ()
 Temporarily suspends the layout logic for the control. More...
 
virtual void update () const
 Causes the control to redraw the invalidated regions within its client area. More...
 
controloperator<< (control &child)
 Add child control. More...
 
controloperator>> (control &child)
 Remove child control. 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...
 
- Public Member Functions inherited from xtd::forms::iwin32_window
- Static Public Member Functions inherited from xtd::forms::control
static bool check_for_illegal_cross_thread_calls ()
 Gets a value indicating whether to catch calls on the wrong thread that access a xtd::forms::contrtol::handle property when an application is being debugged. More...
 
static void check_for_illegal_cross_thread_calls (bool value)
 Sets a value indicating whether to catch calls on the wrong thread that access a xtd::forms::contrtol::handle property when an application is being debugged. More...
 
static forms::keys modifier_keys ()
 Gets a value indicating which of the modifier keys (SHIFT, CTRL, and ALT) is in a pressed state. More...
 
static forms::mouse_buttons mouse_buttons ()
 Gets a value indicating which of the mouse buttons is in a pressed state. More...
 
static xtd::drawing::point mouse_position ()
 Gets the position of the mouse cursor in screen coordinates. More...
 
template<typename control_t >
static std::unique_ptr< control_t > create (const drawing::point &location={-1, -1}, const drawing::size &size={-1, -1}, const drawing::color &back_color=drawing::color::empty, const drawing::color &fore_color=drawing::color::empty)
 A factory to create a specified control with specified location ,size back_color and fore_color. More...
 
template<typename control_t >
static std::unique_ptr< control_t > create (const control &parent, const drawing::point &location={-1, -1}, const drawing::size &size={-1, -1}, const drawing::color &back_color=drawing::color::empty, const drawing::color &fore_color=drawing::color::empty)
 A factory to create a specified control with specified parent, location ,size back_color and fore_color. More...
 
template<typename control_t >
static std::unique_ptr< control_t > create (const xtd::ustring &text, const drawing::point &location={-1, -1}, const drawing::size &size={-1, -1}, const drawing::color &back_color=drawing::color::empty, const drawing::color &fore_color=drawing::color::empty)
 A factory to create a specified control with specified text, location ,size back_color and fore_color. More...
 
template<typename control_t >
static std::unique_ptr< control_t > create (const control &parent, const xtd::ustring &text, const drawing::point &location={-1, -1}, const drawing::size &size={-1, -1}, const drawing::color &back_color=drawing::color::empty, const drawing::color &fore_color=drawing::color::empty)
 A factory to create a specified control with specified parent, text, location ,size back_color and fore_color. More...
 
static std::optional< control_reffrom_child_handle (intptr_t handle)
 Retrieves the control that contains the specified handle. More...
 
static std::optional< control_reffrom_handle (intptr_t handle)
 Returns the control that is currently associated with the specified handle. 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...
 
- Protected Member Functions inherited from xtd::forms::control
xtd::forms::visual_styles::control_state control_state () const noexcept
 Gets state. More...
 
virtual void create_handle ()
 Creates a handle for the control. More...
 
virtual void destroy_handle ()
 Destroys the handle associated with the control. More...
 
virtual void def_wnd_proc (message &message)
 Sends the specified message to the default window procedure. More...
 
bool get_style (control_styles flag) const
 Retrieves the value of the specified control style bit for the control. More...
 
virtual drawing::size measure_control () const
 Measure this control. More...
 
drawing::size measure_text () const
 Measure this control text. More...
 
virtual void on_auto_size_changed (const event_args &e)
 Raises the xtd::forms::control::auto_size_changed event. More...
 
virtual void on_back_color_changed (const event_args &e)
 Raises the xtd::forms::control::back_color_changed event. More...
 
virtual void on_background_image_changed (const event_args &e)
 Raises the xtd::forms::control::background_image_changed event. More...
 
virtual void on_background_image_layout_changed (const event_args &e)
 Raises the xtd::forms::control::background_image_layout_changed event. More...
 
virtual void on_control_appearance_changed (const event_args &e)
 Raises the control::control_appearance_changed event. More...
 
virtual void on_click (const event_args &e)
 Raises the xtd::forms::control::click event. More...
 
virtual void on_client_size_changed (const event_args &e)
 Raises the xtd::forms::control::client_size_changed event. More...
 
virtual void on_control_added (const control_event_args &e)
 Raises the xtd::forms::control::control_added event. More...
 
virtual void on_control_removed (const control_event_args &e)
 Raises the xtd::forms::control::control_removed event. More...
 
virtual void on_create_control ()
 Raises the xtd::forms::control::create_control event. More...
 
virtual void on_cursor_changed (const event_args &e)
 Raises the xtd::forms::control::cursor_changed event. More...
 
virtual void on_dock_changed (const event_args &e)
 Raises the xtd::forms::control::dock_changed event. More...
 
virtual void on_double_click (const event_args &e)
 Raises the xtd::forms::control::double_click event. More...
 
virtual void on_enabled_changed (const event_args &e)
 Raises the xtd::forms::control::enabled_changed event. More...
 
virtual void on_fore_color_changed (const event_args &e)
 Raises the xtd::forms::control::fore_color_changed event. More...
 
virtual void on_font_changed (const event_args &e)
 Raises the xtd::forms::control::font_changed event. More...
 
virtual void on_got_focus (const event_args &e)
 Raises the xtd::forms::control::got_focus event. More...
 
virtual void on_handle_destroyed (const event_args &e)
 Raises the xtd::forms::control::handle_destroyed event. More...
 
virtual void on_help_requested (help_event_args &e)
 Raises the xtd::forms::control::help_requested event. More...
 
virtual void on_key_down (key_event_args &e)
 Raises the xtd::forms::control::key_down event. More...
 
virtual void on_key_press (key_press_event_args &e)
 Raises the xtd::forms::control::key_press event. More...
 
virtual void on_key_up (key_event_args &e)
 Raises the xtd::forms::control::key_up event. More...
 
virtual void on_layout (const event_args &e)
 Raises the xtd::forms::control::layout event. More...
 
virtual void on_location_changed (const event_args &e)
 Raises the xtd::forms::control::location_changed event. More...
 
virtual void on_lost_focus (const event_args &e)
 Raises the xtd::forms::control::lost_focus event. More...
 
virtual void on_mouse_click (const mouse_event_args &e)
 Raises the xtd::forms::control::mouse_click event. More...
 
virtual void on_mouse_double_click (const mouse_event_args &e)
 Raises the xtd::forms::control::mouse_double_click event. More...
 
virtual void on_mouse_down (const mouse_event_args &e)
 Raises the xtd::forms::control::mouse_down event. More...
 
virtual void on_mouse_enter (const event_args &e)
 Raises the xtd::forms::control::mouse_enter event. More...
 
virtual void on_mouse_horizontal_wheel (const mouse_event_args &e)
 Raises the xtd::forms::control::mouse_horizontal_wheel event. More...
 
virtual void on_mouse_leave (const event_args &e)
 Raises the xtd::forms::control::mouse_leave event. More...
 
virtual void on_mouse_move (const mouse_event_args &e)
 Raises the xtd::forms::control::mouse_move event. More...
 
virtual void on_mouse_up (const mouse_event_args &e)
 Raises the xtd::forms::control::mouse_up event. More...
 
virtual void on_mouse_wheel (const mouse_event_args &e)
 Raises the xtd::forms::control::mouse_wheel event. More...
 
virtual void on_paint (paint_event_args &e)
 Raises the xtd::forms::control::paint event. More...
 
virtual void on_paint_background (paint_event_args &e)
 Paints the background of the xtd::forms::control. More...
 
virtual void on_parent_back_color_changed (const event_args &e)
 Raises the xtd::forms::control::parent_back_color_changed event. More...
 
virtual void on_parent_cursor_changed (const event_args &e)
 Raises the xtd::forms::control::parent_cursor_changed event. More...
 
virtual void on_parent_changed (const event_args &e)
 Raises the xtd::forms::control::parent_changed event. More...
 
virtual void on_parent_enabled_changed (const event_args &e)
 Raises the xtd::control::enabled_changed event when the xtd::control::enabled property value of the control's container changes.. More...
 
virtual void on_parent_fore_color_changed (const event_args &e)
 Raises the xtd::forms::control::parent_fore_color_changed event. More...
 
virtual void on_parent_font_changed (const event_args &e)
 Raises the xtd::forms::control::parent_font_changed event. More...
 
virtual void on_resize (const event_args &e)
 Raises the xtd::forms::control::region event. More...
 
virtual void on_region_changed (const event_args &e)
 Raises the xtd::forms::control::region_changed event. More...
 
virtual void on_size_changed (const event_args &e)
 Raises the xtd::forms::control::size_changed event. More...
 
virtual void on_tab_stop_changed (const event_args &e)
 Raises the xtd::forms::control::tab_stop_changed event. More...
 
virtual void on_text_changed (const event_args &e)
 Raises the xtd::forms::control::text_changed event. More...
 
virtual void on_visible_changed (const event_args &e)
 Raises the xtd::forms::control::visible_changed event. More...
 
void post_recreate_handle ()
 
virtual void recreate_handle ()
 Forces the re-creation of the handle for the control. More...
 
virtual void set_bounds_core (int32_t x, int32_t y, int32_t width, int32_t height, bounds_specified specified)
 Performs the work of setting the specified bounds of this control. More...
 
void set_can_focus (bool value)
 Sets a value indicating whether the control can receive focus. More...
 
virtual void set_text (const xtd::ustring &text)
 Sets the text associated with this control. More...
 
virtual void set_client_size_core (int32_t width, int32_t height)
 Sets the size of the client area of the control. More...
 
void set_parent (intptr_t handle)
 Sets the parent handle of the control. More...
 
void set_style (control_styles flag, bool value)
 Sets a specified control_styles flag to either true or false. More...
 
- Protected Member Functions inherited from xtd::forms::component
 component ()=default
 Initialises a new instance of the component class. More...
 
bool design_mode () const
 Gets a value that indicates whether the component is currently in design mode. More...
 
- Static Protected Member Functions inherited from xtd::forms::control
static void set_mouse_buttons (forms::mouse_buttons value)
 Sets a value indicating which of the mouse buttons is in a pressed state. More...
 

Member Enumeration Documentation

◆ hit_area

Defines constants that represent areas in a xtd::forms::month_calendar control.

Remarks
This enumeration includes specific areas of the xtd::forms::month_calendar control as its enumerated values. The xtd::forms::month_calendar::hit_area member of xtd::forms::month_calendar::hit_test_info is one of these enumerated values, and indicates which portion of a month calendar is under a specified point.
Enumerator
nowhere 

The specified point is either not on the month calendar control, or it is in an inactive portion of the control.

title_background 

The specified point is over the background of a month's title.

title_month 

The specified point is in a month's title bar, over a month name.

title_year 

The specified point is in a month's title bar, over the year value.

next_month_button 

The specified point is over the button at the upper-right corner of the control. If the user clicks here, the month calendar scrolls its display to the next month or set of months.

prev_month_button 

The specified point is over the button at the upper-left corner of the control. If the user clicks here, the month calendar scrolls its display to the previous month or set of months.

calendar_background 

The specified point is part of the calendar's background.

date 

The specified point is on a date within the calendar. The System.Windows.Forms.xtd::forms::month_calendar::hit_test_info .xtd::forms::month_calendar::hit_test_info::time property of System.Windows.Forms.xtd::forms::month_calendar::hit_test_info is set to the date at the specified point.

next_month_date 

The specified point is over a date from the next month (partially displayed at the top of the currently displayed month). If the user clicks here, the month calendar scrolls its display to the next month or set of months.

prev_month_date 

The specified point is over a date from the previous month (partially displayed at the top of the currently displayed month). If the user clicks here, the month calendar scrolls its display to the previous month or set of months.

day_of_week 

The specified point is over a day abbreviation ("Fri", for example). The System.Windows.Forms.xtd::forms::month_calendar::hit_test_info .xtd::forms::month_calendar::hit_test_info::time property of System.Windows.Forms.xtd::forms::month_calendar::hit_test_info is set to January 1, 0001.

week_numbers 

The specified point is over a week number. This occurs only if the xtd::forms::month_calendar::show_week_numbers property of xtd::forms::month_calendar is enabled. The System.Windows.Forms.xtd::forms::month_calendar::hit_test_info .xtd::forms::month_calendar::hit_test_info::time property of System.Windows.Forms.xtd::forms::month_calendar::hit_test_info is set to the corresponding date in the leftmost column.

today_link 

The specified point is on the today link at the bottom of the month calendar control.

Constructor & Destructor Documentation

◆ month_calendar()

xtd::forms::month_calendar::month_calendar ( )

Initializes a new instance of the month_calendar class.

Examples
The following code example demonstrates the use of month_calendar control.
#include <xtd/xtd>
using namespace std::chrono;
using namespace xtd;
using namespace xtd::forms;
class form1 : public form {
public:
form1() {
text("Month calendar example");
month_calendar1.parent(*this);
month_calendar1.location({10, 10});
month_calendar1.date_changed += [&](object&, const event_args & e) {
label1.text(ustring::format("selection range: [{:d}, {:d}]", month_calendar1.selection_start(), month_calendar1.selection_end()));
};
month_calendar1.selection_range({date_time::now(), date_time::now()});
month_calendar1.min_date(date_time::now().subtract(months(3)));
month_calendar1.max_date(date_time::now().add(months(3)));
label1.parent(*this);
label1.auto_size(true);
label1.location({10, 180});
label1.text(ustring::format("selection range: [{:d}, {:d}]", month_calendar1.selection_start(), month_calendar1.selection_end()));
}
private:
month_calendar month_calendar1;
label label1;
};
int main() {
application::run(form1 {});
}
Remarks
The xtd::forms::month_calendar constructor creates a new xtd::forms::month_calendar.

Member Function Documentation

◆ add_annually_bolded_date()

void xtd::forms::month_calendar::add_annually_bolded_date ( const xtd::date_time date)

Adds a day that is displayed in bold on an annual basis in the month calendar.

Parameters
dateThe date to be displayed in bold.
Remarks
You must call the xtd::forms::month_calendar::update_bolded_dates method afterward to update the display.
To add multiple dates in a single assignment, you can assign an array of xtd::date_time objects to the xtd::forms::month_calendar::annually_bolded_dates property.

◆ add_bolded_date()

void xtd::forms::month_calendar::add_bolded_date ( const xtd::date_time date)

Adds a day to be displayed in bold in the month calendar.

Parameters
dateThe date to be displayed in bold.
Remarks
You must call the xtd::forms::month_calendar::update_bolded_dates method afterward to update the display.
To add multiple dates in a single assignment, you can assign an array of xtd::date_time objects to the xtd::forms::month_calendar::bolded_dates property.

◆ add_monthly_bolded_date()

void xtd::forms::month_calendar::add_monthly_bolded_date ( const xtd::date_time date)

Adds a day that is displayed in bold on a monthly basis in the month calendar.

Parameters
dateThe date to be displayed in bold.
Remarks
You must call the xtd::forms::month_calendar::update_bolded_dates method afterward to update the display.
To add multiple dates in a single assignment, you can assign an array of xtd::date_time objects to the xtd::forms::month_calendar::monthly_bolded_dates property.

◆ annually_bolded_dates() [1/2]

std::vector<xtd::date_time> xtd::forms::month_calendar::annually_bolded_dates ( ) const

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

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

◆ annually_bolded_dates() [2/2]

month_calendar& xtd::forms::month_calendar::annually_bolded_dates ( const std::vector< xtd::date_time > &  value)

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

Parameters
valueAn array of xtd::date_time objects.
Returns
Current month_calendar.
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.

◆ bolded_dates() [1/2]

std::vector<xtd::date_time> xtd::forms::month_calendar::bolded_dates ( ) const

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

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

◆ bolded_dates() [2/2]

month_calendar& xtd::forms::month_calendar::bolded_dates ( const std::vector< xtd::date_time > &  value)

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

Parameters
valueAn array of xtd::date_time objects.
Returns
Current month_calendar.
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.

◆ calendar_dimensions() [1/2]

const xtd::drawing::size& xtd::forms::month_calendar::calendar_dimensions ( ) const

Gets the number of columns and rows of months displayed.

Returns
A xtd::drawing::size with the number of columns and rows to use to display the calendar.
Remarks
Only one calendar year is displayed at a time, and the maximum number of months that can be displayed is 12. Valid combinations of columns and rows make a maximum product of 12; for values greater than 12, the display is modified on a best-fit basis.

◆ calendar_dimensions() [2/2]

month_calendar& xtd::forms::month_calendar::calendar_dimensions ( const xtd::drawing::size value)

Sets the number of columns and rows of months displayed.

Parameters
valueA xtd::drawing::size with the number of columns and rows to use to display the calendar.
Returns
Current month_calendar.
Remarks
Only one calendar year is displayed at a time, and the maximum number of months that can be displayed is 12. Valid combinations of columns and rows make a maximum product of 12; for values greater than 12, the display is modified on a best-fit basis.

◆ create_params()

xtd::forms::create_params xtd::forms::month_calendar::create_params ( ) const
overrideprotectedvirtual

Gets the required creation parameters when the control handle is created.

Returns
A create_params that contains the required creation parameters when the handle to the control is created.
Remarks
The create_params property should not be overridden and used to adjust the properties of your derived control. Properties such as the create_params::caption, create_params::width, and create_params::height should be set by the corresponding properties in your control such as control::text, control::width and control::height. The create_params should only be extended when you are wrapping a standard Windows control class or to set styles not provided by the forms namespace.
Notes for inheritors
When overriding the create_params property in a derived class, use the base class's create_params property to extend the base implementation. Otherwise, you must provide all the implementation.

Reimplemented from xtd::forms::control.

◆ default_back_color()

xtd::drawing::color xtd::forms::month_calendar::default_back_color ( ) const
inlineoverrideprotectedvirtual

Gets the default background color of the control.

Returns
The default background color of the control. The default is control.
Remarks
This is the default back_color property value of a generic top-level control. Derived classes can have different defaults.

Reimplemented from xtd::forms::control.

◆ default_fore_color()

xtd::drawing::color xtd::forms::month_calendar::default_fore_color ( ) const
inlineoverrideprotectedvirtual

Gets the default foreground color of the control.

Returns
The default foreground color of the control. The default is control_text.

Reimplemented from xtd::forms::control.

◆ first_day_of_week() [1/2]

xtd::forms::day xtd::forms::month_calendar::first_day_of_week ( ) const

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

Returns
One of the xtd::forms::day values. The default is td::forms::day::default_day.

◆ first_day_of_week() [2/2]

month_calendar& xtd::forms::month_calendar::first_day_of_week ( xtd::forms::day  value)

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

Parameters
valueOne of the xtd::forms::day values. The default is td::forms::day::default_day.
Returns
Current month_calendar.

◆ hit_test() [1/2]

xtd::forms::month_calendar::hit_test_info xtd::forms::month_calendar::hit_test ( int32_t  x,
int32_t  y 
) const

Returns a xtd::forms::month_calendar::hit_test_info with information on which portion of a month calendar control is at a specified x- and y-coordinate.

Parameters
xThe xtd::drawing::point::x coordinate of the point to be hit tested.
yThe xtd::drawing::point::y coordinate of the point to be hit tested.
Returns
A xtd::forms::month_calendar::hit_test_info that contains information about the specified point on the xtd::forms::month_calendar.

◆ hit_test() [2/2]

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

Returns an object with information on which portion of a month calendar control is at a location specified by a xtd::drawing::point.

Parameters
pointA xtd::drawing::point containing the xtd::drawing::point::x and xtd::drawing::point::y coordinates of the point to be hit tested.
Returns
A xtd::forms::month_calendar::hit_test_info that contains information about the specified point on the xtd::forms::month_calendar.

◆ max_date() [1/2]

xtd::date_time xtd::forms::month_calendar::max_date ( ) const

Gets the maximum date that can be selected in the control.

Returns
The maximum date that can be selected in the control.

◆ max_date() [2/2]

month_calendar& xtd::forms::month_calendar::max_date ( xtd::date_time  value)

Sets the maximum date that can be selected in the control.

Parameters
valueThe maximum date that can be selected in the control.
Returns
Current month_calendar.

◆ max_selection_count() [1/2]

uint32_t xtd::forms::month_calendar::max_selection_count ( ) const

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

Returns
The maximum number of days that you can select. The default is 7.
Exceptions
xtd::argument_exceptionThe value is less than 1.
Remarks
Setting this property does not effect the current selection range.
It is important to remember that the xtd::forms::month_calendar::max_selection_count property represents the number of days in the selection, not the difference between xtd::forms::month_calendar::selection_start and xtd::forms::month_calendar::selection_end. For example, if xtd::forms::month_calendar::max_selection_count is 7 (the default), xtd::forms::month_calendar::selection_start and xtd::forms::month_calendar::selection_end can be no more than six days apart.

◆ max_selection_count() [2/2]

month_calendar& xtd::forms::month_calendar::max_selection_count ( uint32_t  value)

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

Parameters
valueThe maximum number of days that you can select. The default is 7.
Returns
Current month_calendar.
Exceptions
xtd::argument_exceptionThe value is less than 1.
Remarks
Setting this property does not effect the current selection range.
It is important to remember that the xtd::forms::month_calendar::max_selection_count property represents the number of days in the selection, not the difference between xtd::forms::month_calendar::selection_start and xtd::forms::month_calendar::selection_end. For example, if xtd::forms::month_calendar::max_selection_count is 7 (the default), xtd::forms::month_calendar::selection_start and xtd::forms::month_calendar::selection_end can be no more than six days apart.

◆ min_date() [1/2]

xtd::date_time xtd::forms::month_calendar::min_date ( ) const

Gets the minimum date that can be selected in the control.

Returns
The minimum date that can be selected in the control.

◆ min_date() [2/2]

month_calendar& xtd::forms::month_calendar::min_date ( xtd::date_time  value)

Sets the minimum date that can be selected in the control.

Parameters
valueThe minimum date that can be selected in the control.
Returns
Current month_calendar.

◆ monthly_bolded_dates() [1/2]

std::vector<xtd::date_time> xtd::forms::month_calendar::monthly_bolded_dates ( ) const

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

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

◆ monthly_bolded_dates() [2/2]

month_calendar& xtd::forms::month_calendar::monthly_bolded_dates ( const std::vector< xtd::date_time > &  value)

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

Parameters
valueAn array of xtd::date_time objects.
Returns
Current month_calendar.
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.

◆ on_date_changed()

virtual void xtd::forms::month_calendar::on_date_changed ( const xtd::forms::date_range_event_args e)
protectedvirtual

Raises the xtd::forms::month_calendar::date_changed event.

Parameters
eA xtd::forms::date_range_event_args that contains the event data.
Remarks
Raising an event invokes the event handler through a delegate. For more information, see Handling and Raising Events.
The xtd::forms::month_calendar::on_date_changed method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.
Notes to Inherotors
When overriding xtd::forms::month_calendar::on_date_changed in a derived class, be sure to call the base class' xtd::forms::month_calendar::on_date_changed method so that registered delegates receive the event.

◆ on_date_selected()

virtual void xtd::forms::month_calendar::on_date_selected ( const xtd::forms::date_range_event_args e)
protectedvirtual

Raises the xtd::forms::month_calendar::date_selected event.

Parameters
eA xtd::forms::date_range_event_args that contains the event data.
Remarks
Raising an event invokes the event handler through a delegate. For more information, see Handling and Raising Events.
The xtd::forms::month_calendar::on_date_selected method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.
Notes to Inherotors
When overriding xtd::forms::month_calendar::on_date_selected in a derived class, be sure to call the base class' xtd::forms::month_calendar::on_date_selected method so that registered delegates receive the event.

◆ on_handle_created()

void xtd::forms::month_calendar::on_handle_created ( const xtd::event_args e)
overrideprotectedvirtual

Raises the xtd::forms::control::handle_created event.

Parameters
eAn xtd::event_args that contains the event data.

Reimplemented from xtd::forms::control.

◆ remove_all_annually_bolded_dates()

void xtd::forms::month_calendar::remove_all_annually_bolded_dates ( )

Removes all the annually bold dates.

Remarks
This method clears all dates from the xtd::forms::month_calendar::annually_bolded_dates array. To remove a single date from the bold dates, use the xtd::forms::month_calendar::remove_annually_bolded_date method.
You must call the xtd::forms::month_calendar::update_bolded_dates method to ensure that the display is updated to reflect the removal.

◆ remove_all_bolded_dates()

void xtd::forms::month_calendar::remove_all_bolded_dates ( )

Removes all the nonrecurring bold dates.

Remarks
This method clears all dates from the xtd::forms::month_calendar::bolded_dates array. To remove a single date from the bold dates, use the xtd::forms::month_calendar::remove_bolded_date method.
You must call the xtd::forms::month_calendar::update_bolded_dates method to ensure that the display is updated to reflect the removal.

◆ remove_all_monthly_bolded_dates()

void xtd::forms::month_calendar::remove_all_monthly_bolded_dates ( )

Removes all the monthly bold dates.

Remarks
This method clears all dates from the xtd::forms::month_calendar::monthly_bolded_dates array. To remove a single date from the bold dates, use the xtd::forms::month_calendar::remove_monthly_bolded_date method.
You must call the xtd::forms::month_calendar::update_bolded_dates method to ensure that the display is updated to reflect the removal.

◆ remove_annually_bolded_dates()

void xtd::forms::month_calendar::remove_annually_bolded_dates ( const xtd::date_time date)

Removes the specified date from the list of annually bold dates.

Parameters
dateThe date to remove from the date list.
Remarks
If the specified date occurs more than once in the date list, only the first date is removed. When comparing dates, only the day and month are used. You must call the xtd::forms::month_calendar::bolded_dates properties method to ensure that the display is updated to reflect the removal.

◆ remove_bolded_dates()

void xtd::forms::month_calendar::remove_bolded_dates ( const xtd::date_time date)

Removes the specified date from the list of the nonrecurring bold dates.

Parameters
dateThe date to remove from the date list.
Remarks
If the specified date occurs more than once in the date list, only the first date is removed. When comparing dates, only the day and month are used. You must call the xtd::forms::month_calendar::bolded_dates properties method to ensure that the display is updated to reflect the removal.

◆ remove_monthly_bolded_dates()

void xtd::forms::month_calendar::remove_monthly_bolded_dates ( const xtd::date_time date)

Removes the specified date from the list of monthly bold dates.

Parameters
dateThe date to remove from the date list.
Remarks
If the specified date occurs more than once in the date list, only the first date is removed. When comparing dates, only the day and month are used. You must call the xtd::forms::month_calendar::bolded_dates properties method to ensure that the display is updated to reflect the removal.

◆ selection_end() [1/2]

xtd::date_time xtd::forms::month_calendar::selection_end ( ) const

Gets the end date of the selected range of dates.

Returns
A xtd::date_time indicating the last date in the selection range.
Remarks
If you set the value of the xtd::forms::month_calendar::selection_end property to a date that is earlier than the current value of the xtd::forms::month_calendar::selection_start property, xtd::forms::month_calendar::selection_start is automatically set equal to xtd::forms::month_calendar::selection_end.
If you set a date in xtd::forms::month_calendar::selection_end that causes the selection to exceed the number of days specified by the xtd::forms::month_calendar::max_selection_count property, the value of xtd::forms::month_calendar::selection_start is adjusted; xtd::forms::month_calendar::selection_start is automatically set so that the number of days selected is equal to xtd::forms::month_calendar::max_selection_count.
Note
xtd::forms::month_calendar::max_selection_count represents the number of days in the selection, not the difference between xtd::forms::month_calendar::selection_start and xtd::forms::month_calendar::selection_end. For example, if xtd::forms::month_calendar::max_selection_count is 7 (the default), then xtd::forms::month_calendar::selection_start and xtd::forms::month_calendar::selection_end can be no more than six days apart.
Setting the xtd::forms::month_calendar::selection_range for a xtd::forms::month_calendar control that has visual styles enabled will result in the selection range not painting correctly on the control.

◆ selection_end() [2/2]

month_calendar& xtd::forms::month_calendar::selection_end ( xtd::date_time  value)

Sets the end date of the selected range of dates.

Parameters
valueA xtd::date_time indicating the last date in the selection range.
Returns
Current month_calendar.
Remarks
If you set the value of the xtd::forms::month_calendar::selection_end property to a date that is earlier than the current value of the xtd::forms::month_calendar::selection_start property, xtd::forms::month_calendar::selection_start is automatically set equal to xtd::forms::month_calendar::selection_end.
If you set a date in xtd::forms::month_calendar::selection_end that causes the selection to exceed the number of days specified by the xtd::forms::month_calendar::max_selection_count property, the value of xtd::forms::month_calendar::selection_start is adjusted; xtd::forms::month_calendar::selection_start is automatically set so that the number of days selected is equal to xtd::forms::month_calendar::max_selection_count.
Note
xtd::forms::month_calendar::max_selection_count represents the number of days in the selection, not the difference between xtd::forms::month_calendar::selection_start and xtd::forms::month_calendar::selection_end. For example, if xtd::forms::month_calendar::max_selection_count is 7 (the default), then xtd::forms::month_calendar::selection_start and xtd::forms::month_calendar::selection_end can be no more than six days apart.
Setting the xtd::forms::month_calendar::selection_range for a xtd::forms::month_calendar control that has visual styles enabled will result in the selection range not painting correctly on the control.

◆ selection_range() [1/2]

xtd::forms::selection_range xtd::forms::month_calendar::selection_range ( ) const

Gets the selected range of dates for a month calendar control.

Returns
A xtd::forms::selection_range with the start and end dates of the selected range.
Remarks
Setting this property is functionally equivalent to using the xtd::forms::month_calendar::set_selection_range method. You can set the start and end dates separately by setting either the xtd::forms::month_calendar::selection_start or xtd::forms::month_calendar::selection_end properties. You cannot change the start and end dates by setting the xtd::forms::selection_range::start or xtd::forms::selection_range::end property values of the xtd::forms::month_calendar::selection_range property. You should use xtd::forms::month_calendar::selection_start, xtd::forms::month_calendar::selection_end, or xtd::forms::month_calendar::set_selection_range.
If the Start property value of the xtd::forms::month_calendar::selection_range is greater than its xtd::forms::selection_rande::end property value, the dates are swapped; the xtd::forms::selection_range::end property value becomes the starting date, and xtd::forms::selection_range::start property value becomes the end date.

◆ selection_range() [2/2]

month_calendar& xtd::forms::month_calendar::selection_range ( const xtd::forms::selection_range value)

Sets the selected range of dates for a month calendar control.

Parameters
valueA xtd::forms::selection_range with the start and end dates of the selected range.
Returns
Current month_calendar.
Remarks
Setting this property is functionally equivalent to using the xtd::forms::month_calendar::set_selection_range method. You can set the start and end dates separately by setting either the xtd::forms::month_calendar::selection_start or xtd::forms::month_calendar::selection_end properties. You cannot change the start and end dates by setting the xtd::forms::selection_range::start or xtd::forms::selection_range::end property values of the xtd::forms::month_calendar::selection_range property. You should use xtd::forms::month_calendar::selection_start, xtd::forms::month_calendar::selection_end, or xtd::forms::month_calendar::set_selection_range.
If the Start property value of the xtd::forms::month_calendar::selection_range is greater than its xtd::forms::selection_rande::end property value, the dates are swapped; the xtd::forms::selection_range::end property value becomes the starting date, and xtd::forms::selection_range::start property value becomes the end date.

◆ selection_start() [1/2]

xtd::date_time xtd::forms::month_calendar::selection_start ( ) const

Gets the start date of the selected range of dates.

Returns
A xtd::date_time indicating the first date in the selection range.
Remarks
If you set the value of the xtd::forms::month_calendar::selection_start property to a date that is later than the current value of the xtd::forms::month_calendar::selection_end property, xtd::forms::month_calendar::selection_end is automatically set equal to xtd::forms::month_calendar::selection_start.
If you set a date in xtd::forms::month_calendar::selection_start that causes the selection to exceed the number of days specified by the xtd::forms::month_calendar::max_selection_count property, the value of xtd::forms::month_calendar::selection_end is adjusted; xtd::forms::month_calendar::selection_end is automatically set so that the number of days selected is equal to xtd::forms::month_calendar::max_selection_count.
Note
xtd::forms::month_calendar::max_selection_count represents the number of days in the selection, not the difference between xtd::forms::month_calendar::selection_start and xtd::forms::month_calendar::selection_end. For example, if xtd::forms::month_calendar::max_selection_count is 7 (the default), then xtd::forms::month_calendar::selection_start and xtd::forms::month_calendar::selection_end can be no more than six days apart.
Setting the xtd::forms::month_calendar::selection_range for a xtd::forms::month_calendar control that has visual styles enabled will result in the selection range not painting correctly on the control.

◆ selection_start() [2/2]

month_calendar& xtd::forms::month_calendar::selection_start ( xtd::date_time  value)

Sets the start date of the selected range of dates.

Parameters
valueA xtd::date_time indicating the first date in the selection range.
Returns
Current month_calendar.
Remarks
If you set the value of the xtd::forms::month_calendar::selection_start property to a date that is later than the current value of the xtd::forms::month_calendar::selection_end property, xtd::forms::month_calendar::selection_end is automatically set equal to xtd::forms::month_calendar::selection_start.
If you set a date in xtd::forms::month_calendar::selection_start that causes the selection to exceed the number of days specified by the xtd::forms::month_calendar::max_selection_count property, the value of xtd::forms::month_calendar::selection_end is adjusted; xtd::forms::month_calendar::selection_end is automatically set so that the number of days selected is equal to xtd::forms::month_calendar::max_selection_count.
Note
xtd::forms::month_calendar::max_selection_count represents the number of days in the selection, not the difference between xtd::forms::month_calendar::selection_start and xtd::forms::month_calendar::selection_end. For example, if xtd::forms::month_calendar::max_selection_count is 7 (the default), then xtd::forms::month_calendar::selection_start and xtd::forms::month_calendar::selection_end can be no more than six days apart.
Setting the xtd::forms::month_calendar::selection_range for a xtd::forms::month_calendar control that has visual styles enabled will result in the selection range not painting correctly on the control.

◆ set_calendar_dimensions()

void xtd::forms::month_calendar::set_calendar_dimensions ( int32_t  x,
int32_t  y 
)

Sets the number of columns and rows of months to display.

Parameters
xThe number of columns.
yThe number of rows.
Exceptions
xtd::argumentsx or y is less than 1.

◆ set_date()

void xtd::forms::month_calendar::set_date ( const xtd::date_time date)

Sets a date as the currently selected date.

Parameters
dateThe date to be selected.
Remarks
This method sets the xtd::forms::month_calendar::selection_start and the xtd::forms::month_calendar::selection_end properties to the specified date. This method is the functional equivalent of setting the selection range to a single day through the xtd::forms::month_calendar::set_selection_range method or the xtd::forms::month_calendar::selection_range property.

◆ set_selection_range()

void xtd::forms::month_calendar::set_selection_range ( const xtd::date_time date1,
const xtd::date_time date2 
)

Sets the selected dates in a month calendar control to the specified date range.

Parameters
date1The beginning date of the selection range.
date2The end date of the selection range.
Remarks
Using this method is functionally equivalent to setting the xtd::forms::month_calendar::selection_range property. You can set the start and end dates separately by setting either the xtd::forms::month_calendar::selection_start or xtd::forms::month_calendar::selection_end property.
If you set the date1 parameter greater than the date2 parameter, both dates are set to the date1 value.

◆ show_today() [1/2]

bool xtd::forms::month_calendar::show_today ( ) const

Gets a value indicating whether the date represented by the xtd::today_date property is displayed at the bottom of the control.

Returns
true if today's date is displayed; otherwise, false. The default is true.
Remarks
The date is displayed in the format specified by the system settings for the short date format.

◆ show_today() [2/2]

month_calendar& xtd::forms::month_calendar::show_today ( bool  value)

Sets a value indicating whether the date represented by the xtd::today_date property is displayed at the bottom of the control.

Parameters
valuetrue if today's date is displayed; otherwise, false. The default is true.
Returns
Current month_calendar.
Remarks
The date is displayed in the format specified by the system settings for the short date format.

◆ show_today_circle() [1/2]

bool xtd::forms::month_calendar::show_today_circle ( ) const

Gets a value indicating whether today's date is identified with a circle or a square.

Returns
true if today's date is identified with a circle or a square; otherwise, false. The default is true.
Remarks
If xtd::forms::month_calendar::show_today_circle is true, and visual styles are enabled and supported on the computer running the application, today's date will be enclosed in a square, otherwise today's date will be circled.

◆ show_today_circle() [2/2]

month_calendar& xtd::forms::month_calendar::show_today_circle ( bool  value)

Sets a value indicating whether today's date is identified with a circle or a square.

Parameters
valuetrue if today's date is identified with a circle or a square; otherwise, false. The default is true.
Returns
Current month_calendar.
Remarks
If xtd::forms::month_calendar::show_today_circle is true, and visual styles are enabled and supported on the computer running the application, today's date will be enclosed in a square, otherwise today's date will be circled.

◆ show_week_numbers() [1/2]

bool xtd::forms::month_calendar::show_week_numbers ( ) const

Gets a value indicating whether the month calendar control displays week numbers (1-52) to the left of each row of days.

Returns
true if the week numbers are displayed; otherwise, false. The default is false.

◆ show_week_numbers() [2/2]

month_calendar& xtd::forms::month_calendar::show_week_numbers ( bool  value)

Sets a value indicating whether the month calendar control displays week numbers (1-52) to the left of each row of days.

Parameters
valuetrue if the week numbers are displayed; otherwise, false. The default is false.
Returns
Current month_calendar.

◆ single_month_size()

xtd::drawing::size xtd::forms::month_calendar::single_month_size ( ) const

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

Returns
The size, in pixels, necessary to fully display one month in the calendar.
Remarks
The size information is presented in the form of the xtd::forms::control::width and xtd::forms::control::height members, representing the minimum width and height required to display one month in the control. The minimum required window size for a month calendar control depends on the currently selected font.

◆ title_back_color() [1/2]

xtd::drawing::color xtd::forms::month_calendar::title_back_color ( ) const

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

Returns
A xtd::drawing::color. The default is the system color for active captions.
Remarks
The font color of the days-of-the-week text depends on the xtd::forms::month_calendar::title_back_color property. Setting the xtd::forms::month_calendar::title_back_color equal to the xtd::forms::month_control::back_color for the main display area of the calendar causes the days-of-the-week text to become unreadable.

◆ title_back_color() [2/2]

month_calendar& xtd::forms::month_calendar::title_back_color ( const xtd::drawing::color value)

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

Parameters
valueA xtd::drawing::color. The default is the system color for active captions.
Returns
Current month_calendar.
Remarks
The font color of the days-of-the-week text depends on the xtd::forms::month_calendar::title_back_color property. Setting the xtd::forms::month_calendar::title_back_color equal to the xtd::forms::control::back_color for the main display area of the calendar causes the days-of-the-week text to become unreadable.

◆ title_fore_color() [1/2]

xtd::drawing::color xtd::forms::month_calendar::title_fore_color ( ) const

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

Returns
A xtd::drawing::color. The default is the system color for active caption text.

◆ title_fore_color() [2/2]

month_calendar& xtd::forms::month_calendar::title_fore_color ( const xtd::drawing::color value)

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

Parameters
valueA xtd::drawing::color. The default is the system color for active caption text.
Returns
Current month_calendar.

◆ to_string()

xtd::ustring xtd::forms::month_calendar::to_string ( ) const
overridevirtualnoexcept

Returns a string containing the name of the control, if any.

Returns
A string containing the name of the control, if any, or class name if the control is unnamed.

Reimplemented from xtd::forms::control.

◆ today_date() [1/2]

const xtd::date_time& xtd::forms::month_calendar::today_date ( ) const

Gets the value that is used by xtd::forms::month_calendar as today's date.

Returns
A xtd::date_time representing today's date. The default value is the current system date.
Remarks
By default, the xtd::forms::month_calendar::today_date property returns the current system date, and the xtd::forms::month_calendar::today_date_set property is false. Setting the TodayDate property sets the xtd::forms::month_calendar::today_date_set property to true and, from that point, the value returned by the xtd::forms::month_calendar::roday_date property is the one the user sets.

◆ today_date() [2/2]

month_calendar& xtd::forms::month_calendar::today_date ( const xtd::date_time value)

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

Parameters
valueA xtd::date_time representing today's date. The default value is the current system date.
Returns
Current month_calendar.
Remarks
By default, the xtd::forms::month_calendar::today_date property returns the current system date, and the xtd::forms::month_calendar::today_date_set property is false. Setting the TodayDate property sets the xtd::forms::month_calendar::today_date_set property to true and, from that point, the value returned by the xtd::forms::month_calendar::roday_date property is the one the user sets.

◆ today_date_set()

bool xtd::forms::month_calendar::today_date_set ( ) const

Gets a value indicating whether the xtd::forms::month_calendar::today_date property has been explicitly set.

Returns
true if the value for the xtd::forms::month_calendar::today_date property has been explicitly set; otherwise, false. The default is false.

◆ trailing_fore_color() [1/2]

xtd::drawing::color xtd::forms::month_calendar::trailing_fore_color ( ) const

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

Returns
A xtd::drawing::color. The default is the system color for gray text.
Remarks
When the calendar is displayed, some dates precede and some follow the months that are fully displayed. Using the xtd::forms::month_calendar::trailing_fore_color property, you can modify the color of the text for those dates.

◆ trailing_fore_color() [2/2]

month_calendar& xtd::forms::month_calendar::trailing_fore_color ( const xtd::drawing::color value)

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

Parameters
valueA xtd::drawing::color. The default is the system color for gray text.
Returns
Current month_calendar.
Remarks
When the calendar is displayed, some dates precede and some follow the months that are fully displayed. Using the xtd::forms::month_calendar::trailing_fore_color property, you can modify the color of the text for those dates.

◆ update_bolded_dates()

void xtd::forms::month_calendar::update_bolded_dates ( )

Repaints the bold dates to reflect the dates set in the lists of bold dates.

Remarks
Use the xtd::forms::month_calendar::update_bolded_dates method to reflect changes made to xtd::forms::month_calendar::annually_bolded_dates, xtd::forms::month_calendar::monthly_bolded_dates, or xtd::forms::month_calendar::bolded_dates properties, either directly by modifying elements of the array or by using the add or remove methods provided to modify the date lists.

◆ wnd_proc()

void xtd::forms::month_calendar::wnd_proc ( xtd::forms::message m)
overrideprotectedvirtual

Processes Windows messages.

Parameters
mThe Windows Message to process.
Remarks
All messages are sent to the wnd_proc method after getting filtered through the pre_process_message method.
Notes to Inheritors
Inheriting controls should call the base class's wnd_proc(message&) method to process any messages that they do not handle.

Reimplemented from xtd::forms::control.


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