xtd::forms::form Class Reference

#include <form.h>

Definition

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

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.

Examples

The following code example demonstrate the use of form control.

#include <xtd/xtd>
 
using namespace std;
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;
};
 
int main() {
  application::run(form1());
}

Examples

about_box.cpp, about_dialog.cpp, about_dialog_system.cpp, application.cpp, application_and_exception.cpp, application_context.cpp, bitmap_button.cpp, busy_box.cpp, busy_dialog.cpp, button.cpp, check_box.cpp, checked_list_box.cpp, choice.cpp, collapsible_panel.cpp, color_box.cpp, color_dialog.cpp, color_picker.cpp, colored_tab_pages.cpp, combo_box.cpp, command_link_button.cpp, control.cpp, countries.cpp, cursors.cpp, date_time_picker.cpp, debug_form.cpp, dot_matrix_display.cpp, enable_debug.cpp, exception_box.cpp, exception_dialog.cpp, fill_rectangle.cpp, folder_browser_dialog.cpp, font_dialog.cpp, font_picker.cpp, form.cpp, fourteen_segment_display.cpp, group_box.cpp, group_box_and_check_box.cpp, group_box_and_radio_button.cpp, hello_world_label.cpp, image_list.cpp, input_box.cpp, input_dialog.cpp, input_dialog_multiline.cpp, input_dialog_password.cpp, label.cpp, lcd_label.cpp, lcd_label2.cpp, list_box.cpp, main_menu.cpp, main_menu_create_standard_items.cpp, message_box.cpp, message_dialog.cpp, nine_segment_display.cpp, numeric_up_down.cpp, open_file_dialog.cpp, panel.cpp, picture_box.cpp, progress_bar.cpp, progress_dialog.cpp, radio_button.cpp, save_file_dialog.cpp, screen.cpp, seven_segment_display.cpp, sixteen_segment_display.cpp, split_container.cpp, splitter.cpp, switch_button.cpp, tab_control.cpp, text_box.cpp, texts.cpp, timer.cpp, toggle_button.cpp, trace_form.cpp, track_bar.cpp, up_down_button.cpp, use_wait_cursor.cpp, and user_control.cpp.

Inherits xtd::forms::container_control.

Inherited by xtd::forms::trace_form_base.

Public Attributes
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 Attributes inherited from xtd::forms::control
event< control, event_handler >	auto_size_changed
	Occurs when the value of the auto_size property changes.
event< control, event_handler >	back_color_changed
	Occurs when the value of the back_color property changes.
event< control, event_handler >	background_image_changed
	Occurs when the value of the background_image property changes.
event< control, event_handler >	background_image_layout_changed
	Occurs when the value of the background_image_layout property changes.
event< control, event_handler >	click
	Occurs when the control is clicked.
event< control, event_handler >	client_size_changed
	Occurs when the value of the client_size property changes.
event< control, control_event_handler >	control_added
	Occurs when a new control is added to the control::control_collection.
event< control, control_event_handler >	control_removed
	Occurs when a new control is removed to the control::control_collection.
event< control, event_handler >	cursor_changed
	Occurs when the value of the cursor property changes.
event< control, event_handler >	dock_changed
	Occurs when the value of the dock property changes.
event< control, event_handler >	double_click
	Occurs when the control is double-clicked.
event< control, event_handler >	enabled_changed
	Occurs when the value of the enabled property changes.
event< control, event_handler >	font_changed
	Occurs when the value of the font property changes.
event< control, event_handler >	fore_color_changed
	Occurs when the value of the fore_color property changes.
event< control, event_handler >	got_focus
	Occurs when the control receives focus.
event< control, event_handler >	handle_created
	Occurs when a handle is created for the control.
event< control, event_handler >	handle_destroyed
	Occurs when the control's handle is in the process of being destroyed.
event< control, key_event_handler >	key_down
	Occurs when a key is pressed while the control has focus.
event< control, key_press_event_handler >	key_press
	Occurs when a character. space or backspace key is pressed while the control has focus.
event< control, key_event_handler >	key_up
	Occurs when a key is released while the control has focus.
event< control, event_handler >	layout
	Occurs when a control should reposition its child controls.
event< control, event_handler >	location_changed
	Occurs when the value of the location property changes.
event< control, event_handler >	lost_focus
	Occurs when the control loses focus.
event< control, mouse_event_handler >	mouse_click
	Occurs when the control is clicked by the mouse.
event< control, mouse_event_handler >	mouse_double_click
	Occurs when the control is double clicked by the mouse.
event< control, mouse_event_handler >	mouse_down
	Occurs when the mouse pointer is over the control and a mouse button is pressed.
event< control, event_handler >	mouse_enter
	Occurs when the mouse pointer enters the control.
event< control, mouse_event_handler >	mouse_horizontal_wheel
	Occurs when the mouse horizontal wheel moves while the control has focus.
event< control, event_handler >	mouse_leave
	Occurs when the mouse pointer leaves the control.
event< control, mouse_event_handler >	mouse_move
	Occurs when the mouse pointer is moved over the control.
event< control, mouse_event_handler >	mouse_up
	Occurs when the mouse pointer is over the control and a mouse button is released.
event< control, mouse_event_handler >	mouse_wheel
	Occurs when the mouse wheel moves while the control has focus.
event< control, paint_event_handler >	paint
	Occurs when the control is redrawn.
event< control, event_handler >	parent_changed
	Occurs when the value of the parent property changes.
event< control, event_handler >	resize
	Occurs when the control is resized.
event< control, event_handler >	size_changed
	Occurs when the value of the size property changes.
event< control, event_handler >	text_changed
	Occurs when the value of the text property changes.
event< control, event_handler >	visible_changed
	Occurs when the value of the visible property changes.

Public Member Functions
	form ()
	Initializes a new instance of the Form class.
std::optional< std::reference_wrapper< ibutton_control > >	accept_button () const
	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 (nullptr_t)
	Sets the button on the form that is clicked when the user presses the ENTER key.
void	activate ()
	Activates the form and gives it focus.
virtual forms::auto_size_mode	auto_size_mode () const
	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.
void	bring_to_front () override
	Brings the control to the front of the z-order.
std::optional< std::reference_wrapper< ibutton_control > >	cancel_button () const
	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 (nullptr_t)
	Gets the button control that is clicked when the user presses the ESC key.
void	center_to_screen ()
	Centers the position of the form within the bounds of the parent form.
void	close ()
	Closes the form.
virtual bool	close_box () const
	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
	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.
drawing::size	default_size () const override
	Gets the default size of the control.
virtual forms::dialog_result	dialog_result () const
	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
	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
	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
	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< forms::main_menu >	menu () const
	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 (nullptr_t)
	Sets the main_menu that is displayed in the form.
virtual bool	minimize_box () const
	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
	Gets a value indicating whether this form is displayed modally.
virtual double	opacity () const
	Gets form opacity.
virtual form &	opacity (double opacity)
	Sets form opacity.
virtual std::optional< control_ref >	owner () const
	Gets the form that owns this form.
virtual form &	owner (const control &value)
	Sets the form that owns this form.
control &	parent (const control &value) override
	Sets the parent container of the control.
bool	pre_process_message (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 bool	show_icon () const
	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 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.
virtual form_start_position	start_position () const
	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 bool	top_level () const
	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
	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
	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 Member Functions inherited from xtd::forms::container_control
std::optional< control_ref >	active_control () const
	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
	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
	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 override
	Gets the rectangle that represents the virtual display area of the control.
virtual bool	h_scroll () const
	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
	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 control class with default settings.
	control (const control &parent, const xtd::ustring &text)
	Initializes a new instance of the control class as a child control, with specific text.
	control (const control &parent, const xtd::ustring &text, int32_t left, int32_t top, int32_t width, int32_t height)
	Initializes a new instance of the control class as a child control, with specific text, size, and location.
	control (const xtd::ustring &text)
	Initializes a new instance of the control class with specific text.
	control (const xtd::ustring &text, int32_t left, int32_t top, int32_t width, int32_t height)
	Initializes a new instance of the control class with specific text, size, and location.
virtual anchor_styles	anchor () const
	Gets the edges of the container to which a control is bound and determines how a control is resized with its parent.
virtual control &	anchor (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
	Gets where this control is scrolled to in scroll_control_into_view(control).
virtual bool	auto_size () const
	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
	Gets the background color for the control.
virtual control &	back_color (const drawing::color &color)
	Sets the background color for the control.
virtual const xtd::drawing::image &	background_image () const
	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
	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.
std::shared_ptr< xtd::iasync_result >	begin_invoke (delegate< void()> value)
	Executes the specified delegate asynchronously on the thread that the control's underlying handle was created on.
std::shared_ptr< xtd::iasync_result >	begin_invoke (delegate< void(std::vector< std::any >)> value, const std::vector< std::any > &args)
	Executes the specified delegate asynchronously with the specified arguments, on the thread that the control's underlying handle was created on.
virtual int32_t	bottom () const
	Gets the distance, in pixels, between the bottom edge of the control and the top edge of its container's client area.
virtual drawing::rectangle	bounds () const
	Gets the size and location of the control including its nonclient elements, in pixels, relative to the parent control.
virtual control &	bounds (const drawing::rectangle &bounds)
	Sets the size and location of the control including its nonclient elements, in pixels, relative to the parent control.
virtual void	bring_to_front ()
	Brings the control to the front of the z-order.
virtual bool	can_focus () const
	Gets a value indicating whether the control can receive focus.
bool	can_raise_events () const override
	Determines if events can be raised on the control.
virtual bool	can_select () const
	Gets a value indicating whether the control can be selected.
virtual const drawing::rectangle &	client_rectangle () const
	Gets the rectangle that represents the client area of the control.
virtual const drawing::size &	client_size () const
	Gets the height and width of the client area of the control.
virtual control &	client_size (const drawing::size &client_size)
	Sets the height and width of the client area of the control.
virtual xtd::ustring	company_name () const
	Gets the name of the company or creator of the application containing the control.
virtual control_collection &	controls ()
	Gets the collection of controls contained within the control.
virtual const control_collection &	controls () const
	Gets the collection of controls contained within the control.
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	create_handle ()
	Creates a handle for the control.
virtual bool	created ()
	Gets a value indicating whether the control has been created.
virtual forms::cursor	cursor () const
	Gets the cursor that is displayed when the mouse pointer is over the control.
virtual control &	cursor (const forms::cursor &cursor)
	Sets the cursor that is displayed when the mouse pointer is over the control.
virtual drawing::color	default_back_color () const
	Gets the default background color of the control.
virtual forms::cursor	default_cursor () const
	Gets the default cursor for the control.
virtual drawing::font	default_font () const
	Gets the default font of the control.
virtual drawing::color	default_fore_color () const
	Gets the default foreground color of the control.
virtual drawing::size	default_size () const
	Gets the default size of the control.
virtual void	destroy_control ()
	Forces the destruction of the visible control, including the destruction of the handle and any visible child controls.
virtual void	destroy_handle ()
	Destroys the handle associated with the control.
virtual drawing::rectangle	display_rectangle () const
	Gets the rectangle that represents the display area of the control.
virtual dock_style	dock () const
	Gets or sets which control borders are docked to its parent control and determines how a control is resized with its parent.
virtual control &	dock (dock_style dock)
	Sets or 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
	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
	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.
void	end_invoke (std::shared_ptr< xtd::iasync_result > async)
	Retrieves the return value of the asynchronous operation represented by the async_result_invoke passed.
bool	focus ()
	Sets input focus to the control.
virtual bool	focused () const
	Gets a value indicating whether the control has input focus.
virtual drawing::font	font () const
	Gets the font of the text displayed by the control.
virtual control &	font (const drawing::font &font)
	Sets the font of the text displayed by the control.
virtual drawing::color	fore_color () const
	Gets the foreground color of the control.
virtual control &	fore_color (const drawing::color &color)
	Sets the foreground color of the control.
size_t	get_child_index (intptr_t child) const
	Retrieves the index of a control within the control collection.
size_t	get_child_index (intptr_t child, bool &throw_exception) const
	Retrieves the index of the specified child control within the control collection, and optionally raises an exception if the specified control is not within the control collection.
intptr_t	handle () const override
	Gets the window handle that the control is bound to.
virtual int32_t	height () const
	Gets the height of the control.
virtual control &	height (int32_t height)
	Sets the height of the control.
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.
void	invoke (delegate< void()> value)
	Executes the specified delegate on the thread that owns the control's underlying window handle.
void	invoke (delegate< void(std::vector< std::any >)> value, const std::vector< std::any > &args)
	Executes the specified delegate, on the thread that owns the control's underlying window handle, with the specified list of arguments.
bool	is_handle_created () const
	Gets a value indicating whether the control has a handle associated with it.
virtual int32_t	left () const
	Gets the distance, in pixels, between the left edge of the control and the left edge of its container's client area.
virtual control &	left (int32_t left)
	Sets the distance, in pixels, between the left edge of the control and the left edge of its container's client area.
virtual drawing::point	location () const
	Gets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container.
virtual control &	location (const 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
	Gets the space between controls.
virtual control &	margin (const forms::padding &margin)
	Sets the space between controls.
virtual const drawing::size &	maximum_size () const
	Gets the size that is the upper limit that xtd::forms::control::get_preferred_size can specify.
virtual control &	maximum_size (const 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_size () const
	Gets the size that is the lower limit that xtd::forms::control::get_preferred_size can specify.
virtual control &	minimum_size (const drawing::size &size)
	Sets the size that is the lower limit that xtd::forms::control::get_preferred_size can specify.
virtual const xtd::ustring &	name () const
	Gets the name of the control.
virtual control &	name (const xtd::ustring &name)
	Sets the name of the control.
virtual forms::padding	padding () const
	Gets padding within the control.
virtual control &	padding (const forms::padding &padding)
	Sets padding within the control.
virtual std::optional< control_ref >	parent () const
	Gets the parent container of the control.
virtual control &	parent (const control &parent)
	Sets the parent container of the control.
virtual control &	parent (std::nullptr_t)
	Resets the parent container of the control.
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)
	Computes the location of the specified screen point into client coordinates.
xtd::drawing::point	point_to_screen (const xtd::drawing::point &p)
	Computes the location of the specified client point into screen coordinates.
virtual bool	pre_process_message (xtd::forms::message &message)
	Preprocesses keyboard or input messages within the message loop before they are dispatched.
virtual xtd::ustring	product_name () const
	Gets the product name of the assembly containing the control.
bool	recreating_handle () const
	Gets a value indicating whether the control is currently re-creating its handle.
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.
virtual int32_t	right () const
	Gets the distance, in pixels, between the right edge of the control and the left edge of its container's client area.
intptr_t	send_message (intptr_t hwnd, int32_t msg, intptr_t wparam, intptr_t lparam) const
	Send a message with specified hwnd, message, wparam and lparam.
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_t x, int32_t y, int32_t width, int32_t height)
	Sets the bounds of the control to the specified location and size.
void	set_bounds (int32_t x, int32_t y, int32_t width, int32_t height, bounds_specified specified)
	Sets the specified bounds of the control to the specified location and size.
virtual void	show ()
	Displays the control to the user.
virtual const drawing::size &	size () const
	Gets the height and width of the control.
virtual control &	size (const drawing::size &size)
	Sets the height and width of the control.
void	suspend_layout ()
	Temporarily suspends the layout logic for the control.
virtual std::any	tag () const
	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
	Gets the text associated with this control.
virtual control &	text (const xtd::ustring &text)
	Sets the text associated with this control.
xtd::ustring	to_string () const noexcept override
	Returns a string containing the name of the control, if any.
virtual int32_t	top () const
	Gets the distance, in pixels, between the top edge of the control and the top edge of its container's client area.
virtual control &	top (int32_t top)
	Sets the distance, in pixels, between the top edge of the control and the top edge of its container's client area.
virtual std::optional< control_ref >	top_level_control () const
	Gets the parent control that is not parented by another Windows Forms control. Typically, this is the outermost Form that the control is contained in.
virtual void	update () const
	Causes the control to redraw the invalidated regions within its client area.
virtual bool	visible () const
	Gets a value indicating whether the control and all its child controls are displayed.
virtual control &	visible (bool visible)
	Sets a value indicating whether the control and all its child controls are displayed.
virtual int32_t	width () const
	Gets the width of the control.
virtual control &	width (int32_t width)
	Sets the width of the control.
Public Member Functions inherited from xtd::object
	object ()=default
	Create a new instance of the ultimate base class object.
virtual bool	equals (const object &obj) const noexcept
	Determines whether the specified object is equal to the current object.
virtual size_t	get_hash_code () const noexcept
	Serves as a hash function for a particular type.
template<typename object_t >
std::unique_ptr< object_t >	memberwise_clone () const
	Gets the type of the current instance.
virtual xtd::ustring	to_string () const noexcept
	Returns a std::string that represents the current object.
virtual intptr_t	handle () const =0
	Gets the handle to the window represented by the implementer.

Static Public Member Functions
static std::optional< std::reference_wrapper< form > >	active_form ()
	Gets the currently active form for this application.
Static Public Member Functions inherited from xtd::forms::control
template<typename control_t >
static std::unique_ptr< control_t >	create (const control &parent, const drawing::point &location={-1, -1}, const drawing::size &size={-1, -1}, const drawing::color &back_color=drawing::color::empty, const drawing::color &fore_color=drawing::color::empty)
	A factory to create a specified control with specified parent, location ,size back_color and fore_color.
template<typename control_t >
static std::unique_ptr< control_t >	create (const control &parent, const xtd::ustring &text, const drawing::point &location={-1, -1}, const drawing::size &size={-1, -1}, const drawing::color &back_color=drawing::color::empty, const drawing::color &fore_color=drawing::color::empty)
	A factory to create a specified control with specified parent, text, location ,size back_color and fore_color.
template<typename control_t >
static std::unique_ptr< control_t >	create (const drawing::point &location={-1, -1}, const drawing::size &size={-1, -1}, const drawing::color &back_color=drawing::color::empty, const drawing::color &fore_color=drawing::color::empty)
	A factory to create a specified control with specified location ,size back_color and fore_color.
template<typename control_t >
static std::unique_ptr< control_t >	create (const xtd::ustring &text, const drawing::point &location={-1, -1}, const drawing::size &size={-1, -1}, const drawing::color &back_color=drawing::color::empty, const drawing::color &fore_color=drawing::color::empty)
	A factory to create a specified control with specified text, location ,size back_color and fore_color.
static std::optional< control_ref >	from_child_handle (intptr_t handle)
	Retrieves the control that contains the specified handle.
static std::optional< control_ref >	from_handle (intptr_t handle)
	Returns the control that is currently associated with the specified handle.
static forms::keys	modifier_keys ()
	Gets a value indicating which of the modifier keys (SHIFT, CTRL, and ALT) is in a pressed state.
static forms::mouse_buttons	mouse_buttons ()
	Gets a value indicating which of the mouse buttons is in a pressed state.
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
forms::create_params	create_params () const override
	Gets the required creation parameters when the control handle is created.
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.
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_handle_created (const event_args &e) override
	Raises the control::handle_created event.
void	on_handle_destroyed (const event_args &e) override
	Raises the control::handle_destroyed event.
void	on_layout (const event_args &e) override
	Raises the control::layout event.
void	on_location_changed (const event_args &e) override
	Raises the control::location_changed event.
void	on_resize (const event_args &e) override
	Raises the control::resize event.
virtual void	wm_activate (message &message)
	Processes the active message the form control receives as the top-level window.
virtual void	wm_close (message &message)
	Processes the close message the form control receives as the top-level window.
void	wnd_proc (message &message) override
	Processes Windows messages.
Protected Member Functions inherited from xtd::forms::container_control
	container_control ()=default
	Initializes a new instance of the ContainerControl class.
drawing::size	measure_control () const override
	Measure this control.
Protected Member Functions inherited from xtd::forms::scrollable_control
	scrollable_control ()=default
	Initialize a new instance of scrollable_control class.
forms::create_params	create_params () const override
	Gets the required creation parameters when the control handle is created.
void	on_layout (const event_args &e) override
	Raises the control::layout event.
Protected Member Functions inherited from xtd::forms::control
virtual forms::create_params	create_params () const
	Gets the required creation parameters when the control handle is created.
virtual void	def_wnd_proc (message &message)
	Sends the specified message to the default window procedure.
bool	get_style (control_styles flag) const
	Retrieves the value of the specified control style bit for the control.
virtual drawing::size	measure_control () const
	Measure this control.
drawing::size	measure_text () const
	Measure this control text.
virtual void	on_auto_size_changed (const event_args &e)
	Raises the control::auto_size_changed event.
virtual void	on_back_color_changed (const event_args &e)
	Raises the control::back_color_changed event.
virtual void	on_background_image_changed (const event_args &e)
	Raises the control::background_image_changed event.
virtual void	on_background_image_layout_changed (const event_args &e)
	Raises the control::background_image_layout_changed event.
virtual void	on_click (const event_args &e)
	Raises the control::click event.
virtual void	on_client_size_changed (const event_args &e)
	Raises the control::client_size_changed event.
virtual void	on_control_added (const control_event_args &e)
	Raises the control::control_added event.
virtual void	on_control_removed (const control_event_args &e)
	Raises the control::control_removed event.
virtual void	on_create_control ()
	Raises the control::create_control event.
virtual void	on_cursor_changed (const event_args &e)
	Raises the control::cursor_changed event.
virtual void	on_dock_changed (const event_args &e)
	Raises the control::dock_changed event.
virtual void	on_double_click (const event_args &e)
	Raises the double_click event.
virtual void	on_enabled_changed (const event_args &e)
	Raises the control::enabled_changed event.
virtual void	on_font_changed (const event_args &e)
	Raises the control::font_changed event.
virtual void	on_fore_color_changed (const event_args &e)
	Raises the control::fore_color_changed event.
virtual void	on_got_focus (const event_args &e)
	Raises the control::got_focus event.
virtual void	on_handle_created (const event_args &e)
	Raises the control::handle_created event.
virtual void	on_handle_destroyed (const event_args &e)
	Raises the control::handle_destroyed event.
virtual void	on_key_down (key_event_args &e)
	Raises the control::key_down event.
virtual void	on_key_press (key_press_event_args &e)
	Raises the control::key_press event.
virtual void	on_key_up (key_event_args &e)
	Raises the control::key_up event.
virtual void	on_layout (const event_args &e)
	Raises the control::layout event.
virtual void	on_location_changed (const event_args &e)
	Raises the control::location_changed event.
virtual void	on_lost_focus (const event_args &e)
	Raises the control::lost_focus event.
virtual void	on_mouse_click (const mouse_event_args &e)
	Raises the control::mouse_click event.
virtual void	on_mouse_double_click (const mouse_event_args &e)
	Raises the control::mouse_double_click event.
virtual void	on_mouse_down (const mouse_event_args &e)
	Raises the control::mouse_down event.
virtual void	on_mouse_enter (const event_args &e)
	Raises the control::mouse_enter event.
virtual void	on_mouse_horizontal_wheel (const mouse_event_args &e)
	Raises the control::mouse_horizontal_wheel event.
virtual void	on_mouse_leave (const event_args &e)
	Raises the control::mouse_leave event.
virtual void	on_mouse_move (const mouse_event_args &e)
	Raises the control::mouse_move event.
virtual void	on_mouse_up (const mouse_event_args &e)
	Raises the control::mouse_up event.
virtual void	on_mouse_wheel (const mouse_event_args &e)
	Raises the control::mouse_wheel event.
virtual void	on_paint (paint_event_args &e)
	Raises the control::paint event.
virtual void	on_parent_back_color_changed (const event_args &e)
	Raises the control::parent_back_color_changed event.
virtual void	on_parent_changed (const event_args &e)
	Raises the control::parent_changed event.
virtual void	on_parent_cursor_changed (const event_args &e)
	Raises the control::parent_cursor_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_font_changed (const event_args &e)
	Raises the control::parent_font_changed event.
virtual void	on_parent_fore_color_changed (const event_args &e)
	Raises the control::parent_fore_color_changed event.
virtual void	on_resize (const event_args &e)
	Raises the control::resize event.
virtual void	on_size_changed (const event_args &e)
	Raises the control::size_changed event.
virtual void	on_text_changed (const event_args &e)
	Raises the control::text_changed event.
virtual void	on_visible_changed (const event_args &e)
	Raises the control::visible_changed event.
virtual void	recreate_handle ()
	Forces the re-creation of the handle for the control.
virtual void	set_bounds_core (int32_t x, int32_t y, int32_t width, int32_t height, bounds_specified specified)
	Performs the work of setting the specified bounds of this control.
virtual void	set_client_size_core (int32_t width, int32_t height)
	Sets the size of the client area of the control.
void	set_style (control_styles flag, bool value)
	Sets a specified control_styles flag to either true or false.
virtual void	wnd_proc (message &m)
	Processes Windows messages.
Protected Member Functions inherited from xtd::forms::component
	component ()=default
	Initialises a new instance of the component class.
virtual bool	can_raise_events () const
	Gets a value indicating whether the component can raise an event.
bool	design_mode () const
	Gets a value that indicates whether the component is currently in design mode.

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< std::reference_wrapper< ibutton_control > > xtd::forms::form::accept_button ( ) const

inline

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

(

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< std::reference_wrapper< form > > xtd::forms::form::active_form ( )

inlinestatic

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

inlinevirtual

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 paint event.

Reimplemented from xtd::forms::control.

cancel_button() [1/3]

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

inline

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

(

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.

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.

close_box() [1/2]

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

inlinevirtual

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

inlinevirtual

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

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

overrideprotectedvirtual

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

Returns

A create_params that contains the required creation parameters when the handle to the control is created.

Remarks

The create_params property should not be overridden and used to adjust the properties of your derived control. Properties such as the create_params::caption, create_params::width, and create_params::height should be set by the corresponding properties in your control such as control::text, control::width and control::height. The create_params should only be extended when you are wrapping a standard Windows control class or to set styles not provided by the forms namespace.

Notes for inheritors

When overriding the create_params property in a derived class, use the base class's create_params property to extend the base implementation. Otherwise, you must provide all the implementation.

Reimplemented from xtd::forms::control.

default_size()

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

inlineoverridevirtual

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

inlinevirtual

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

inlinevirtual

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

inlinevirtual

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

inlinevirtual

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

inlinevirtual

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< forms::main_menu > xtd::forms::form::menu ( ) const

inlinevirtual

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

inlinevirtual

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

inline

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 )

inlineprotectedvirtual

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 )

inlineprotectedvirtual

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 )

inlineprotectedvirtual

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 )

inlineprotectedvirtual

Raises the form::form_closing event.

Parameters

e	A form_closing_event_args that contains the event data.

Reimplemented in xtd::forms::trace_form_base.

on_handle_created()

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

overrideprotectedvirtual

Raises the 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 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 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 control::location_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 control::resize 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

inlinevirtual

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/2]

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

inlinevirtual

Gets the form that owns this form.

Returns

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

owner() [2/2]

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.

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

timer.cpp.

pre_process_message()

bool xtd::forms::form::pre_process_message ( 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.

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

inlinevirtual

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_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

inlinevirtual

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.

top_level() [1/2]

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

inlinevirtual

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

inlinevirtual

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

inlinevirtual

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.

wm_activate()

virtual void xtd::forms::form::wm_activate ( message &  message )

protectedvirtual

Processes the active message the form control receives as the top-level window.

Parameters

message

The message sent to the top-level window.

wm_close()

virtual void xtd::forms::form::wm_close ( message &  message )

protectedvirtual

Processes the close message the form control receives as the top-level window.

Parameters

message

The message sent to the top-level window.

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.

---

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

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