xtd::forms::form Class Reference

Inheritance diagram for xtd::forms::form:

Definition

Represents a window or dialog box that makes up an application's user interface.

Header

#include <xtd/forms/form> 

Namespace

xtd::forms

Library

xtd.forms

Remarks

A form is a representation of any window displayed in your application. The Form class can be used to create standard, tool, borderless, and floating windows. You can also use the form class to create modal windows such as a dialog box. A special kind of form, the multiple-document interface (MDI) form, can contain other forms called MDI child forms. An MDI form is created by setting the is_mdi_container property to true. MDI child forms are created by setting the mdi_parent property to the MDI parent form that will contain the child form.

Using the properties available in the form class, you can determine the appearance, size, color, and window management features of the window or dialog box you are creating. The text property allows you to specify the caption of the window in the title bar. The size and desktop_location properties allow you to define the size and position of the window when it is displayed. You can use the fore_color color property to change the default foreground color of all controls placed on the form. The form_border_style, minimize_box, and maximize_box properties allow you to control whether the form can be minimized, maximized, or resized at run time.

In addition to properties, you can use the methods of the class to manipulate a form. For example, you can use the show_dialog method to show a form as a modal dialog box. You can use the set_desktop_location method to position the form on the desktop.

Appearance

	Windows	macOS	Gnome
Light
Dark

Examples

The following code example demonstrates the use of form control.

#include <xtd/forms/application>
#include <xtd/forms/button>
#include <xtd/forms/form>
#include <xtd/forms/message_box>
#include <xtd/overload>
 
using namespace xtd;
using namespace xtd::forms;
 
class form1 : public form {
public:
  form1() {
    text("form1");
    location({300, 200});
    size({640, 480});
    
    button_close.parent(*this);
    button_close.text("Close");
    button_close.auto_size(true);
    button_close.location({10, 10});
    button_close.click += event_handler {*this, &form::close};
    
    button_exit.parent(*this);
    button_exit.text("Exit");
    button_exit.auto_size(true);
    button_exit.location({100, 10});
    button_exit.click += overload_<>(&application::exit);
    
    button_exit_thread.parent(*this);
    button_exit_thread.text("Exit thread");
    button_exit_thread.auto_size(true);
    button_exit_thread.location({190, 10});
    button_exit_thread.click += &application::exit_thread;
  }
  
protected:
  void on_form_closing(form_closing_event_args& e) override {
    e.cancel(message_box::show(*this, "Are you sure you want exit?", "Close Form", message_box_buttons::yes_no, message_box_icon::question) == dialog_result::no);
  }
  
private:
  forms::button button_close;
  forms::button button_exit;
  forms::button button_exit_thread;
};
 
auto main()->int {
  application::run(form1 {});
}

Examples

about_box.cpp, about_dialog.cpp, about_dialog_from_executing_assembly_informations.cpp, about_dialog_system.cpp, about_dialog_with_user_pages.cpp, anchors.cpp, animation.cpp, application.cpp, application_add_message_filter.cpp, application_and_assert.cpp, application_and_exception.cpp, application_application_exit.cpp, application_enable_dark_mode.cpp, application_enable_light_mode.cpp, application_events.cpp, application_idle.cpp, application_use_wait_cursor.cpp, application_with_cmake_assembly_info.cpp, application_with_manual_assembly_info.cpp, assert_box.cpp, assert_dialog.cpp, auto_scroll.cpp, background_worker.cpp, bitmap_button.cpp, bitmap_button_with_text.cpp, border_style.cpp, busy_box.cpp, busy_dialog.cpp, button.cpp, button2.cpp, button3.cpp, button_appearance.cpp, button_images.cpp, button_renderer.cpp, button_with_style_sheet.cpp, calculator.cpp, change_color.cpp, change_parent.cpp, check_box.cpp, check_box_appearance.cpp, check_box_renderer.cpp, checked_list_box.cpp, choice.cpp, circular_form.cpp, clock.cpp, collapsible_panel.cpp, color_box.cpp, color_dialog.cpp, color_picker.cpp, colored_tab_pages.cpp, colors.cpp, combo_box.cpp, command_link_button.cpp, context_menu.cpp, control.cpp, control_with_name_operator.cpp, countries.cpp, cursors.cpp, date_time_picker.cpp, debug_form.cpp, debug_message_box.cpp, debug_message_dialog.cpp, demo.cpp, dialog.cpp, domain_up_down.cpp, dot_matrix_display.cpp, draw_ellipse.cpp, draw_image.cpp, draw_line.cpp, draw_point.cpp, draw_rectangle.cpp, draw_rounded_rectangle.cpp, enable_changed_event.cpp, enable_debug.cpp, exception_box.cpp, exception_dialog.cpp, fill_ellipse.cpp, fill_rectangle.cpp, fill_rounded_rectangle.cpp, find_box.cpp, find_dialog.cpp, flat_button.cpp, folder_browser_box.cpp, folder_browser_dialog.cpp, font_box.cpp, font_changed_event.cpp, font_dialog.cpp, font_families.cpp, font_picker.cpp, form.cpp, form_and_main.cpp, form_and_messages.cpp, form_and_thread.cpp, form_background_image.cpp, form_background_image2.cpp, form_click.cpp, form_custom_event.cpp, form_decoration.cpp, form_paint.cpp, form_resize.cpp, form_show.cpp, form_show_hide.cpp, form_window_state.cpp, forms_timer.cpp, fourteen_segment_display.cpp, graph_control.cpp, group_box.cpp, group_box_and_check_box.cpp, group_box_and_radio_button.cpp, h_scroll_bar.cpp, hello_world_cmake.cpp, hello_world_emoticons.cpp, hello_world_label.cpp, hello_world_message_box.cpp, hello_world_paint.cpp, hello_world_say.cpp, hello_world_xtd.cpp, horizontal_layout_panel.cpp, image_converter.cpp, image_list.cpp, images.cpp, images2.cpp, images3.cpp, input_box.cpp, input_dialog.cpp, input_dialog_multiline.cpp, input_dialog_password.cpp, key_events.cpp, label.cpp, labels_and_unicode_text.cpp, lcd_label.cpp, lcd_label2.cpp, lcd_label_appearance.cpp, lcd_label_with_dot_matrix.cpp, lcd_label_with_fourteen_segment.cpp, lcd_label_with_nine_segment.cpp, lcd_label_with_seven_segment.cpp, lcd_label_with_sixteen_segment.cpp, light_button.cpp, line.cpp, link_label.cpp, list_box.cpp, loading_indicator.cpp, loading_indicators.cpp, main_menu.cpp, main_menu_create_standard_items.cpp, message_box.cpp, message_box_appearance.cpp, message_dialog.cpp, message_dialog_show_sheet.cpp, month_calendar.cpp, mouse_events.cpp, nine_segment_display.cpp, numeric_text_box.cpp, numeric_up_down.cpp, open_file_box.cpp, open_file_dialog.cpp, owner_button.cpp, painting.cpp, panel.cpp, picture_box.cpp, popup_form.cpp, popup_panel.cpp, process_form.cpp, progress_bar.cpp, progress_box.cpp, progress_dialog.cpp, radio_button.cpp, radio_button_renderer.cpp, replace_box.cpp, replace_dialog.cpp, save_file_box.cpp, save_file_dialog.cpp, screen.cpp, screen_informations.cpp, send_message_to_form.cpp, seven_segment_display.cpp, sixteen_segment_display.cpp, some_controls.cpp, some_system_controls.cpp, split_container.cpp, splitter.cpp, status_bar.cpp, status_bar_without_panels.cpp, stopwatch_form.cpp, switch_button.cpp, system_report.cpp, system_sound.cpp, tab_control.cpp, target_default_namespace.cpp, target_startup.cpp, text_box.cpp, text_box_multiline.cpp, text_box_password.cpp, text_box_password2.cpp, texts.cpp, themes.cpp, timers_timer_synchronizing_object.cpp, toggle_button.cpp, toggle_button2.cpp, toggle_light.cpp, tool_bar.cpp, trace_form.cpp, trace_message_box.cpp, trace_message_dialog.cpp, track_bar.cpp, track_bar2.cpp, translator.cpp, translator_with_language.cpp, tutorial_application_icon.cpp, tutorial_button.cpp, tutorial_communicate.cpp, tutorial_simple_application.cpp, up_down_button.cpp, use_wait_cursor.cpp, user_control.cpp, user_dialog.cpp, user_dialog_show_sheet.cpp, v_scroll_bar.cpp, vertical_layout_panel.cpp, wiggly.cpp, and wnd_proc.cpp.

Public Aliases
using	ibutton_control_ref = std::reference_wrapper< xtd::forms::ibutton_control >
	Represent an xtd::forms::ibutton_control reference.
using	main_menu_ref = std::reference_wrapper< xtd::forms::main_menu >
	Represent an xtd::forms::main_menu reference.
using	status_bar_ref = std::reference_wrapper< xtd::forms::status_bar >
	Represent an xtd::forms::status_bar reference.
using	tool_bar_ref = std::reference_wrapper< xtd::forms::tool_bar >
	Represent an xtd::forms::tool_bar reference.

Public Events
event< form, event_handler >	activated
	Occurs when the form is activated in code or by the user.
event< form, event_handler >	deactivate
	Occurs when the form loses focus and is no longer the active form.
event< form, form_closed_event_handler >	form_closed
	Occurs after the form is closed.
event< form, form_closing_event_handler >	form_closing
	Occurs before the form is closed.

Public Constructors
	form ()
	Initializes a new instance of the Form class.

Public Properties
std::optional< ibutton_control_ref >	accept_button () const noexcept
	Gets the button on the form that is clicked when the user presses the ENTER key.
form &	accept_button (const ibutton_control &value)
	Sets the button on the form that is clicked when the user presses the ENTER key.
form &	accept_button (std::nullptr_t)
	Sets the button on the form that is clicked when the user presses the ENTER key.
virtual forms::auto_size_mode	auto_size_mode () const noexcept
	Gets the mode by which the form automatically resizes itself.
virtual form &	auto_size_mode (forms::auto_size_mode value)
	Sets the mode by which the form automatically resizes itself.
std::optional< ibutton_control_ref >	cancel_button () const noexcept
	Gets the button control that is clicked when the user presses the ESC key.
form &	cancel_button (const ibutton_control &value)
	Gets the button control that is clicked when the user presses the ESC key.
form &	cancel_button (std::nullptr_t)
	Gets the button control that is clicked when the user presses the ESC key.
virtual bool	close_box () const noexcept
	Gets a value indicating whether a close box is displayed in the caption bar of the form.
virtual form &	close_box (bool value)
	Sets a value indicating whether a close box is displayed in the caption bar of the form.
virtual bool	control_box () const noexcept
	Gets a value indicating whether a control box is displayed in the caption bar of the form.
virtual form &	control_box (bool value)
	Sets a value indicating whether a control box is displayed in the caption bar of the form.
virtual forms::dialog_result	dialog_result () const noexcept
	Gets the dialog result for the form.
virtual form &	dialog_result (forms::dialog_result value)
	Sets the dialog result for the form.
virtual forms::form_border_style	form_border_style () const noexcept
	Gets the border style of the form.
virtual form &	form_border_style (forms::form_border_style value)
	Gets the border style of the form.
virtual bool	help_button () const
	Gets a value indicating whether a Help button should be displayed in the caption box of the form.
virtual form &	help_button (bool value)
	Sets a value indicating whether a Help button should be displayed in the caption box of the form.
virtual const xtd::drawing::icon &	icon () const noexcept
	Gets the icon for the form.
virtual form &	icon (const xtd::drawing::icon &value)
	Sets the icon for the form.
virtual bool	maximize_box () const noexcept
	Gets a value indicating whether the Maximize button is displayed in the caption bar of the form.
virtual form &	maximize_box (bool value)
	Sets a value indicating whether the Maximize button is displayed in the caption bar of the form.
virtual std::optional< main_menu_ref >	menu () const noexcept
	Gets the main_menu that is displayed in the form.
virtual form &	menu (const forms::main_menu &value)
	Sets the main_menu that is displayed in the form.
virtual form &	menu (std::nullptr_t)
	Sets the main_menu that is displayed in the form.
virtual bool	minimize_box () const noexcept
	Gets a value indicating whether the Minimize button is displayed in the caption bar of the form.
virtual form &	minimize_box (bool value)
	Sets a value indicating whether the Minimize button is displayed in the caption bar of the form.
bool	modal () const noexcept
	Gets a value indicating whether this form is displayed modally.
virtual double	opacity () const noexcept
	Gets form opacity.
virtual form &	opacity (double opacity)
	Sets form opacity.
virtual std::optional< control_ref >	owner () const noexcept
	Gets the form that owns this form.
virtual form &	owner (const control &value)
	Sets the form that owns this form.
virtual form &	owner (std::nullptr_t)
	Resets the form that owns this form.
control &	parent (const control &value) override
	Sets the parent container of the control.
virtual bool	show_icon () const noexcept
	Gets a value indicating whether an icon is displayed in the caption bar of the form.
virtual form &	show_icon (bool value)
	Sets a value indicating whether an icon is displayed in the caption bar of the form.
virtual bool	show_in_taskbar () const noexcept
	Gets a value indicating whether the form is displayed in the Windows taskbar.
virtual form &	show_in_taskbar (bool value)
	Sets a value indicating whether the form is displayed in the Windows taskbar.
virtual form_start_position	start_position () const noexcept
	Gets the starting position of the form at run time.
virtual form &	start_position (form_start_position value)
	Sets the starting position of the form at run time.
virtual std::optional< status_bar_ref >	status_bar () const noexcept
	Gets the status_bar that is displayed in the form.
virtual form &	status_bar (const forms::status_bar &value)
	Sets the status_bar that is displayed in the form.
virtual form &	status_bar (std::nullptr_t)
	Resets the status_bar that is displayed in the form.
virtual std::optional< tool_bar_ref >	tool_bar () const noexcept
	Gets the tool_bar that is displayed in the form.
virtual form &	tool_bar (const forms::tool_bar &value)
	Sets the tool_bar that is displayed in the form.
virtual form &	tool_bar (std::nullptr_t)
	Resets the tool_bar that is displayed in the form.
virtual bool	top_level () const noexcept
	Gets a value indicating whether to display the form as a top-level window.
virtual form &	top_level (bool top_level)
	Sets a value indicating whether to display the form as a top-level window.
virtual bool	top_most () const noexcept
	Gets a value indicating whether the form should be displayed as a topmost form.
virtual form &	top_most (bool value)
	Sets a value indicating whether the form should be displayed as a topmost form.
control &	visible (bool visible) override
	Sets a value indicating whether the control and all its child controls are displayed.
virtual form_window_state	window_state () const noexcept
	Gets a value that indicates whether form is minimized, maximized, or normal.
virtual form &	window_state (form_window_state value)
	Sets a value that indicates whether form is minimized, maximized, or normal.

Public Methods
void	activate ()
	Activates the form and gives it focus.
void	bring_to_front () override
	Brings the control to the front of the z-order.
void	center_to_screen ()
	Centers the position of the form within the bounds of the parent form.
void	close ()
	Closes the form.
bool	pre_process_message (const xtd::forms::message &message) override
	Preprocesses keyboard or input messages within the message loop before they are dispatched.
virtual forms::dialog_result	show_dialog ()
	Shows the form as a modal dialog box.
virtual forms::dialog_result	show_dialog (const iwin32_window &owner)
	Shows the form as a modal dialog box with the specified owner. @parm owner Any object that implements iwin32_window that represents the top-level window that will own the modal dialog box.
virtual void	show_sheet (const iwin32_window &owner)
	Shows the form as a sheet dialog box.
virtual forms::dialog_result	show_sheet_dialog (const iwin32_window &owner)
	Shows the form as a modal sheet dialog box.

Public Static Properties
static std::optional< form_ref >	active_form () noexcept
	Gets the currently active form for this application.

Public Static Methods
static form	create ()
	A factory to create an xtd::forms::form.
static form	create (const xtd::ustring &text)
	A factory to create an xtd::forms::form with specified text.
static form	create (const xtd::ustring &text, const drawing::point &location)
	A factory to create an xtd::forms::form with specified text, and location.
static form	create (const xtd::ustring &text, const drawing::point &location, const drawing::size &size)
	A factory to create an xtd::forms::form with specified text, location, and size.
static form	create (const xtd::ustring &text, const drawing::point &location, const drawing::size &size, const xtd::ustring &name)
	A factory to create an xtd::forms::form with specified text, location, size, and name.
static form	create (const xtd::ustring &text, const drawing::size &size)
	A factory to create an xtd::forms::form with specified text, and size.
static form	create (const xtd::ustring &text, const drawing::size &size, const xtd::ustring &name)
	A factory to create an xtd::forms::form with specified text, size, and name.
static form	create (const xtd::ustring &text, form_start_position start_position)
	A factory to create an xtd::forms::form with specified text, and form start position.
static form	create (const xtd::ustring &text, form_start_position start_position, const drawing::point &location)
	A factory to create an xtd::forms::form with specified text, form start position, and location.
static form	create (const xtd::ustring &text, form_start_position start_position, const drawing::point &location, const drawing::size &size)
	A factory to create an xtd::forms::form with specified text, form start position, location, and size.
static form	create (const xtd::ustring &text, form_start_position start_position, const drawing::point &location, const drawing::size &size, const xtd::ustring &name)
	A factory to create an xtd::forms::form with specified text, form start position, location, size, and name.
static form	create (const xtd::ustring &text, form_start_position start_position, const drawing::size &size)
	A factory to create an xtd::forms::form with specified text, form start position, and size.
static form	create (const xtd::ustring &text, form_start_position start_position, const drawing::size &size, const xtd::ustring &name)
	A factory to create an xtd::forms::form with specified text, form start position, size, and name.

Protected Properties
forms::create_params	create_params () const noexcept override
	Gets the required creation parameters when the control handle is created.
drawing::size	default_size () const noexcept override
	Gets the default size of the control.

Protected Methods
std::unique_ptr< xtd::object >	clone () const override
	Creates a new object that is a copy of the current instance.
virtual void	on_activated (const event_args &e)
	Raises the form::activated event.
virtual void	on_deactivate (const event_args &e)
	Raises the form::deactivate event.
void	on_handle_created (const event_args &e) override
	Raises the xtd::forms::control::handle_created event.
void	on_handle_destroyed (const event_args &e) override
	Raises the xtd::forms::control::handle_destroyed event.
virtual void	on_form_closed (const form_closed_event_args &e)
	Raises the form::form_closed event.
virtual void	on_form_closing (form_closing_event_args &e)
	Raises the form::form_closing event.
void	on_layout (const event_args &e) override
	Raises the xtd::forms::control::layout event.
void	on_location_changed (const event_args &e) override
	Raises the xtd::forms::control::location_changed event.
void	on_paint (paint_event_args &e) override
	Raises the xtd::forms::control::paint event.
void	on_region_changed (const event_args &e) override
	Raises the xtd::forms::control::region_changed event.
void	on_resize (const event_args &e) override
	Raises the xtd::forms::control::region event.
void	wnd_proc (message &message) override
	Processes Windows messages.

Additional Inherited Members
Public Types inherited from xtd::forms::control
using	context_menu_ref = std::reference_wrapper< xtd::forms::context_menu >
	Represent an xtd::forms::context_menu reference.
Public Attributes inherited from xtd::forms::control
event< control, event_handler >	auto_size_changed
	Occurs when the value of the xtd::forms::control::auto_size property changes.
event< control, event_handler >	back_color_changed
	Occurs when the value of the xtd::forms::control::back_color property changes.
event< control, event_handler >	background_image_changed
	Occurs when the value of the xtd::forms::control::background_image property changes.
event< control, event_handler >	background_image_layout_changed
	Occurs when the value of the xtd::forms::control::background_image_layout property changes.
event< control, event_handler >	control_appearance_changed
	Occurs when the value of the xtd::forms::control::control_appearance property changes.
event< control, event_handler >	click
	Occurs when the xtd::forms::control is clicked.
event< control, event_handler >	client_size_changed
	Occurs when the value of the xtd::forms::control::client_size property changes.
event< control, event_handler >	cursor_changed
	Occurs when the value of the xtd::forms::control::cursor property changes.
event< control, control_event_handler >	control_added
	Occurs when a new xtd::forms::control::control is added to the xtd::forms::control::control_collection.
event< control, control_event_handler >	control_removed
	Occurs when a new xtd::forms::control:: is removed to the xtd::forms::control::control_collection.
event< control, event_handler >	dock_changed
	Occurs when the value of the xtd::forms::control::dock property changes.
event< control, event_handler >	double_click
	Occurs when the xtd::forms::control is double-clicked.
event< control, event_handler >	got_focus
	Occurs when the xtd::forms::control receives focus.
event< control, event_handler >	handle_created
	Occurs when a handle is created for the xtd::forms::control.
event< control, event_handler >	handle_destroyed
	Occurs when the control's handle is in the process of being destroyed.
event< control, event_handler >	enabled_changed
	Occurs when the value of the xtd::forms::control::enabled property changes.
event< control, event_handler >	fore_color_changed
	Occurs when the value of the xtd::forms::control::fore_color property changes.
event< control, event_handler >	font_changed
	Occurs when the value of the xtd::forms::control::font property changes.
event< control, help_event_handler >	help_requested
	Occurs when the user requests help for a xtd::forms::control.
event< control, key_event_handler >	key_down
	Occurs when a key is pressed while the xtd::forms::control has focus.
event< control, key_press_event_handler >	key_press
	Occurs when a character. space or backspace key is pressed while the xtd::forms::control has focus.
event< control, key_event_handler >	key_up
	Occurs when a key is released while the xtd::forms::control has focus.
event< control, event_handler >	layout
	Occurs when a xtd::forms::control should reposition its child controls.
event< control, event_handler >	location_changed
	Occurs when the value of the xtd::forms::control::location property changes.
event< control, event_handler >	lost_focus
	Occurs when the xtd::forms::control loses focus.
event< control, mouse_event_handler >	mouse_click
	Occurs when the xtd::forms::control is clicked by the mouse.
event< control, mouse_event_handler >	mouse_double_click
	Occurs when the xtd::forms::control is double clicked by the mouse.
event< control, mouse_event_handler >	mouse_down
	Occurs when the mouse pointer is over the xtd::forms::control and a mouse button is pressed.
event< control, event_handler >	mouse_enter
	Occurs when the mouse pointer enters the xtd::forms::control.
event< control, mouse_event_handler >	mouse_horizontal_wheel
	Occurs when the mouse horizontal wheel moves while the xtd::forms::control has focus.
event< control, event_handler >	mouse_leave
	Occurs when the mouse pointer leaves the xtd::forms::control.
event< control, mouse_event_handler >	mouse_move
	Occurs when the mouse pointer is moved over the xtd::forms::control.
event< control, mouse_event_handler >	mouse_up
	Occurs when the mouse pointer is over the xtd::forms::control and a mouse button is released.
event< control, mouse_event_handler >	mouse_wheel
	Occurs when the mouse wheel moves while the xtd::forms::control has focus.
event< control, event_handler >	move
	Occurs when the control is moved.
event< control, paint_event_handler >	paint
	Occurs when the xtd::forms::control is redrawn.
event< control, event_handler >	parent_changed
	Occurs when the value of the xtd::forms::control::parent property changes.
event< control, event_handler >	region_changed
	Occurs when the value of the xtd::forms::control::region property changes.
event< control, event_handler >	resize
	Occurs when the xtd::forms::control is resized.
event< control, event_handler >	right_to_left_changed
	Occurs when the value of the xtd::forms::control::right_to_left property changes.
event< control, event_handler >	size_changed
	Occurs when the value of the xtd::forms::control::size property changes.
event< control, event_handler >	style_sheet_changed
	Occurs when the value of the xtd::forms::control::style_sheet property changes or when xtd::application::style_sheet property changes.
event< control, event_handler >	system_colors_changed
	Occurs when the xtd::drwing::system_colors changes.
event< control, event_handler >	tab_stop_changed
	Occurs when the xtd::forms::control::tab_stop property value changes.
event< control, event_handler >	text_changed
	Occurs when the value of the xtd::forms::control::text property changes.
event< control, event_handler >	visible_changed
	Occurs when the value of the xtd::forms::control::visible property changes.
Public Member Functions inherited from xtd::forms::container_control
std::optional< control_ref >	active_control () const noexcept
	Gets the active control on the container control.
void	active_control (const control &active_control)
	Sets the active control on the container control.
void	active_control (std::nullptr_t)
	Resets the active control on the container control.
Public Member Functions inherited from xtd::forms::scrollable_control
virtual bool	auto_scroll () const noexcept
	Gets a value indicating whether the container enables the user to scroll to any controls placed outside of its visible boundaries.
virtual scrollable_control &	auto_scroll (bool auto_scroll)
	Sets a value indicating whether the container enables the user to scroll to any controls placed outside of its visible boundaries.
drawing::size	auto_scroll_margin () const noexcept
	Gets the size of the auto-scroll margin.
scrollable_control &	auto_scroll_margin (const drawing::size &value)
	Sets the size of the auto-scroll margin.
drawing::rectangle	display_rectangle () const noexcept override
	Gets the rectangle that represents the virtual display area of the control.
virtual bool	h_scroll () const noexcept
	Gets a value indicating whether the horizontal scroll bar is visible.
virtual scrollable_control &	h_scroll (bool h_scroll)
	Sets a value indicating whether the horizontal scroll bar is visible.
virtual bool	v_scroll () const noexcept
	Gets a value indicating whether the vertical scroll bar is visible.
virtual scrollable_control &	v_scroll (bool v_scroll)
	Sets a value indicating whether the vertical scroll bar is visible.
Public Member Functions inherited from xtd::forms::control
	control ()
	Initializes a new instance of the xtd::forms::control class with default settings.
	control (const xtd::ustring &text)
	Initializes a new instance of the xtd::forms::control class with specific text.
	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.
	control (const xtd::ustring &text, int32 left, int32 top, int32 width, int32 height)
	Initializes a new instance of the control class with specific text, size, and location.
	control (const control &parent, const xtd::ustring &text, int32 left, int32 top, int32 width, int32 height)
	Initializes a new instance of the xtd::forms::control class as a child control, with specific text, size, and location.
virtual anchor_styles	anchor () const noexcept
	Gets the edges of the container to which a control is bound and determines how a control is resized with its parent.
virtual control &	anchor (xtd::forms::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.
virtual drawing::point	auto_scroll_point () const noexcept
	Gets where this control is scrolled to in scroll_control_into_view(control).
virtual bool	auto_size () const noexcept
	Gets a value that indicates whether the control resizes based on its contents.
virtual control &	auto_size (bool auto_size)
	Sets a value that indicates whether the control resizes based on its contents.
virtual drawing::color	back_color () const noexcept
	Gets the background color for the control.
virtual control &	back_color (const xtd::drawing::color &color)
	Sets the background color for the control.
virtual const xtd::drawing::image &	background_image () const noexcept
	Gets the background image displayed in the control.
virtual control &	background_image (const xtd::drawing::image &background_image)
	Sets the background image displayed in the control.
virtual xtd::forms::image_layout	background_image_layout () const noexcept
	Gets the background image layout as defined in the xtd::forms::image_layout enumeration.
virtual control &	background_image_layout (xtd::forms::image_layout background_image_layout)
	Sets the background image layout as defined in the xtd::forms::image_layout enumeration.
virtual int32	bottom () const noexcept
	Gets the distance, in pixels, between the bottom edge of the control and the top edge of its container's client area.
virtual drawing::rectangle	bounds () const noexcept
	Gets the size and location of the control including its nonclient elements, in pixels, relative to the parent control.
virtual control &	bounds (const xtd::drawing::rectangle &bounds)
	Sets the size and location of the control including its nonclient elements, in pixels, relative to the parent control.
virtual bool	can_focus () const noexcept
	Gets a value indicating whether the control can receive focus.
virtual bool	can_select () const noexcept
	Gets a value indicating whether the control can be selected.
bool	can_raise_events () const noexcept override
	Determines if events can be raised on the control.
virtual const drawing::rectangle &	client_rectangle () const noexcept
	Gets the rectangle that represents the client area of the control.
virtual const drawing::size &	client_size () const noexcept
	Gets the height and width of the client area of the control.
virtual control &	client_size (const xtd::drawing::size &client_size)
	Sets the height and width of the client area of the control.
virtual xtd::ustring	company_name () const noexcept
	Gets the name of the company or creator of the application containing the control.
virtual std::optional< context_menu_ref >	context_menu () const noexcept
	Gets the xtd::forms::context_menu that is displayed in the control.
virtual control &	context_menu (xtd::forms::context_menu &value)
	Sets the xtd::forms::context_menu that is displayed in the control.
virtual control &	context_menu (std::nullptr_t)
	Sets the xtd::forms::context_menu that is displayed in the control.
virtual forms::control_appearance	control_appearance () const noexcept
	Gets control appearance.
virtual control &	control_appearance (xtd::forms::control_appearance value)
	Sets control appearance.
virtual control_collection &	controls () noexcept
	Gets the collection of controls contained within the control.
virtual const control_collection &	controls () const noexcept
	Gets the collection of controls contained within the control.
virtual bool	created () const noexcept
	Gets a value indicating whether the control has been created.
virtual forms::cursor	cursor () const noexcept
	Gets the cursor that is displayed when the mouse pointer is over the control.
virtual control &	cursor (const xtd::forms::cursor &cursor)
	Sets the cursor that is displayed when the mouse pointer is over the control.
virtual dock_style	dock () const noexcept
	Gets which control borders are docked to its parent control and determines how a control is resized with its parent.
virtual control &	dock (xtd::forms::dock_style dock)
	Sets which control borders are docked to its parent control and determines how a control is resized with its parent.
virtual bool	double_buffered () const noexcept
	Gets a value indicating whether this control should redraw its surface using a secondary buffer to reduce or prevent flicker.
virtual control &	double_buffered (bool double_buffered)
	Sets a value indicating whether this control should redraw its surface using a secondary buffer to reduce or prevent flicker.
virtual bool	enabled () const noexcept
	Gets a value indicating whether the control can respond to user interaction.
virtual control &	enabled (bool enabled)
	Sets a value indicating whether the control can respond to user interaction.
virtual bool	focused () const noexcept
	Gets a value indicating whether the control has input focus.
virtual drawing::font	font () const noexcept
	Gets the font of the text displayed by the control.
virtual control &	font (const xtd::drawing::font &font)
	Sets the font of the text displayed by the control.
virtual drawing::color	fore_color () const noexcept
	Gets the foreground color of the control.
virtual control &	fore_color (const xtd::drawing::color &color)
	Sets the foreground color of the control.
intptr	handle () const override
	Gets the window handle that the control is bound to.
virtual int32	height () const noexcept
	Gets the height of the control.
virtual control &	height (int32 height)
	Sets the height of the control.
bool	invoke_required () const noexcept override
	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.
bool	is_handle_created () const noexcept
	Gets a value indicating whether the control has a handle associated with it.
virtual int32	left () const noexcept
	Gets the distance, in pixels, between the left edge of the control and the left edge of its container's client area.
virtual control &	left (int32 left)
	Sets the distance, in pixels, between the left edge of the control and the left edge of its container's client area.
virtual drawing::point	location () const noexcept
	Gets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container.
virtual control &	location (const xtd::drawing::point &location)
	Sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container.
virtual forms::padding	margin () const noexcept
	Gets the space between controls.
virtual control &	margin (const xtd::forms::padding &margin)
	Sets the space between controls.
virtual const drawing::size &	maximum_client_size () const noexcept
	Gets the client size that is the upper limit that xtd::forms::control::get_preferred_size can specify.
virtual control &	maximum_client_size (const xtd::drawing::size &size)
	Sets the client size that is the upper limit that xtd::forms::control::get_preferred_size can specify.
virtual const drawing::size &	maximum_size () const noexcept
	Gets the size that is the upper limit that xtd::forms::control::get_preferred_size can specify.
virtual control &	maximum_size (const xtd::drawing::size &size)
	Sets the size that is the upper limit that xtd::forms::control::get_preferred_size can specify.
virtual const drawing::size &	minimum_client_size () const noexcept
	Gets the client size that is the lower limit that xtd::forms::control::get_preferred_size can specify.
virtual control &	minimum_client_size (const xtd::drawing::size &size)
	Sets the client size that is the lower limit that xtd::forms::control::get_preferred_size can specify.
virtual const drawing::size &	minimum_size () const noexcept
	Gets the size that is the lower limit that xtd::forms::control::get_preferred_size can specify.
virtual control &	minimum_size (const xtd::drawing::size &size)
	Sets the size that is the lower limit that xtd::forms::control::get_preferred_size can specify.
intptr	native_handle () const noexcept
	Gets the native handle that the control is bound to.
virtual const xtd::ustring &	name () const noexcept
	Gets the name of the control.
virtual control &	name (const xtd::ustring &name)
	Sets the name of the control.
virtual forms::padding	padding () const noexcept
	Gets padding within the control.
virtual control &	padding (const xtd::forms::padding &padding)
	Sets padding within the control.
virtual std::optional< control_ref >	parent () const noexcept
	Gets the parent container of the control.
virtual control &	parent (std::nullptr_t)
	Resets the parent container of the control.
virtual xtd::ustring	product_name () const noexcept
	Gets the product name of the assembly containing the control.
bool	recreating_handle () const noexcept
	Gets a value indicating whether the control is currently re-creating its handle.
virtual const xtd::drawing::region &	region () const noexcept
	Gets the window region associated with the control.
virtual control &	region (const xtd::drawing::region &value)
	Sets the window region associated with the control.
virtual int32	right () const noexcept
	Gets the distance, in pixels, between the right edge of the control and the left edge of its container's client area.
virtual xtd::forms::right_to_left	right_to_left () const noexcept
	Gets a value indicating whether control's elements are aligned to support locales using right-to-left fonts.
virtual control &	right_to_left (xtd::forms::right_to_left value)
	Sets a value indicating whether control's elements are aligned to support locales using right-to-left fonts.
virtual drawing::size	size () const noexcept
	Gets the height and width of the control.
virtual control &	size (const drawing::size &size)
	Sets the height and width of the control.
virtual style_sheets::style_sheet	style_sheet () const noexcept
	Gets the contol style sheet.
virtual control &	style_sheet (const style_sheets::style_sheet &value)
	Sets the contol style sheet.
virtual control &	style_sheet (const xtd::ustring &value)
	Sets the contol style sheet.
virtual control &	style_sheet (std::nullptr_t)
	Resets the contol style sheet.
virtual bool	tab_stop () const noexcept
	Gets a value indicating whether the user can give the focus to this control using the TAB key.
virtual control &	tab_stop (bool value)
	Sets a value indicating whether the user can give the focus to this control using the TAB key.
virtual std::any	tag () const noexcept
	Gets the object that contains data about the control.
virtual control &	tag (std::any tag)
	Sets the object that contains data about the control.
virtual const xtd::ustring &	text () const noexcept
	Gets the text associated with this control.
virtual control &	text (const xtd::ustring &text)
	Sets the text associated with this control.
intptr	toolkit_handle () const noexcept
	Gets the toolkit handle that the control is bound to.
virtual int32	top () const noexcept
	Gets the distance, in pixels, between the top edge of the control and the top edge of its container's client area.
virtual control &	top (int32 top)
	Sets the distance, in pixels, between the top edge of the control and the top edge of its container's client area.
virtual std::optional< control_ref >	top_level_control () const noexcept
	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.
virtual bool	visible () const noexcept
	Gets a value indicating whether the control and all its child controls are displayed.
virtual int32	width () const noexcept
	Gets the width of the control.
virtual control &	width (int32 width)
	Sets the width of the control.
xtd::async_result	begin_invoke (delegate< void()> method) override
	Executes the specified delegate asynchronously on the thread that the control's underlying handle was created on.
xtd::async_result	begin_invoke (delegate< void(std::vector< std::any >)> method, const std::vector< std::any > &args) override
	Executes the specified delegate asynchronously with the specified arguments, on the thread that the control's underlying handle was created on.
int32	compare_to (const control &value) const noexcept override
void	create_control ()
	Forces the creation of the visible control, including the creation of the handle and any visible child controls.
drawing::graphics	create_graphics () const
	Creates the xtd::drawing::graphics for the control.
virtual void	destroy_control ()
	Forces the destruction of the visible control, including the destruction of the handle and any visible child controls.
std::optional< object_ref >	end_invoke (xtd::async_result async) override
	Retrieves the return value of the asynchronous operation represented by the async_result_invoke passed.
bool	equals (const control &value) const noexcept override
bool	focus ()
	Sets input focus to the control.
auto_size_mode	get_auto_size_mode () const
	Gets a value indicating how a control will behave when its auto_size property is enabled.
size_t	get_child_index (intptr child) const
	Retrieves the index of a control within the control collection.
size_t	get_child_index (intptr 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.
virtual void	hide ()
	Conceals the control from the user.
virtual void	invalidate () const
	Invalidates the entire surface of the control and causes the control to be redrawn.
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.
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.
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.
virtual void	invalidate (const drawing::region &region) 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.
virtual void	invalidate (const drawing::region &region, 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.
std::optional< object_ref >	invoke (delegate< void()> method) override
	Executes the specified delegate on the thread that owns the control's underlying window handle.
std::optional< object_ref >	invoke (delegate< void(std::vector< std::any >)> method, const std::vector< std::any > &args) override
	Executes the specified delegate, on the thread that owns the control's underlying window handle, with the specified list of arguments.
std::optional< object_ref >	invoke (delegate< void(std::vector< std::any >)> method, std::any arg) override
	Executes the specified delegate, on the thread that owns the control's underlying window handle, with the specified list of arguments.
void	perform_layout ()
	Forces the control to apply layout logic to all its child controls.
xtd::drawing::point	point_to_client (const xtd::drawing::point &p) const
	Computes the location of the specified screen point into client coordinates.
xtd::drawing::point	point_to_screen (const xtd::drawing::point &p) const
	Computes the location of the specified client point into screen coordinates.
virtual void	refresh () const
	Forces the control to invalidate its client area and immediately redraw itself and any child controls.
void	resume_layout ()
	Resumes usual layout logic.
void	resume_layout (bool perform_layout)
	Resumes usual layout logic, optionally forcing an immediate layout of pending layout requests.
intptr	send_message (intptr hwnd, int32 msg, intptr wparam, intptr lparam) const
	Send a message with specified hwnd, message, wparam and lparam.
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.
void	set_bounds (int32 x, int32 y, int32 width, int32 height)
	Sets the bounds of the control to the specified location and size.
void	set_bounds (int32 x, int32 y, int32 width, int32 height, bounds_specified specified)
	Sets the specified bounds of the control to the specified location and size.
virtual void	show ()
	Displays the control to the user.
void	suspend_layout ()
	Temporarily suspends the layout logic for the control.
xtd::ustring	to_string () const noexcept override
	Returns a string containing the name of the control, if any.
virtual void	update () const
	Causes the control to redraw the invalidated regions within its client area.
virtual xtd::async_result	begin_invoke (delegate< void()> method)=0
	Asynchronously executes the delegate on the thread that created this object.
virtual xtd::async_result	begin_invoke (delegate< void(std::vector< std::any >)> value, const std::vector< std::any > &args)=0
	Asynchronously executes the delegate on the thread that created this object.
virtual std::optional< object_ref >	invoke (delegate< void()> value)=0
	Synchronously executes the delegate on the thread that created this object and marshals the call to the creating thread.
virtual std::optional< object_ref >	invoke (delegate< void(std::vector< std::any >)> method, const std::vector< std::any > &args)=0
	Synchronously executes the delegate on the thread that created this object and marshals the call to the creating thread.
virtual std::optional< object_ref >	invoke (delegate< void(std::vector< std::any >)> method, std::any arg)=0
	Synchronously executes the delegate on the thread that created this object and marshals the call to the creating thread.
control &	operator<< (control &child)
	Add child control.
control &	operator>> (control &child)
	Remove child control.
Public Member Functions inherited from xtd::object
	object ()=default
	Create a new instance of the ultimate base class object.
bool	equals (const object &obj) const noexcept
	Determines whether the specified object is equal to the current object.
virtual size_t	get_hash_code () const noexcept
	Serves as a hash function for a particular type.
virtual type_object	get_type () const noexcept
	Gets the type of the current instance.
template<typename object_t >
std::unique_ptr< object_t >	memberwise_clone () const noexcept
	Creates a shallow copy of the current object.
Public Member Functions inherited from xtd::forms::iwin32_window
Public Member Functions inherited from xtd::iclonable
Public Member Functions inherited from xtd::icomparable< control >
virtual int32	compare_to (const control &obj) const noexcept=0
	Compares the current instance with another object of the same type.
Public Member Functions inherited from xtd::iequatable< control >
virtual bool	equals (const control &) const noexcept=0
	Indicates whether the current object is equal to another object of the same type.
Public Member Functions inherited from xtd::isynchronize_invoke
Static Public Member Functions inherited from xtd::forms::control
static bool	check_for_illegal_cross_thread_calls () noexcept
	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.
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.
static forms::keys	modifier_keys () noexcept
	Gets a value indicating which of the modifier keys (SHIFT, CTRL, and ALT) is in a pressed state.
static forms::mouse_buttons	mouse_buttons () noexcept
	Gets a value indicating which of the mouse buttons is in a pressed state.
static xtd::drawing::point	mouse_position () noexcept
	Gets the position of the mouse cursor in screen coordinates.
static control	create ()
	A factory to create a specified control.
static control	create (const drawing::point &location)
	A factory to create a specified control with specified location.
static control	create (const drawing::point &location, const drawing::size &size)
	A factory to create a specified control with specified location, and size.
static control	create (const drawing::point &location, const drawing::size &size, const xtd::ustring &name)
	A factory to create a specified control with specified location, size, and name.
static control	create (const control &paren)
	A factory to create a specified control with specified parent.
static control	create (const control &parent, const drawing::point &location)
	A factory to create a specified control with specified parent, location, size, and name.
static control	create (const control &parent, const drawing::point &location, const drawing::size &size)
	A factory to create a specified control with specified parent, location, and size.
static control	create (const control &parent, const drawing::point &location, const drawing::size &size, const xtd::ustring &name)
	A factory to create a specified control with specified parent, location, size, and name.
template<typename control_t >
static control_t	create ()
	A factory to create a specified control.
template<typename control_t >
static control_t	create (const drawing::point &location)
	A factory to create a specified control with specified location.
template<typename control_t >
static control_t	create (const drawing::point &location, const drawing::size &size)
	A factory to create a specified control with specified location, and size.
template<typename control_t >
static control_t	create (const drawing::point &location, const drawing::size &size, const xtd::ustring &name)
	A factory to create a specified control with specified location, size, and name.
template<typename control_t >
static control_t	create (const control &parent)
	A factory to create a specified control with specified parent.
template<typename control_t >
static control_t	create (const control &parent, const drawing::point &location)
	A factory to create a specified control with specified parent, and location.
template<typename control_t >
static control_t	create (const control &parent, const drawing::point &location, const drawing::size &size)
	A factory to create a specified control with specified parent, location, and size.
template<typename control_t >
static control_t	create (const control &parent, const drawing::point &location, const drawing::size &size, const xtd::ustring &name)
	A factory to create a specified control with specified parent, location, size, and name.
template<typename control_t >
static control_t	create (const xtd::ustring &text)
	A factory to create a specified control with specified text.
template<typename control_t >
static control_t	create (const xtd::ustring &text, const drawing::point &location)
	A factory to create a specified control with specified text, and location.
template<typename control_t >
static control_t	create (const xtd::ustring &text, const drawing::point &location, const drawing::size &size)
	A factory to create a specified control with specified text, location, and size.
template<typename control_t >
static control_t	create (const xtd::ustring &text, const drawing::point &location, const drawing::size &size, const xtd::ustring &name)
	A factory to create a specified control with specified text, location,size, and name.
template<typename control_t >
static control_t	create (const control &parent, const xtd::ustring &text)
	A factory to create a specified control with specified parent, and text.
template<typename control_t >
static control_t	create (const control &parent, const xtd::ustring &text, const drawing::point &location)
	A factory to create a specified control with specified parent, text, and location.
template<typename control_t >
static control_t	create (const control &parent, const xtd::ustring &text, const drawing::point &location, const drawing::size &size)
	A factory to create a specified control with specified parent, text, location, and size.
template<typename control_t >
static control_t	create (const control &parent, const xtd::ustring &text, const drawing::point &location, const drawing::size &size, const xtd::ustring &name)
	A factory to create a specified control with specified parent, text, location, size, and name.
static std::optional< control_ref >	from_child_handle (intptr handle)
	Retrieves the control that contains the specified handle.
static std::optional< control_ref >	from_handle (intptr handle)
	Returns the control that is currently associated with the specified handle.
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.
static bool	reference_equals (const object &object_a, const object &object_b) noexcept
	Determines whether the specified object instances are the same instance.
Protected Member Functions inherited from xtd::forms::container_control
	container_control ()
	Initializes a new instance of the container_control class.
drawing::size	measure_control () const noexcept override
	Measure this control.
Protected Member Functions inherited from xtd::forms::scrollable_control
	scrollable_control ()
	Initialize a new instance of scrollable_control class.
forms::create_params	create_params () const noexcept override
	Gets the required creation parameters when the control handle is created.
void	on_layout (const event_args &e) override
	Raises the xtd::forms::control::layout event.
Protected Member Functions inherited from xtd::forms::control
xtd::forms::visual_styles::control_state	control_state () const noexcept
	Gets state.
virtual drawing::color	default_back_color () const noexcept
	Gets the default background color of the control.
virtual forms::cursor	default_cursor () const noexcept
	Gets the default cursor for the control.
virtual drawing::font	default_font () const noexcept
	Gets the default font of the control.
virtual drawing::color	default_fore_color () const noexcept
	Gets the default foreground color of the control.
virtual void	create_handle ()
	Creates a handle for the control.
virtual void	destroy_handle ()
	Destroys the handle associated with the control.
virtual void	def_wnd_proc (message &message)
	Sends the specified message to the default window procedure.
bool	get_style (control_styles flag) const noexcept
	Retrieves the value of the specified control style bit for the control.
drawing::size	measure_text () const noexcept
	Measure this control text.
virtual void	on_auto_size_changed (const event_args &e)
	Raises the xtd::forms::control::auto_size_changed event.
virtual void	on_back_color_changed (const event_args &e)
	Raises the xtd::forms::control::back_color_changed event.
virtual void	on_background_image_changed (const event_args &e)
	Raises the xtd::forms::control::background_image_changed event.
virtual void	on_background_image_layout_changed (const event_args &e)
	Raises the xtd::forms::control::background_image_layout_changed event.
virtual void	on_control_appearance_changed (const event_args &e)
	Raises the control::control_appearance_changed event.
virtual void	on_click (const event_args &e)
	Raises the xtd::forms::control::click event.
virtual void	on_client_size_changed (const event_args &e)
	Raises the xtd::forms::control::client_size_changed event.
virtual void	on_control_added (const control_event_args &e)
	Raises the xtd::forms::control::control_added event.
virtual void	on_control_removed (const control_event_args &e)
	Raises the xtd::forms::control::control_removed event.
virtual void	on_create_control ()
	Raises the xtd::forms::control::create_control event.
virtual void	on_cursor_changed (const event_args &e)
	Raises the xtd::forms::control::cursor_changed event.
virtual void	on_destroy_control ()
	Raises the xtd::forms::control::destroy_control event.
virtual void	on_dock_changed (const event_args &e)
	Raises the xtd::forms::control::dock_changed event.
virtual void	on_double_click (const event_args &e)
	Raises the xtd::forms::control::double_click event.
virtual void	on_enabled_changed (const event_args &e)
	Raises the xtd::forms::control::enabled_changed event.
virtual void	on_fore_color_changed (const event_args &e)
	Raises the xtd::forms::control::fore_color_changed event.
virtual void	on_font_changed (const event_args &e)
	Raises the xtd::forms::control::font_changed event.
virtual void	on_got_focus (const event_args &e)
	Raises the xtd::forms::control::got_focus event.
virtual void	on_help_requested (help_event_args &e)
	Raises the xtd::forms::control::help_requested event.
virtual void	on_key_down (key_event_args &e)
	Raises the xtd::forms::control::key_down event.
virtual void	on_key_press (key_press_event_args &e)
	Raises the xtd::forms::control::key_press event.
virtual void	on_key_up (key_event_args &e)
	Raises the xtd::forms::control::key_up event.
virtual void	on_lost_focus (const event_args &e)
	Raises the xtd::forms::control::lost_focus event.
virtual void	on_mouse_click (const mouse_event_args &e)
	Raises the xtd::forms::control::mouse_click event.
virtual void	on_mouse_double_click (const mouse_event_args &e)
	Raises the xtd::forms::control::mouse_double_click event.
virtual void	on_mouse_down (const mouse_event_args &e)
	Raises the xtd::forms::control::mouse_down event.
virtual void	on_mouse_enter (const event_args &e)
	Raises the xtd::forms::control::mouse_enter event.
virtual void	on_mouse_horizontal_wheel (const mouse_event_args &e)
	Raises the xtd::forms::control::mouse_horizontal_wheel event.
virtual void	on_mouse_leave (const event_args &e)
	Raises the xtd::forms::control::mouse_leave event.
virtual void	on_mouse_move (const mouse_event_args &e)
	Raises the xtd::forms::control::mouse_move event.
virtual void	on_mouse_up (const mouse_event_args &e)
	Raises the xtd::forms::control::mouse_up event.
virtual void	on_mouse_wheel (const mouse_event_args &e)
	Raises the xtd::forms::control::mouse_wheel event.
virtual void	on_move (const event_args &e)
	Raises the xtd::forms::control::move event.
virtual void	on_paint_background (paint_event_args &e)
	Paints the background of the xtd::forms::control.
virtual void	on_parent_back_color_changed (const event_args &e)
	Raises the xtd::forms::control::parent_back_color_changed event.
virtual void	on_parent_cursor_changed (const event_args &e)
	Raises the xtd::forms::control::parent_cursor_changed event.
virtual void	on_parent_changed (const event_args &e)
	Raises the xtd::forms::control::parent_changed event.
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..
virtual void	on_parent_fore_color_changed (const event_args &e)
	Raises the xtd::forms::control::parent_fore_color_changed event.
virtual void	on_parent_font_changed (const event_args &e)
	Raises the xtd::forms::control::parent_font_changed event.
virtual void	on_right_to_left_changed (const event_args &e)
	Raises the xtd::forms::control::right_to_left_changed event.
virtual void	on_size_changed (const event_args &e)
	Raises the xtd::forms::control::size_changed event.
virtual void	on_style_sheet_changed (const event_args &e)
	Raises the xtd::forms::control::style_sheet_changed event.
virtual void	on_system_colors_changed (const event_args &e)
	Raises the control::system_colors_changed event.
virtual void	on_tab_stop_changed (const event_args &e)
	Raises the xtd::forms::control::tab_stop_changed event.
virtual void	on_text_changed (const event_args &e)
	Raises the xtd::forms::control::text_changed event.
virtual void	on_visible_changed (const event_args &e)
	Raises the xtd::forms::control::visible_changed event.
void	post_recreate_handle () noexcept
virtual void	recreate_handle ()
	Forces the re-creation of the handle for the control.
virtual void	set_bounds_core (int32 x, int32 y, int32 width, int32 height, bounds_specified specified)
	Performs the work of setting the specified bounds of this control.
void	set_can_focus (bool value)
	Sets a value indicating whether the control can receive focus.
virtual void	set_text (const xtd::ustring &text)
	Sets the text associated with this control.
virtual void	set_client_size_core (int32 width, int32 height)
	Sets the size of the client area of the control.
void	set_parent (intptr handle)
	Sets the parent handle of the control.
void	set_style (control_styles flag, bool value)
	Sets a specified control_styles flag to either true or false.
Protected Member Functions inherited from xtd::forms::component
	component ()
	Initialises a new instance of the component class.
bool	design_mode () const noexcept
	Gets a value that indicates whether the component is currently in design mode.
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.

Member Typedef Documentation

ibutton_control_ref

using xtd::forms::form::ibutton_control_ref = std::reference_wrapper<xtd::forms::ibutton_control>

Represent an xtd::forms::ibutton_control reference.

main_menu_ref

using xtd::forms::form::main_menu_ref = std::reference_wrapper<xtd::forms::main_menu>

Represent an xtd::forms::main_menu reference.

status_bar_ref

using xtd::forms::form::status_bar_ref = std::reference_wrapper<xtd::forms::status_bar>

Represent an xtd::forms::status_bar reference.

tool_bar_ref

using xtd::forms::form::tool_bar_ref = std::reference_wrapper<xtd::forms::tool_bar>

Represent an xtd::forms::tool_bar reference.

Constructor & Destructor Documentation

form()

xtd::forms::form::form

(

)

Initializes a new instance of the Form class.

Remarks

The default size of a form is 300 pixels in height and 300 pixels in width.

Member Function Documentation

accept_button() [1/3]

std::optional< ibutton_control_ref > xtd::forms::form::accept_button ( ) const

noexcept

Gets the button on the form that is clicked when the user presses the ENTER key.

Returns

An ibutton_control that represents the button to use as the accept button for the form.

accept_button() [2/3]

form & xtd::forms::form::accept_button

(

const ibutton_control &

value

)

Sets the button on the form that is clicked when the user presses the ENTER key.

Parameters

value

An ibutton_control that represents the button to use as the accept button for the form.

Returns

Current form.

accept_button() [3/3]

form & xtd::forms::form::accept_button

(

std::nullptr_t

)

Sets the button on the form that is clicked when the user presses the ENTER key.

Parameters

value

An ibutton_control that represents the button to use as the accept button for the form.

Returns

Current form.

activate()

void xtd::forms::form::activate

(

)

Activates the form and gives it focus.

Remarks

Activating a form brings it to the front if this is the active application, or it flashes the window caption if this is not the active application. The form must be visible for this method to have any effect. To determine the active form in an application, use the active_form property or the active_mdi_child property if your forms are in a Multiple-document interface (MDI) application.

active_form()

static std::optional< form_ref > xtd::forms::form::active_form ( )

staticnoexcept

Gets the currently active form for this application.

Returns

A form that represents the currently active form, or std::optional with no value if there is no active form.

auto_size_mode() [1/2]

virtual forms::auto_size_mode xtd::forms::form::auto_size_mode ( ) const

virtualnoexcept

Gets the mode by which the form automatically resizes itself.

Returns

An auto_size_mode enumerated value. The default is grow_only.

Examples

lcd_label2.cpp.

auto_size_mode() [2/2]

virtual form & xtd::forms::form::auto_size_mode ( forms::auto_size_mode  value )

virtual

Sets the mode by which the form automatically resizes itself.

Parameters

value

An auto_size_mode enumerated value. The default is grow_only.

Returns

Current form.

bring_to_front()

void xtd::forms::form::bring_to_front ( )

overridevirtual

Brings the control to the front of the z-order.

Remarks

The control is moved to the front of the z-order. If the control is a child of another control, the child control is moved to the front of the z-order. bring_to_front does not make a control a top-level control, and it does not raise the xtd::forms::control::paint event.

Reimplemented from xtd::forms::control.

cancel_button() [1/3]

std::optional< ibutton_control_ref > xtd::forms::form::cancel_button ( ) const

noexcept

Gets the button control that is clicked when the user presses the ESC key.

Returns

An ibutton_control that represents the cancel button for the form.

cancel_button() [2/3]

form & xtd::forms::form::cancel_button

(

const ibutton_control &

value

)

Gets the button control that is clicked when the user presses the ESC key.

Parameters

value

An ibutton_control that represents the cancel button for the form.

Returns

Current form.

cancel_button() [3/3]

form & xtd::forms::form::cancel_button

(

std::nullptr_t

)

Gets the button control that is clicked when the user presses the ESC key.

Parameters

value

An ibutton_control that represents the cancel button for the form.

Returns

Current form.

center_to_screen()

void xtd::forms::form::center_to_screen

(

)

Centers the position of the form within the bounds of the parent form.

Remarks

Do not call the center_to_screen method directly from your code. Instead, set the start_position property to center_parent.

If the form or dialog is top-level, then center_to_parent centers the form with respect to the screen or desktop.

clone()

std::unique_ptr< xtd::object > xtd::forms::form::clone ( ) const

overrideprotectedvirtual

Creates a new object that is a copy of the current instance.

Returns

A new object that is a copy of this instance.

Notes to Implementers

All controls must be override the clone method.

Reimplemented from xtd::forms::control.

Reimplemented in xtd::forms::trace_form.

close()

void xtd::forms::form::close

(

)

Closes the form.

Remarks

When a form is closed, all resources created within the object are closed and the form is disposed. You can prevent the closing of a form at run time by handling the closing event and setting the cancel property of the cancel_event_args passed as a parameter to your event handler. If the form you are closing is the startup form of your application, your application ends.

Examples

form2.cpp.

close_box() [1/2]

virtual bool xtd::forms::form::close_box ( ) const

virtualnoexcept

Gets a value indicating whether a close box is displayed in the caption bar of the form.

Returns

true if the form displays a close box in the upper-left corner of the form; otherwise, false. The default is true.

close_box() [2/2]

virtual form & xtd::forms::form::close_box ( bool  value )

virtual

Sets a value indicating whether a close box is displayed in the caption bar of the form.

Parameters

value

true if the form displays a close box in the upper-left corner of the form; otherwise, false. The default is true.

Returns

Current form.

control_box() [1/2]

virtual bool xtd::forms::form::control_box ( ) const

virtualnoexcept

Gets a value indicating whether a control box is displayed in the caption bar of the form.

Returns

true if the form displays a control box in the upper-right corner of the form; otherwise, false. The default is true.

control_box() [2/2]

virtual form & xtd::forms::form::control_box ( bool  value )

virtual

Sets a value indicating whether a control box is displayed in the caption bar of the form.

Parameters

value

true if the form displays a control box in the upper-right corner of the form; otherwise, false. The default is true.

Returns

Current form.

create() [1/13]

static form xtd::forms::form::create ( )

static

A factory to create an xtd::forms::form.

Returns

New xtd::forms::form created.

Examples

button4.cpp, and form2.cpp.

create() [2/13]

static form xtd::forms::form::create ( const xtd::ustring &  text )

static

A factory to create an xtd::forms::form with specified text.

Parameters

text	A string that represent text of the xtd::forms::form.

Returns

New xtd::forms::form created.

create() [3/13]

static form xtd::forms::form::create ( const xtd::ustring &  text, const drawing::point &  location  )

static

A factory to create an xtd::forms::form with specified text, and location.

Parameters

text	A string that represent text of the xtd::forms::form.
location	A xtd::drawing::point that represent location of the xtd::forms::form.

Returns

New xtd::forms::form created.

create() [4/13]

static form xtd::forms::form::create ( const xtd::ustring &  text, const drawing::point &  location, const drawing::size &  size  )

static

A factory to create an xtd::forms::form with specified text, location, and size.

Parameters

text	A string that represent text of the xtd::forms::form.
location	A xtd::drawing::point that represent location of the xtd::forms::form.
size	A xtd::drawing::size that represent size of the xtd::forms::form.

Returns

New xtd::forms::form created.

create() [5/13]

static form xtd::forms::form::create ( const xtd::ustring &  text, const drawing::point &  location, const drawing::size &  size, const xtd::ustring &  name  )

static

A factory to create an xtd::forms::form with specified text, location, size, and name.

Parameters

text	A string that represent text of the xtd::forms::form.
location	A xtd::drawing::point that represent location of the xtd::forms::form.
size	A xtd::drawing::size that represent size of the xtd::forms::form.
name	The name of the xtd::forms::form.

Returns

New xtd::forms::form created.

create() [6/13]

static form xtd::forms::form::create ( const xtd::ustring &  text, const drawing::size &  size  )

static

A factory to create an xtd::forms::form with specified text, and size.

Parameters

text	A string that represent text of the xtd::forms::form.
size	A xtd::drawing::size that represent size of the xtd::forms::form.

Returns

New xtd::forms::form created.

create() [7/13]

static form xtd::forms::form::create ( const xtd::ustring &  text, const drawing::size &  size, const xtd::ustring &  name  )

static

A factory to create an xtd::forms::form with specified text, size, and name.

Parameters

text	A string that represent text of the xtd::forms::form.
size	A xtd::drawing::size that represent size of the xtd::forms::form.
name	The name of the xtd::forms::form.

Returns

New xtd::forms::form created.

create() [8/13]

static form xtd::forms::form::create ( const xtd::ustring &  text, form_start_position  start_position  )

static

A factory to create an xtd::forms::form with specified text, and form start position.

Parameters

text	A string that represent text of the xtd::forms::form.
start_position	A form_start_position that represents the starting position of the form.

Returns

New xtd::forms::form created.

create() [9/13]

static form xtd::forms::form::create ( const xtd::ustring &  text, form_start_position  start_position, const drawing::point &  location  )

static

A factory to create an xtd::forms::form with specified text, form start position, and location.

Parameters

text	A string that represent text of the xtd::forms::form.
start_position	A form_start_position that represents the starting position of the form.
location	A xtd::drawing::point that represent location of the xtd::forms::form.

Returns

New xtd::forms::form created.

create() [10/13]

static form xtd::forms::form::create ( const xtd::ustring &  text, form_start_position  start_position, const drawing::point &  location, const drawing::size &  size  )

static

A factory to create an xtd::forms::form with specified text, form start position, location, and size.

Parameters

text	A string that represent text of the xtd::forms::form.
start_position	A form_start_position that represents the starting position of the form.
location	A xtd::drawing::point that represent location of the xtd::forms::form.
size	A xtd::drawing::size that represent size of the xtd::forms::form.

Returns

New xtd::forms::form created.

create() [11/13]

static form xtd::forms::form::create ( const xtd::ustring &  text, form_start_position  start_position, const drawing::point &  location, const drawing::size &  size, const xtd::ustring &  name  )

static

A factory to create an xtd::forms::form with specified text, form start position, location, size, and name.

Parameters

text	A string that represent text of the xtd::forms::form.
start_position	A form_start_position that represents the starting position of the form.
location	A xtd::drawing::point that represent location of the xtd::forms::form.
size	A xtd::drawing::size that represent size of the xtd::forms::form.
name	The name of the xtd::forms::form.

Returns

New xtd::forms::form created.

create() [12/13]

static form xtd::forms::form::create ( const xtd::ustring &  text, form_start_position  start_position, const drawing::size &  size  )

static

A factory to create an xtd::forms::form with specified text, form start position, and size.

Parameters

text	A string that represent text of the xtd::forms::form.
start_position	A form_start_position that represents the starting position of the form.
size	A xtd::drawing::size that represent size of the xtd::forms::form.

Returns

New xtd::forms::form created.

create() [13/13]

static form xtd::forms::form::create ( const xtd::ustring &  text, form_start_position  start_position, const drawing::size &  size, const xtd::ustring &  name  )

static

A factory to create an xtd::forms::form with specified text, form start position, size, and name.

Parameters

text	A string that represent text of the xtd::forms::form.
start_position	A form_start_position that represents the starting position of the form.
size	A xtd::drawing::size that represent size of the xtd::forms::form.
name	The name of the xtd::forms::form.

Returns

New xtd::forms::form created.

create_params()

forms::create_params xtd::forms::form::create_params ( ) const

overrideprotectedvirtualnoexcept

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_size()

drawing::size xtd::forms::form::default_size ( ) const

overrideprotectedvirtualnoexcept

Gets the default size of the control.

Returns

The default size of the control.

Reimplemented from xtd::forms::control.

dialog_result() [1/2]

virtual forms::dialog_result xtd::forms::form::dialog_result ( ) const

virtualnoexcept

Gets the dialog result for the form.

Returns

A dialog_result that represents the result of the form when used as a dialog box.

dialog_result() [2/2]

virtual form & xtd::forms::form::dialog_result ( forms::dialog_result  value )

virtual

Sets the dialog result for the form.

Parameters

value

A dialog_result that represents the result of the form when used as a dialog box.

Returns

Current form.

form_border_style() [1/2]

virtual forms::form_border_style xtd::forms::form::form_border_style ( ) const

virtualnoexcept

Gets the border style of the form.

Returns

A form_border_style that represents the style of border to display for the form. The default is form_border_style::sizable.

form_border_style() [2/2]

virtual form & xtd::forms::form::form_border_style ( forms::form_border_style  value )

virtual

Gets the border style of the form.

Parameters

value

A form_border_style that represents the style of border to display for the form. The default is form_border_style::sizable.

Returns

Current form.

help_button() [1/2]

virtual bool xtd::forms::form::help_button ( ) const

virtual

Gets a value indicating whether a Help button should be displayed in the caption box of the form.

Returns

true to display a Help button in the form's caption bar; otherwise, false. The default is false.

help_button() [2/2]

virtual form & xtd::forms::form::help_button ( bool  value )

virtual

Sets a value indicating whether a Help button should be displayed in the caption box of the form.

Parameters

value

true to display a Help button in the form's caption bar; otherwise, false. The default is false.

Returns

Current form.

icon() [1/2]

virtual const xtd::drawing::icon & xtd::forms::form::icon ( ) const

virtualnoexcept

Gets the icon for the form.

Returns

An icon that represents the icon for the form.

icon() [2/2]

virtual form & xtd::forms::form::icon ( const xtd::drawing::icon &  value )

virtual

Sets the icon for the form.

Parameters

value

An icon that represents the icon for the form.

Returns

Current form.

maximize_box() [1/2]

virtual bool xtd::forms::form::maximize_box ( ) const

virtualnoexcept

Gets a value indicating whether the Maximize button is displayed in the caption bar of the form.

Returns

true to display a Maximize button for the form; otherwise, false. The default is true.

maximize_box() [2/2]

virtual form & xtd::forms::form::maximize_box ( bool  value )

virtual

Sets a value indicating whether the Maximize button is displayed in the caption bar of the form.

Parameters

value

true to display a Maximize button for the form; otherwise, false. The default is true.

Returns

Current form.

menu() [1/3]

virtual std::optional< main_menu_ref > xtd::forms::form::menu ( ) const

virtualnoexcept

Gets the main_menu that is displayed in the form.

Returns

A main_menu that represents the menu to display in the form.

menu() [2/3]

virtual form & xtd::forms::form::menu ( const forms::main_menu &  value )

virtual

Sets the main_menu that is displayed in the form.

Parameters

value

A main_menu that represents the menu to display in the form.

Returns

Current form.

menu() [3/3]

virtual form & xtd::forms::form::menu ( std::nullptr_t  )

virtual

Sets the main_menu that is displayed in the form.

Parameters

value

A main_menu that represents the menu to display in the form.

Returns

Current form.

minimize_box() [1/2]

virtual bool xtd::forms::form::minimize_box ( ) const

virtualnoexcept

Gets a value indicating whether the Minimize button is displayed in the caption bar of the form.

Returns

true to display a Minimize button for the form; otherwise, false. The default is true.

minimize_box() [2/2]

virtual form & xtd::forms::form::minimize_box ( bool  value )

virtual

Sets a value indicating whether the Minimize button is displayed in the caption bar of the form.

Parameters

value

true to display a Minimize button for the form; otherwise, false. The default is true.

Returns

Current form.

modal()

bool xtd::forms::form::modal ( ) const

noexcept

Gets a value indicating whether this form is displayed modally.

Returns

true if the form is displayed modally; otherwise, false.

on_activated()

virtual void xtd::forms::form::on_activated ( const event_args &  e )

protectedvirtual

Raises the form::activated event.

Parameters

e	An event_args that contains the event data.

on_deactivate()

virtual void xtd::forms::form::on_deactivate ( const event_args &  e )

protectedvirtual

Raises the form::deactivate event.

Parameters

e	An event_args that contains the event data.

on_form_closed()

virtual void xtd::forms::form::on_form_closed ( const form_closed_event_args &  e )

protectedvirtual

Raises the form::form_closed event.

Parameters

e	A form_closed_event_args that contains the event data.

on_form_closing()

virtual void xtd::forms::form::on_form_closing ( form_closing_event_args &  e )

protectedvirtual

Raises the form::form_closing event.

Parameters

e	A form_closing_event_args that contains the event data.

on_handle_created()

void xtd::forms::form::on_handle_created ( const event_args &  e )

overrideprotectedvirtual

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

Parameters

e	An xtd::event_args that contains the event data.

Reimplemented from xtd::forms::control.

on_handle_destroyed()

void xtd::forms::form::on_handle_destroyed ( const event_args &  e )

overrideprotectedvirtual

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

Parameters

e	An xtd::event_args that contains the event data.

Reimplemented from xtd::forms::control.

on_layout()

void xtd::forms::form::on_layout ( const event_args &  e )

overrideprotectedvirtual

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

Parameters

e	An xtd::event_args that contains the event data.

Reimplemented from xtd::forms::control.

on_location_changed()

void xtd::forms::form::on_location_changed ( const event_args &  e )

overrideprotectedvirtual

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

Parameters

e	An xtd::event_args that contains the event data.

Reimplemented from xtd::forms::control.

on_paint()

void xtd::forms::form::on_paint ( paint_event_args &  e )

overrideprotectedvirtual

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

Parameters

e	An xtd::event_args that contains the event data.

Reimplemented from xtd::forms::control.

on_region_changed()

void xtd::forms::form::on_region_changed ( const event_args &  e )

overrideprotectedvirtual

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

Parameters

e	An xtd::event_args that contains the event data.

Reimplemented from xtd::forms::control.

on_resize()

void xtd::forms::form::on_resize ( const event_args &  e )

overrideprotectedvirtual

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

Parameters

e	An xtd::event_args that contains the event data.

Reimplemented from xtd::forms::control.

opacity() [1/2]

virtual double xtd::forms::form::opacity ( ) const

virtualnoexcept

Gets form opacity.

Returns

A double-precision value between 0.0 and 1.0 that represent the form opacity.

opacity() [2/2]

virtual form & xtd::forms::form::opacity ( double  opacity )

virtual

Sets form opacity.

Parameters

opacity

A double-precision value between 0.0 and 1.0 that represent the form opacity.

owner() [1/3]

virtual std::optional< control_ref > xtd::forms::form::owner ( ) const

virtualnoexcept

Gets the form that owns this form.

Returns

A form that represents the form that is the owner of this form.

owner() [2/3]

virtual form & xtd::forms::form::owner ( const control &  value )

virtual

Sets the form that owns this form.

Parameters

value

A form that represents the form that is the owner of this form.

Returns

Current form.

owner() [3/3]

virtual form & xtd::forms::form::owner ( std::nullptr_t  )

virtual

Resets the form that owns this form.

Parameters

nullptr

Returns

Current form.

parent()

control & xtd::forms::form::parent ( const control &  value )

overridevirtual

Sets the parent container of the control.

Parameters

parent

A control that represents the parent or container control of the control or nullptr for none.

Reimplemented from xtd::forms::control.

Examples

debug_message_box.cpp, forms_timer.cpp, and trace_message_box.cpp.

pre_process_message()

bool xtd::forms::form::pre_process_message ( const xtd::forms::message &  message )

overridevirtual

Preprocesses keyboard or input messages within the message loop before they are dispatched.

Parameters

message

A xtd::forms::message, passed by reference, that represents the message to process. The possible values are WM_KEYDOWN, WM_SYSKEYDOWN, WM_CHAR, and WM_SYSCHAR.

Returns

true if the message was processed by the control; otherwise, false.

Remarks

pre_process_message is called by the application's message loop to preprocess input messages before they are dispatched. Possible values for the msg parameter are WM_KEYDOWN, WM_SYSKEYDOWN, WM_CHAR, and WM_SYSCHAR.

Reimplemented from xtd::forms::control.

show_dialog() [1/2]

virtual forms::dialog_result xtd::forms::form::show_dialog ( )

virtual

Shows the form as a modal dialog box.

Returns

One of the dialog_result values.

Examples

application_events.cpp.

show_dialog() [2/2]

virtual forms::dialog_result xtd::forms::form::show_dialog ( const iwin32_window &  owner )

virtual

Shows the form as a modal dialog box with the specified owner. @parm owner Any object that implements iwin32_window that represents the top-level window that will own the modal dialog box.

Returns

One of the dialog_result values.

show_icon() [1/2]

virtual bool xtd::forms::form::show_icon ( ) const

virtualnoexcept

Gets a value indicating whether an icon is displayed in the caption bar of the form.

Returns

true if the form displays an icon in the caption bar; otherwise, false. The default is true.

show_icon() [2/2]

virtual form & xtd::forms::form::show_icon ( bool  value )

virtual

Sets a value indicating whether an icon is displayed in the caption bar of the form.

Parameters

value

true if the form displays an icon in the caption bar; otherwise, false. The default is true.

Returns

Current form.

show_in_taskbar() [1/2]

virtual bool xtd::forms::form::show_in_taskbar ( ) const

virtualnoexcept

Gets a value indicating whether the form is displayed in the Windows taskbar.

Returns

true to display the form in the Windows taskbar at run time; otherwise, false. The default is true.

Remarks

If a form is parented within another form, the parented form is not displayed in the Windows taskbar.

You can use this property to prevent users from selecting your form through the Windows taskbar. For example, if you display a Find and Replace tool window in your application, you might want to prevent that window from being selected through the Windows taskbar because you would need both the application's main window and the Find and Replace tool window displayed in order to process searches appropriately.

You will often wish to use this property when creating a form with the xtd::forms::form_border_style::fixed_tool_window style. Setting the xtd::forms::form_border_style::fixed_tool_window style does not alone guarantee that a window will not appear in the taskbar.

show_in_taskbar() [2/2]

virtual form & xtd::forms::form::show_in_taskbar ( bool  value )

virtual

Sets a value indicating whether the form is displayed in the Windows taskbar.

Parameters

value

true to display the form in the Windows taskbar at run time; otherwise, false. The default is true.

Returns

Current form.

Remarks

If a form is parented within another form, the parented form is not displayed in the Windows taskbar.

You can use this property to prevent users from selecting your form through the Windows taskbar. For example, if you display a Find and Replace tool window in your application, you might want to prevent that window from being selected through the Windows taskbar because you would need both the application's main window and the Find and Replace tool window displayed in order to process searches appropriately.

You will often wish to use this property when creating a form with the xtd::forms::form_border_style::fixed_tool_window style. Setting the xtd::forms::form_border_style::fixed_tool_window style does not alone guarantee that a window will not appear in the taskbar.

show_sheet()

virtual void xtd::forms::form::show_sheet ( const iwin32_window &  owner )

virtual

Shows the form as a sheet dialog box.

Remarks

dialog_result property contains the result when the form will closed.

Sheet mode is only available on macOS. For other platform show_dialog is underlying called.

show_sheet_dialog()

virtual forms::dialog_result xtd::forms::form::show_sheet_dialog ( const iwin32_window &  owner )

virtual

Shows the form as a modal sheet dialog box.

Returns

One of the dialog_result values.

Remarks

Sheet mode is only available on macOS. For other platform show_dialog is underlying called.

start_position() [1/2]

virtual form_start_position xtd::forms::form::start_position ( ) const

virtualnoexcept

Gets the starting position of the form at run time.

Returns

A form_start_position that represents the starting position of the form.

Examples

lcd_label2.cpp, and screen.cpp.

start_position() [2/2]

virtual form & xtd::forms::form::start_position ( form_start_position  value )

virtual

Sets the starting position of the form at run time.

Parameters

value

A form_start_position that represents the starting position of the form.

Returns

Current form.

status_bar() [1/3]

virtual std::optional< status_bar_ref > xtd::forms::form::status_bar ( ) const

virtualnoexcept

Gets the status_bar that is displayed in the form.

Returns

A status_bar that represents the status bar to display in the form.

status_bar() [2/3]

virtual form & xtd::forms::form::status_bar ( const forms::status_bar &  value )

virtual

Sets the status_bar that is displayed in the form.

Parameters

value

A status_bar that represents the status bar to display in the form.

Returns

Current form.

status_bar() [3/3]

virtual form & xtd::forms::form::status_bar ( std::nullptr_t  )

virtual

Resets the status_bar that is displayed in the form.

Parameters

value

A status_bar that represents the status bar to display in the form.

Returns

Current form.

tool_bar() [1/3]

virtual std::optional< tool_bar_ref > xtd::forms::form::tool_bar ( ) const

virtualnoexcept

Gets the tool_bar that is displayed in the form.

Returns

A tool_bar that represents the tool bar to display in the form.

tool_bar() [2/3]

virtual form & xtd::forms::form::tool_bar ( const forms::tool_bar &  value )

virtual

Sets the tool_bar that is displayed in the form.

Parameters

value

A tool_bar that represents the tool bar to display in the form.

Returns

Current form.

tool_bar() [3/3]

virtual form & xtd::forms::form::tool_bar ( std::nullptr_t  )

virtual

Resets the tool_bar that is displayed in the form.

Parameters

value

A tool_bar that represents the tool bar to display in the form.

Returns

Current form.

top_level() [1/2]

virtual bool xtd::forms::form::top_level ( ) const

virtualnoexcept

Gets a value indicating whether to display the form as a top-level window.

Returns

true to display the form as a top-level window; otherwise, false. The default is true.

Remarks

A Multiple-document interface (MDI) parent form must be a top-level window. So set to false has no effect.

A top-level form is a window that has no parent form, or whose parent form is the desktop window. Top-level windows are typically used as the main form in an application.

top_level() [2/2]

virtual form & xtd::forms::form::top_level ( bool  top_level )

virtual

Sets a value indicating whether to display the form as a top-level window.

Returns

true to display the form as a top-level window; otherwise, false. The default is true.

Remarks

A Multiple-document interface (MDI) parent form must be a top-level window. So set to false has no effect.

A top-level form is a window that has no parent form, or whose parent form is the desktop window. Top-level windows are typically used as the main form in an application.

top_most() [1/2]

virtual bool xtd::forms::form::top_most ( ) const

virtualnoexcept

Gets a value indicating whether the form should be displayed as a topmost form.

Returns

true to display the form as a topmost form; otherwise, false. The default is false.

top_most() [2/2]

virtual form & xtd::forms::form::top_most ( bool  value )

virtual

Sets a value indicating whether the form should be displayed as a topmost form.

Parameters

value

true to display the form as a topmost form; otherwise, false. The default is false.

Returns

Current form.

visible()

control & xtd::forms::form::visible ( bool  visible )

overridevirtual

Sets a value indicating whether the control and all its child controls are displayed.

Parameters

visible

true if the control and all its child controls are displayed; otherwise, false. The default is true.

Returns

Current control.

Reimplemented from xtd::forms::control.

Examples

screen.cpp.

window_state() [1/2]

virtual form_window_state xtd::forms::form::window_state ( ) const

virtualnoexcept

Gets a value that indicates whether form is minimized, maximized, or normal.

Returns

A form_window_state that represents whether form is minimized, maximized, full_screen, or normal. The default is form_window_state::normal.

window_state() [2/2]

virtual form & xtd::forms::form::window_state ( form_window_state  value )

virtual

Sets a value that indicates whether form is minimized, maximized, or normal.

Parameters

value

A form_window_state that represents whether form is minimized, maximized, full_screen, or normal. The default is form_window_state::normal.

Returns

Current form.

wnd_proc()

void xtd::forms::form::wnd_proc ( message &  m )

overrideprotectedvirtual

Processes Windows messages.

Parameters

m	The 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.

Member Data Documentation

activated

event<form, event_handler> xtd::forms::form::activated

Occurs when the form is activated in code or by the user.

Remarks

For more information about handling events, see Handling and Raising Events.

deactivate

event<form, event_handler> xtd::forms::form::deactivate

Occurs when the form loses focus and is no longer the active form.

Remarks

For more information about handling events, see Handling and Raising Events.

form_closed

event<form, form_closed_event_handler> xtd::forms::form::form_closed

Occurs after the form is closed.

Remarks

For more information about handling events, see Handling and Raising Events.

form_closing

event<form, form_closing_event_handler> xtd::forms::form::form_closing

Occurs before the form is closed.

Remarks

For more information about handling events, see Handling and Raising Events.

---

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

• xtd.forms/include/xtd/forms/form.h