xtd - Reference Guide  0.1.1
Modern c++17/20 framework to create console, GUI and unit test applications on Windows, macOS, Linux, iOS and android.
Classes | Typedefs | Enumerations
xtd.forms

Definition

The xtd.forms library contains classes for creating Windows-based applications that take full advantage of the rich user interface features available in the Microsoft Windows operating system, Apple macOS and Linux like Ubuntu operating system.

Classes

class  xtd::forms::about_box
 Represents a dialog box that displays about box. More...
 
class  xtd::forms::about_dialog
 Represents a dialog box that displays about dialog. More...
 
class  xtd::forms::animation
 Represents an animation control. More...
 
class  xtd::forms::animation_updated_event_args
 Provides data for the animation update event. More...
 
class  xtd::forms::application
 Provides static methods and properties to manage an application, such as methods to start and stop an application, to process Windows messages, and methods to get information about an application. This class cannot be inherited. More...
 
class  xtd::forms::application_context
 Specifies the contextual information about an application thread. More...
 
class  xtd::forms::application_informations
 Specifies the application informations. More...
 
class  xtd::forms::background_worker
 Executes an operation on a separate thread. More...
 
class  xtd::forms::busy_box
 Represents a dialog box that displays busy box. More...
 
class  xtd::forms::busy_dialog
 Represents a dialog box that displays busy dialog. More...
 
class  xtd::forms::button
 Represents a Windows button control. More...
 
class  xtd::forms::button_base
 Implements the basic functionality common to button controls. More...
 
class  xtd::forms::button_images
 Provides a button images factories for use by a button control. More...
 
class  xtd::forms::button_renderer
 Provides button renderer methods. More...
 
class  xtd::forms::buttons
 Provides a collection of button objects for use by a Windows Forms application. More...
 
class  xtd::forms::cancel_event_args
 Provides data for a cancelable event. More...
 
class  xtd::forms::check_box
 Represents a Windows check_box. More...
 
class  xtd::forms::check_box_renderer
 Provides check box renderer methods. More...
 
class  xtd::forms::check_boxes
 Provides a collection of check_box objects for use by a Windows Forms application. More...
 
class  xtd::forms::checked_list_box
 Displays a xtd::forms::list_box in which a check box is displayed to the left of each item. More...
 
class  xtd::forms::choice
 Represents a choice control. More...
 
class  xtd::forms::collapsible_panel
 Used to group collections of controls in a collapsible panel. More...
 
class  xtd::forms::color_box
 Represents a common dialog box that displays available colors along with controls that enable the user to define custom colors. More...
 
class  xtd::forms::color_dialog
 Represents a common dialog box that displays available colors along with controls that enable the user to define custom colors. More...
 
class  xtd::forms::color_picker
 Represents a picker control that displays available colors along with controls that enable the user to define custom colors. More...
 
class  xtd::forms::combo_box
 Represents a Windows combo box control. More...
 
class  xtd::forms::command_link_button
 Represents a Windows command link button control. More...
 
class  xtd::forms::common_dialog
 Specifies the base class used for displaying dialog boxes on the screen. More...
 
class  xtd::forms::component
 Provides the base implementation and enables object sharing between applications. More...
 
struct  xtd::forms::const_control_ref_less
 Represents less comparator for const const_control_ref. More...
 
class  xtd::forms::container_control
 Provides focus-management functionality for controls that can function as a container for other controls. More...
 
class  xtd::forms::context_menu
 Represents a shortcut menu. More...
 
class  xtd::forms::control
 Defines the base class for controls, which are components with visual representation. More...
 
class  xtd::forms::control_event_args
 Provides data for the control_added and control_removed events. More...
 
class  xtd::forms::control_layout_style
 Implements the basic functionality that represents the appearance and behavior of a control layout. More...
 
class  xtd::forms::control_paint
 Provides methods used to paint common Windows controls and their elements. This class cannot be inherited. More...
 
struct  xtd::forms::control_ref_less
 Represents less comparator for control_ref. More...
 
class  xtd::forms::control_trace_listener
 Directs tracing or debugging output to a icontrol_trace object. More...
 
class  xtd::forms::countries
 Provides a collection of xtd::forms::country for all countries in the world. This class cannot be inherited. More...
 
class  xtd::forms::country
 Represent a country with name, alpha codes, numeric code, emoticon and flag. More...
 
class  xtd::forms::cursor
 Represents the image used to paint the mouse pointer. More...
 
class  xtd::forms::cursors
 Provides a collection of xtd::forms::cursor objects for use by a Windows Forms application. More...
 
class  xtd::forms::date_time_picker
 Represents a picker control that displays available date time along with controls. More...
 
class  xtd::forms::debug_form
 Represents a form that displays debug form. This class cannot be inherited. More...
 
class  xtd::forms::debug_message_box
 Displays a dialog box and write debug. More...
 
class  xtd::forms::dialog_closed_event_args
 Provides data for a dialog closed event. More...
 
class  xtd::forms::do_work_event_args
 Provides data for the do_work event handler. More...
 
class  xtd::forms::domain_up_down
 Represents a Windows spin box (also known as an up-down control) that displays string values. More...
 
class  xtd::forms::dot_matrix_display
 Represents a dot matrix display class. More...
 
class  xtd::forms::emoticon
 Represent a emoticon with name and codepoints. More...
 
class  xtd::forms::emoticons
 Provides a collection of xtd::forms:emoticon for all known emoticons. This class cannot be inherited. More...
 
class  xtd::forms::enable_debug
 Represent enable debug class. More...
 
class  xtd::forms::exception_box
 Represents a common dialog box that displays exception box. More...
 
class  xtd::forms::exception_dialog
 Represents a common dialog box that displays exception dialog. More...
 
class  xtd::forms::file_dialog
 Displays a dialog box from which the user can select a file. More...
 
class  xtd::forms::fixed_layout_panel
 Used to group collections of fixed aligned controls. More...
 
class  xtd::forms::flat_button_appearance
 Provides properties that specify the appearance of xtd::forms::button controls whose xtd::forms::flat_style is xtd::forms::flat_style::flat. More...
 
class  xtd::forms::flow_layout_panel
 Used to group collections of fixed aligned controls. More...
 
class  xtd::forms::folder_browser_dialog
 Prompts the user to select a folder. This class cannot be inherited. More...
 
class  xtd::forms::font_dialog
 Prompts the user to choose a font from among those installed on the local computer. More...
 
class  xtd::forms::font_picker
 Represents a picker control that displays available fonts along with controls. More...
 
class  xtd::forms::form
 Represents a window or dialog box that makes up an application's user interface. More...
 
class  xtd::forms::form_button_images
 Provides a form button images factories for use by a form control. More...
 
class  xtd::forms::form_closed_event_args
 Provides data for the form_closed event. More...
 
class  xtd::forms::form_closing_event_args
 Provides data for the form_closing event. More...
 
class  xtd::forms::fourteen_segment_display
 Represents a nine segment display class. More...
 
class  xtd::forms::group_box
 Represents a Windows control that displays a frame around a group of controls with an optional caption. More...
 
class  xtd::forms::h_scroll_bar
 Represents a standard Windows horizontal scroll bar. More...
 
class  xtd::forms::help_event_args
 Provides data for the control_added and control_removed events. More...
 
class  xtd::forms::horizontal_control_layout_style
 Implements the basic functionality that represents the appearance and behavior of a control layout. More...
 
class  xtd::forms::horizontal_layout_panel
 Used to group collections of horizontally aligned controls. More...
 
class  xtd::forms::ibutton_control
 Allows a control to act like a button on a form. More...
 
class  xtd::forms::icontrol_trace
 Allow a control to be called by control_trace_listener for writing debug or trace message. More...
 
class  xtd::forms::image_list
 Provides methods to manage a collection of xtd::drawing::image objects. This class cannot be inherited. More...
 
class  xtd::forms::imessage_filter
 Defines a message filter interface. More...
 
class  xtd::forms::input_box
 Represents a common dialog box that displays input box. More...
 
class  xtd::forms::input_dialog
 Represents a common dialog box that displays input dialog. More...
 
class  xtd::forms::item_check_event_args
 Provides data for the item_check event of the checked_list_box and list_view controls. More...
 
class  xtd::forms::iwin32_window
 Provides an interface to expose Win32 HWND handles. More...
 
class  xtd::forms::key_event_args
 Provides data for the key_down or key_up event. More...
 
class  xtd::forms::key_press_event_args
 Provides data for the key_press event. More...
 
class  xtd::forms::label
 Represents a standard Windows label. More...
 
class  xtd::forms::layout::arranged_element_collection< type_t, sorter_t >
 Represents a collection of objects. More...
 
class  xtd::forms::layout::sorter_none
 Represents a sorter none of objects. More...
 
class  xtd::forms::lcd_label
 Represents a lcd label. More...
 
class  xtd::forms::link
 Represents a link within a xtd::forms::link_label control. More...
 
class  xtd::forms::link_label
 Represents a Windows label control that can display hyperlinks. More...
 
class  xtd::forms::link_label_clicked_event_args
 Represents a Windows label control that can display hyperlinks. More...
 
class  xtd::forms::list_box
 Represents a standard Windows list box. More...
 
class  xtd::forms::list_control
 Provides a common implementation of members for the list_box, choice and combo_box classes. More...
 
class  xtd::forms::loading_indicator
 Represents a loading indicator control. More...
 
class  xtd::forms::main_menu
 Represents the menu structure of a form. More...
 
class  xtd::forms::menu
 Represents the base functionality for all menus. Although tool_strip_drop_down and tool_strip_drop_down_menu replace and add functionality to the menu control of previous versions, menu is retained for both backward compatibility and future use if you choose. More...
 
class  xtd::forms::menu_images
 Provides a menu images factories for use by a menu control. More...
 
class  xtd::forms::menu_item
 Represents an individual item that is displayed within a main_menu or context_menu. More...
 
class  xtd::forms::message
 Implements a Windows message. More...
 
class  xtd::forms::message_box
 Displays a message window, also known as a dialog box, which presents a message to the user. It is a modal window, blocking other actions in the application until the user closes it. A message_box can contain text, buttons, and symbols that inform and instruct the user. More...
 
class  xtd::forms::message_dialog
 Displays a message window, also known as a dialog box, which presents a message to the user. It is a modal window, blocking other actions in the application until the user closes it. A message_dialog can contain text, buttons, and symbols that inform and instruct the user. More...
 
class  xtd::forms::mouse_event_args
 Provides data for the xtd::forms::control::mouse_up, xtd::forms::control::mouse_down, and xtd::forms::control::mouse_move events. More...
 
class  xtd::forms::nine_segment_display
 Represents a nine segment display class. More...
 
class  xtd::forms::numeric_up_down
 Represents a standard Windows numeric up down. More...
 
class  xtd::forms::open_file_dialog
 Displays a standard dialog box that prompts the user to open a file. This class cannot be inherited. More...
 
class  xtd::forms::padding
 Represents a display device or multiple display devices on a single system. More...
 
class  xtd::forms::paint_event_args
 Provides data for the paint event. More...
 
class  xtd::forms::panel
 Used to group collections of controls. More...
 
class  xtd::forms::picture_box
 Represents a standard Windows picture box. More...
 
class  xtd::forms::progress_bar
 Represents a Windows progress bar control. More...
 
class  xtd::forms::progress_changed_event_args
 Provides data for the do_work event handler. More...
 
class  xtd::forms::progress_dialog
 Represents a common dialog box that displays progress dialog. More...
 
class  xtd::forms::properties::resources
 A strongly-typed resource class, for looking up localized strings, etc. More...
 
class  xtd::forms::radio_button
 Enables the user to select a single option from a group of choices when paired with other xtd::forms::radio_button controls. More...
 
class  xtd::forms::radio_button_renderer
 Provides radio button renderer methods. More...
 
class  xtd::forms::radio_buttons
 Provides a collection of radio_button objects for use by a Windows Forms application. More...
 
class  xtd::forms::renderer
 Provides control renderers methods. More...
 
class  xtd::forms::run_worker_completed_event_args
 Provides data for the do_work event handler. More...
 
class  xtd::forms::save_file_dialog
 Prompts the user to select a location for saving a file. This class cannot be inherited. More...
 
class  xtd::forms::screen
 Represents a display device or multiple display devices on a single system. More...
 
class  xtd::forms::scroll_bar
 Represents a standard Windows scroll bar. More...
 
class  xtd::forms::scrollable_control
 Defines a base class for controls that support auto-scrolling behavior. More...
 
class  xtd::forms::settings
 Represent settings associate to the application. More...
 
class  xtd::forms::seven_segment_display
 Represents a seven segment display class. More...
 
class  xtd::forms::sixteen_segment_display
 Represents a sixteen segment display class. More...
 
class  xtd::forms::split_container
 Represents a control consisting of a movable bar that divides a container's display area into two resizable panels. More...
 
class  xtd::forms::splitter
 Represents a splitter control that enables the user to resize docked controls. More...
 
class  xtd::forms::splitter_panel
 Creates a panel that is associated with a split_container. More...
 
class  xtd::forms::switch_button
 Represents a standard Windows switch button. More...
 
class  xtd::forms::switch_button_renderer
 Provides switch button renderer methods. More...
 
class  xtd::forms::system_information
 Provides information about the current system environment. More...
 
class  xtd::forms::system_texts
 Provides a collection of string objects for use by a Windows Forms application. More...
 
class  xtd::forms::tab_control
 Manages a related set of tab pages. More...
 
class  xtd::forms::tab_page
 Represents a single tab page in a tab_control. More...
 
class  xtd::forms::table_layout_panel
 Used to group collections of fixed aligned controls. More...
 
class  xtd::forms::text_box
 Represents a standard Windows text box. More...
 
class  xtd::forms::text_box_base
 Implements the basic functionality required by text controls. More...
 
class  xtd::forms::timer
 Implements a timer that raises an event at user-defined intervals. This timer is optimized for use in Windows Forms applications and must be used in a window. More...
 
class  xtd::forms::toggle_button
 Represents a Windows toggle_button. More...
 
class  xtd::forms::toggle_buttons
 Provides a collection of toggle_button objects for use by a Windows Forms application. More...
 
class  xtd::forms::tool_bar_images
 Provides a tool bar images factories for use by a tool_bar control. More...
 
class  xtd::forms::trace_form
 Represents a form that displays trace form. This class cannot be inherited. More...
 
class  xtd::forms::trace_form_base
 Represents a base form for debug_form and trace_form forms. This class cannot be instantiated. More...
 
class  xtd::forms::trace_message_box
 Displays a dialog box and write trace. More...
 
class  xtd::forms::track_bar
 Represents a standard Windows track bar. More...
 
class  xtd::forms::up_down_base
 Implements the basic functionality required by a spin box (also known as an up-down control). More...
 
class  xtd::forms::up_down_button
 Represents a standard Windows up down button. More...
 
class  xtd::forms::use_wait_cursor
 Creates a use wait cursor class. More...
 
class  xtd::forms::user_control
 Represents a standard Windows user control. More...
 
class  xtd::forms::v_scroll_bar
 Represents a standard Windows horizontal scroll bar. More...
 
class  xtd::forms::vertical_control_layout_style
 Implements the basic functionality that represents the appearance and behavior of a control layout. More...
 
class  xtd::forms::vertical_layout_panel
 Used to group collections of vertically aligned controls. More...
 

Typedefs

using xtd::forms::const_control_ref = std::reference_wrapper< const control >
 Represents a const control reference. More...
 
using xtd::forms::control_ref = std::reference_wrapper< control >
 Represents a control reference. More...
 
using xtd::forms::form_collection = std::vector< std::reference_wrapper< form > >
 Represents a collection of form objects. More...
 
using xtd::forms::horizontal_control_layout_style_collection = std::vector< std::pair< control_ref, horizontal_control_layout_style > >
 A collection that stores horizontal_control_layout_style objects. More...
 
using xtd::forms::message_box_buttons = message_dialog_buttons
 Specifies constants defining which buttons to display on a message_box. More...
 
using xtd::forms::message_box_default_button = message_dialog_default_button
 Specifies constants defining the default button on a message_box. More...
 
using xtd::forms::message_box_icon = message_dialog_icon
 Specifies constants defining which information to display. More...
 
using xtd::forms::message_box_options = message_dialog_options
 Specifies options on a message_box. More...
 
using xtd::forms::vertical_control_layout_style_collection = std::vector< std::pair< control_ref, vertical_control_layout_style > >
 A collection that stores vertical_control_layout_style objects. More...
 

Enumerations

enum class  xtd::forms::anchor_styles {
  xtd::forms::none ,
  xtd::forms::top ,
  xtd::forms::bottom ,
  xtd::forms::left ,
  xtd::forms::right
}
 Specifies how a control anchors to the edges of its container. More...
 
enum class  xtd::forms::appearance {
  xtd::forms::normal ,
  xtd::forms::button ,
  xtd::forms::switch_button
}
 Specifies the appearance of a control. More...
 
enum class  xtd::forms::arrange_direction {
  xtd::forms::down ,
  xtd::forms::left ,
  xtd::forms::right ,
  xtd::forms::up
}
 Specifies the direction the system uses to arrange minimized windows. More...
 
enum class  xtd::forms::arrange_starting_position {
  xtd::forms::bottom_left ,
  xtd::forms::bottom_right ,
  xtd::forms::top_left ,
  xtd::forms::top_right ,
  xtd::forms::hide
}
 Specifies the starting position that the system uses to arrange minimized windows. More...
 
enum class  xtd::forms::auto_size_mode {
  xtd::forms::grow_and_shrink ,
  xtd::forms::grow_only
}
 Specifies how a control will behave when its auto_size property is enabled. More...
 
enum class  xtd::forms::boot_mode {
  xtd::forms::normal ,
  xtd::forms::fail_safe ,
  xtd::forms::fail_safe_with_network
}
 Specifies the mode to start the computer in. More...
 
enum class  xtd::forms::border_style {
  xtd::forms::none ,
  xtd::forms::fixed_single ,
  xtd::forms::fixed_3d
}
 Specifies the border style for a control. More...
 
enum class  xtd::forms::bounds_specified {
  xtd::forms::none ,
  xtd::forms::x ,
  xtd::forms::y ,
  xtd::forms::location ,
  xtd::forms::width ,
  xtd::forms::height ,
  xtd::forms::size ,
  xtd::forms::all
}
 Specifies the bounds of the control to use when defining a control's size and position. This enumeration has a flags attribute that allows a bitwise combination of its member values. More...
 
enum class  xtd::forms::button_state {
  xtd::forms::normal ,
  xtd::forms::inactive ,
  xtd::forms::pushed ,
  xtd::forms::checked ,
  xtd::forms::flat ,
  xtd::forms::all
}
 Specifies the appearance of a button. More...
 
enum class  xtd::forms::character_casing {
  xtd::forms::normal ,
  xtd::forms::upper ,
  xtd::forms::lower
}
 Specifies the case of characters in a text_box control. More...
 
enum class  xtd::forms::visual_styles::check_box_state {
  xtd::forms::visual_styles::unchecked_normal ,
  xtd::forms::visual_styles::unchecked_hot ,
  xtd::forms::visual_styles::unchecked_pressed ,
  xtd::forms::visual_styles::unchecked_disabled ,
  xtd::forms::visual_styles::checked_normal ,
  xtd::forms::visual_styles::checked_hot ,
  xtd::forms::visual_styles::checked_pressed ,
  xtd::forms::visual_styles::checked_disabled ,
  xtd::forms::visual_styles::mixed_normal ,
  xtd::forms::visual_styles::mixed_hot ,
  xtd::forms::visual_styles::mixed_pressed ,
  xtd::forms::visual_styles::mixed_disabled
}
 Specifies the visual state of a check box that is drawn with visual styles. More...
 
enum class  xtd::forms::check_state {
  xtd::forms::unchecked ,
  xtd::forms::checked ,
  xtd::forms::indeterminate
}
 Specifies the state of a control, such as a check box, that can be checked, unchecked, or set to an indeterminate state. More...
 
enum class  xtd::forms::close_reason {
  xtd::forms::none ,
  xtd::forms::windows_shut_down ,
  xtd::forms::mdi_form_closing ,
  xtd::forms::user_closing ,
  xtd::forms::task_manager_closing ,
  xtd::forms::form_owner_closing ,
  xtd::forms::application_exit_call
}
 Specifies the reason that a form was closed. More...
 
enum class  xtd::forms::color_box_styles {
  xtd::forms::none ,
  xtd::forms::alpha_color ,
  xtd::forms::allow_full_open ,
  xtd::forms::any_color ,
  xtd::forms::full_open ,
  xtd::forms::show_help ,
  xtd::forms::solid_color_only
}
 Specifies constants defining which color_box styles is used. More...
 
enum class  xtd::forms::combo_box_style {
  xtd::forms::simple ,
  xtd::forms::drop_down ,
  xtd::forms::drop_down_list
}
 Specifies the combo_box style. More...
 
enum class  xtd::forms::content_alignment {
  xtd::forms::top_left ,
  xtd::forms::top_center ,
  xtd::forms::top_right ,
  xtd::forms::middle_left ,
  xtd::forms::middle_center ,
  xtd::forms::middle_right ,
  xtd::forms::bottom_left ,
  xtd::forms::bottom_center ,
  xtd::forms::bottom_right
}
 Specifies alignment of content on the drawing surface. More...
 
enum class  xtd::forms::control_styles {
  xtd::forms::none ,
  xtd::forms::container_control ,
  xtd::forms::user_paint ,
  xtd::forms::opaque ,
  xtd::forms::resize_redraw ,
  xtd::forms::fixed_width ,
  xtd::forms::fixed_height ,
  xtd::forms::standard_click ,
  xtd::forms::selectable ,
  xtd::forms::user_mouse ,
  xtd::forms::supports_transparent_back_color ,
  xtd::forms::standard_double_click ,
  xtd::forms::all_painting_in_wm_paint ,
  xtd::forms::cache_text ,
  xtd::forms::enable_notify_message ,
  xtd::forms::double_buffer ,
  xtd::forms::optimized_double_buffer ,
  xtd::forms::use_text_for_accessibility
}
 Specifies the style and behavior of a control. More...
 
enum class  xtd::forms::date_time_picker_format {
  xtd::forms::long_format ,
  xtd::forms::short_format ,
  xtd::forms::time ,
  xtd::forms::custom
}
 Specifies the date and time format the date_time_picker control displays. More...
 
enum class  xtd::forms::dialog_result {
  xtd::forms::none ,
  xtd::forms::ok ,
  xtd::forms::cancel ,
  xtd::forms::abort ,
  xtd::forms::retry ,
  xtd::forms::ignore ,
  xtd::forms::yes ,
  xtd::forms::no
}
 Specifies identifiers to indicate the return value of a dialog box. More...
 
enum class  xtd::forms::dialog_style {
  xtd::forms::standard ,
  xtd::forms::system
}
 Specifies the style of a dialog. More...
 
enum class  xtd::forms::dock_style {
  xtd::forms::none ,
  xtd::forms::top ,
  xtd::forms::bottom ,
  xtd::forms::left ,
  xtd::forms::right ,
  xtd::forms::fill
}
 Specifies the position and manner in which a control is docked. More...
 
enum class  xtd::forms::dot_matrix_style {
  xtd::forms::round ,
  xtd::forms::square ,
  xtd::forms::standard
}
 Represent dot matrix style used by dot_matrix_display control. More...
 
enum class  xtd::forms::flat_style {
  xtd::forms::flat ,
  xtd::forms::popup ,
  xtd::forms::standard ,
  xtd::forms::system
}
 Specifies the appearance of a control. More...
 
enum class  xtd::forms::form_border_style {
  xtd::forms::none ,
  xtd::forms::fixed_single ,
  xtd::forms::fixed_3d ,
  xtd::forms::fixed_dialog ,
  xtd::forms::sizable ,
  xtd::forms::fixed_tool_window ,
  xtd::forms::sizable_tool_window
}
 Specifies the border styles for a form. More...
 
enum class  xtd::forms::form_start_position {
  xtd::forms::manual ,
  xtd::forms::center_screen ,
  xtd::forms::windows_default_location ,
  xtd::forms::windows_default_bounds ,
  xtd::forms::center_parent
}
 Specifies the initial position of a form. More...
 
enum class  xtd::forms::form_window_state {
  xtd::forms::normal ,
  xtd::forms::minimized ,
  xtd::forms::maximized ,
  xtd::forms::full_screen
}
 Specifies how a form window is displayed. More...
 
enum class  xtd::forms::image_layout {
  xtd::forms::none ,
  xtd::forms::tile ,
  xtd::forms::center ,
  xtd::forms::stretch ,
  xtd::forms::zoom
}
 Specifies the position of the image on the control. More...
 
enum class  xtd::forms::input_box_style {
  xtd::forms::normal ,
  xtd::forms::multiline ,
  xtd::forms::password
}
 Specifies constants defining which input_box style is used. More...
 
enum class  xtd::forms::keys : long long {
  xtd::forms::none ,
  xtd::forms::lbutton ,
  xtd::forms::rbutton ,
  xtd::forms::cancel ,
  xtd::forms::mbutton ,
  xtd::forms::xbutton1 ,
  xtd::forms::xbutton2 ,
  xtd::forms::back ,
  xtd::forms::tab ,
  xtd::forms::line_feed ,
  xtd::forms::clear ,
  xtd::forms::ret ,
  xtd::forms::enter ,
  xtd::forms::shift_key ,
  xtd::forms::control_key ,
  xtd::forms::menu ,
  xtd::forms::pause ,
  xtd::forms::caps_lock ,
  xtd::forms::capital ,
  xtd::forms::kana_mode ,
  xtd::forms::hanguel_mode ,
  xtd::forms::hangul_mode ,
  xtd::forms::junja_mode ,
  xtd::forms::final_mode ,
  xtd::forms::kanji_mode ,
  xtd::forms::hanja_mode ,
  xtd::forms::escape ,
  xtd::forms::ime_convert ,
  xtd::forms::ime_nonconvert ,
  xtd::forms::ime_accept ,
  xtd::forms::ime_mode_change ,
  xtd::forms::space ,
  xtd::forms::page_up ,
  xtd::forms::prior ,
  xtd::forms::page_down ,
  xtd::forms::next ,
  xtd::forms::end ,
  xtd::forms::home ,
  xtd::forms::left ,
  xtd::forms::up ,
  xtd::forms::right ,
  xtd::forms::down ,
  xtd::forms::select ,
  xtd::forms::print ,
  xtd::forms::execute ,
  xtd::forms::print_screen ,
  xtd::forms::snapshot ,
  xtd::forms::insert ,
  xtd::forms::del ,
  xtd::forms::help ,
  xtd::forms::d0 ,
  xtd::forms::d1 ,
  xtd::forms::d2 ,
  xtd::forms::d3 ,
  xtd::forms::d4 ,
  xtd::forms::d5 ,
  xtd::forms::d6 ,
  xtd::forms::d7 ,
  xtd::forms::d8 ,
  xtd::forms::d9 ,
  xtd::forms::a ,
  xtd::forms::b ,
  xtd::forms::c ,
  xtd::forms::d ,
  xtd::forms::e ,
  xtd::forms::f ,
  xtd::forms::g ,
  xtd::forms::h ,
  xtd::forms::i ,
  xtd::forms::j ,
  xtd::forms::k ,
  xtd::forms::l ,
  xtd::forms::m ,
  xtd::forms::n ,
  xtd::forms::o ,
  xtd::forms::p ,
  xtd::forms::q ,
  xtd::forms::r ,
  xtd::forms::s ,
  xtd::forms::t ,
  xtd::forms::u ,
  xtd::forms::v ,
  xtd::forms::w ,
  xtd::forms::x ,
  xtd::forms::y ,
  xtd::forms::z ,
  xtd::forms::lwin ,
  xtd::forms::rwin ,
  xtd::forms::apps ,
  xtd::forms::sleep ,
  xtd::forms::num_pad0 ,
  xtd::forms::num_pad1 ,
  xtd::forms::num_pad2 ,
  xtd::forms::num_pad3 ,
  xtd::forms::num_pad4 ,
  xtd::forms::num_pad5 ,
  xtd::forms::num_pad6 ,
  xtd::forms::num_pad7 ,
  xtd::forms::num_pad8 ,
  xtd::forms::num_pad9 ,
  xtd::forms::multiply ,
  xtd::forms::add ,
  xtd::forms::separator ,
  xtd::forms::subtract ,
  xtd::forms::decimal ,
  xtd::forms::divide ,
  xtd::forms::f1 ,
  xtd::forms::f2 ,
  xtd::forms::f3 ,
  xtd::forms::f4 ,
  xtd::forms::f5 ,
  xtd::forms::f6 ,
  xtd::forms::f7 ,
  xtd::forms::f8 ,
  xtd::forms::f9 ,
  xtd::forms::f10 ,
  xtd::forms::f11 ,
  xtd::forms::f12 ,
  xtd::forms::f13 ,
  xtd::forms::f14 ,
  xtd::forms::f15 ,
  xtd::forms::f16 ,
  xtd::forms::f17 ,
  xtd::forms::f18 ,
  xtd::forms::f19 ,
  xtd::forms::f20 ,
  xtd::forms::f21 ,
  xtd::forms::f22 ,
  xtd::forms::f23 ,
  xtd::forms::f24 ,
  xtd::forms::num_lock ,
  xtd::forms::scroll ,
  xtd::forms::lshift_key ,
  xtd::forms::rshift_key ,
  xtd::forms::lcontrol_key ,
  xtd::forms::rcontrol_key ,
  xtd::forms::lmenu ,
  xtd::forms::rmenu ,
  xtd::forms::browser_back ,
  xtd::forms::browser_forward ,
  xtd::forms::browser_refresh ,
  xtd::forms::browser_stop ,
  xtd::forms::browser_search ,
  xtd::forms::browser_favorites ,
  xtd::forms::browser_home ,
  xtd::forms::volume_mute ,
  xtd::forms::volume_down ,
  xtd::forms::volume_up ,
  xtd::forms::media_next_track ,
  xtd::forms::media_previous_track ,
  xtd::forms::media_stop ,
  xtd::forms::media_play_pause ,
  xtd::forms::launch_mail ,
  xtd::forms::select_media ,
  xtd::forms::launch_application1 ,
  xtd::forms::launch_application2 ,
  xtd::forms::oem1 ,
  xtd::forms::oem_semicolon ,
  xtd::forms::oem_plus ,
  xtd::forms::oem_comma ,
  xtd::forms::oem_minus ,
  xtd::forms::oem_period ,
  xtd::forms::oem2 ,
  xtd::forms::oem_question ,
  xtd::forms::oem3 ,
  xtd::forms::oem_tilde ,
  xtd::forms::oem4 ,
  xtd::forms::oem_open_brackets ,
  xtd::forms::oem5 ,
  xtd::forms::oem_pipe ,
  xtd::forms::oem6 ,
  xtd::forms::oem_close_brackets ,
  xtd::forms::oem7 ,
  xtd::forms::oem_quotes ,
  xtd::forms::oem8 ,
  xtd::forms::oem102 ,
  xtd::forms::oem_backslash ,
  xtd::forms::process_key ,
  xtd::forms::packet ,
  xtd::forms::attn ,
  xtd::forms::crsel ,
  xtd::forms::exsel ,
  xtd::forms::erase_eof ,
  xtd::forms::play ,
  xtd::forms::zoom ,
  xtd::forms::no_name ,
  xtd::forms::pa1 ,
  xtd::forms::oem_clear ,
  xtd::forms::command_key ,
  xtd::forms::lcommand_key ,
  xtd::forms::rcommand_key ,
  xtd::forms::function_key ,
  xtd::forms::shift ,
  xtd::forms::control ,
  xtd::forms::alt ,
  xtd::forms::command ,
  xtd::forms::meta ,
  xtd::forms::function ,
  xtd::forms::key_code ,
  xtd::forms::modifiers
}
 Specifies key codes and modifiers. More...
 
enum class  xtd::forms::known_themed_color {
  xtd::forms::accent ,
  xtd::forms::accent_text ,
  xtd::forms::active_border ,
  xtd::forms::active_caption ,
  xtd::forms::active_caption_text ,
  xtd::forms::app_workspace ,
  xtd::forms::button_face ,
  xtd::forms::button_highlight ,
  xtd::forms::button_shadow ,
  xtd::forms::control ,
  xtd::forms::control_dark ,
  xtd::forms::control_dark_dark ,
  xtd::forms::control_light ,
  xtd::forms::control_light_light ,
  xtd::forms::control_text ,
  xtd::forms::desktop ,
  xtd::forms::gradient_active_caption ,
  xtd::forms::gradient_inactive_caption ,
  xtd::forms::gray_text ,
  xtd::forms::highlight ,
  xtd::forms::highlight_text ,
  xtd::forms::hot_track ,
  xtd::forms::inactive_border ,
  xtd::forms::inactive_caption ,
  xtd::forms::inactive_caption_text ,
  xtd::forms::info ,
  xtd::forms::info_text ,
  xtd::forms::menu ,
  xtd::forms::menu_bar ,
  xtd::forms::menu_highlight ,
  xtd::forms::menu_text ,
  xtd::forms::scroll_bar ,
  xtd::forms::text_box ,
  xtd::forms::text_box_text ,
  xtd::forms::window ,
  xtd::forms::window_frame ,
  xtd::forms::window_text
}
 Specifies the known system colors. More...
 
enum class  xtd::forms::lcd_style {
  xtd::forms::seven_segment_display ,
  xtd::forms::nine_segment_display ,
  xtd::forms::fourteen_segment_display ,
  xtd::forms::sixteen_segment_display ,
  xtd::forms::dot_matrix_display
}
 Represent lcd label style used by lcd_label control. More...
 
enum class  xtd::forms::loading_indicator_style {
  xtd::forms::dots ,
  xtd::forms::standard ,
  xtd::forms::system
}
 Specifies the appearance of a loading indicator control. More...
 
enum class  xtd::forms::menu_item_kind {
  xtd::forms::normal ,
  xtd::forms::check ,
  xtd::forms::radio ,
  xtd::forms::drop_down ,
  xtd::forms::separator
}
 Represent menu item kind used by xtd::forms::menu_item component. More...
 
enum class  xtd::forms::message_dialog_buttons {
  xtd::forms::ok ,
  xtd::forms::ok_cancel ,
  xtd::forms::abort_retry_ignore ,
  xtd::forms::yes_no_cancel ,
  xtd::forms::yes_no ,
  xtd::forms::retry_cancel
}
 Specifies constants defining which buttons to display on a message_box. More...
 
enum class  xtd::forms::message_dialog_default_button {
  xtd::forms::button1 ,
  xtd::forms::button2 ,
  xtd::forms::button3
}
 Specifies constants defining the default button on a message_box. More...
 
enum class  xtd::forms::message_dialog_icon {
  xtd::forms::none ,
  xtd::forms::hand ,
  xtd::forms::stop ,
  xtd::forms::error ,
  xtd::forms::question ,
  xtd::forms::exclamation ,
  xtd::forms::warning ,
  xtd::forms::asterisk ,
  xtd::forms::information
}
 Specifies constants defining which information to display. More...
 
enum class  xtd::forms::message_dialog_options {
  xtd::forms::default_desktop_only ,
  xtd::forms::right_align ,
  xtd::forms::rtl_reading ,
  xtd::forms::service_notification
}
 Specifies options on a message_box. More...
 
enum class  xtd::forms::mouse_buttons {
  xtd::forms::none ,
  xtd::forms::left ,
  xtd::forms::right ,
  xtd::forms::middle ,
  xtd::forms::x_button1 ,
  xtd::forms::x_button2
}
 Specifies constants that define which mouse button was pressed. This enumeration has a flag attribute that allows a bitwise combination of its member values. More...
 
enum class  xtd::forms::orientation {
  xtd::forms::horizontal ,
  xtd::forms::vertical
}
 Specifies the orientation of controls or elements of controls. More...
 
enum class  xtd::forms::picture_box_size_mode {
  xtd::forms::normal ,
  xtd::forms::stretch_image ,
  xtd::forms::auto_size ,
  xtd::forms::center_image ,
  xtd::forms::zoom
}
 Specifies how an image is positioned within a picture_box. More...
 
enum class  xtd::forms::progress_bar_style {
  xtd::forms::blocks ,
  xtd::forms::continuous ,
  xtd::forms::marquee
}
 Specifies the progress_bar_style of controls or elements of controls. More...
 
enum class  xtd::forms::visual_styles::push_button_state {
  xtd::forms::visual_styles::normal ,
  xtd::forms::visual_styles::hot ,
  xtd::forms::visual_styles::pressed ,
  xtd::forms::visual_styles::checked ,
  xtd::forms::visual_styles::disabled ,
  xtd::forms::visual_styles::default_state
}
 Specifies the visual state of a button that is drawn with visual styles. More...
 
enum class  xtd::forms::visual_styles::radio_button_state {
  xtd::forms::visual_styles::unchecked_normal ,
  xtd::forms::visual_styles::unchecked_hot ,
  xtd::forms::visual_styles::unchecked_pressed ,
  xtd::forms::visual_styles::unchecked_disabled ,
  xtd::forms::visual_styles::checked_normal ,
  xtd::forms::visual_styles::checked_hot ,
  xtd::forms::visual_styles::checked_pressed ,
  xtd::forms::visual_styles::checked_disabled
}
 Specifies the visual state of a radio button that is drawn with visual styles. More...
 
enum class  xtd::forms::segment_style {
  xtd::forms::standard ,
  xtd::forms::modern ,
  xtd::forms::mixed ,
  xtd::forms::expanded ,
  xtd::forms::design ,
  xtd::forms::stick
}
 Represent segment style used by seven_segment_display, fourteen_segment_display, nine_segment_display and sixteen_segment_display controls. More...
 
enum class  xtd::forms::segments {
  xtd::forms::none ,
  xtd::forms::a ,
  xtd::forms::b ,
  xtd::forms::c ,
  xtd::forms::d ,
  xtd::forms::e ,
  xtd::forms::f ,
  xtd::forms::g ,
  xtd::forms::h ,
  xtd::forms::i ,
  xtd::forms::j ,
  xtd::forms::k ,
  xtd::forms::l ,
  xtd::forms::m ,
  xtd::forms::a1 ,
  xtd::forms::a2 ,
  xtd::forms::d1 ,
  xtd::forms::d2 ,
  xtd::forms::g1 ,
  xtd::forms::g2 ,
  xtd::forms::dp ,
  xtd::forms::pc
}
 Specifies how a control anchors to the edges of its container. More...
 
enum class  xtd::forms::selection_mode {
  xtd::forms::none ,
  xtd::forms::one ,
  xtd::forms::multi_simple ,
  xtd::forms::multi_extended
}
 Specifies the selection behavior of a list box. More...
 
enum class  xtd::forms::shortcut {
  xtd::forms::alt_0 ,
  xtd::forms::alt_1 ,
  xtd::forms::alt_2 ,
  xtd::forms::alt_3 ,
  xtd::forms::alt_4 ,
  xtd::forms::alt_5 ,
  xtd::forms::alt_6 ,
  xtd::forms::alt_7 ,
  xtd::forms::alt_8 ,
  xtd::forms::alt_9 ,
  xtd::forms::alt_bksp ,
  xtd::forms::alt_down_arrow ,
  xtd::forms::alt_f1 ,
  xtd::forms::alt_f10 ,
  xtd::forms::alt_f11 ,
  xtd::forms::alt_f12 ,
  xtd::forms::alt_f2 ,
  xtd::forms::alt_f3 ,
  xtd::forms::alt_f4 ,
  xtd::forms::alt_f5 ,
  xtd::forms::alt_f6 ,
  xtd::forms::alt_f7 ,
  xtd::forms::alt_f8 ,
  xtd::forms::alt_f9 ,
  xtd::forms::alt_left_arrow ,
  xtd::forms::alt_right_arrow ,
  xtd::forms::alt_up_arrow ,
  xtd::forms::cmd_0 ,
  xtd::forms::cmd_1 ,
  xtd::forms::cmd_2 ,
  xtd::forms::cmd_3 ,
  xtd::forms::cmd_4 ,
  xtd::forms::cmd_5 ,
  xtd::forms::cmd_6 ,
  xtd::forms::cmd_7 ,
  xtd::forms::cmd_8 ,
  xtd::forms::cmd_9 ,
  xtd::forms::cmd_a ,
  xtd::forms::cmd_b ,
  xtd::forms::cmd_c ,
  xtd::forms::cmd_d ,
  xtd::forms::cmd_del ,
  xtd::forms::cmd_e ,
  xtd::forms::cmd_f ,
  xtd::forms::cmd_f1 ,
  xtd::forms::cmd_f10 ,
  xtd::forms::cmd_f11 ,
  xtd::forms::cmd_f12 ,
  xtd::forms::cmd_f2 ,
  xtd::forms::cmd_f3 ,
  xtd::forms::cmd_f4 ,
  xtd::forms::cmd_f5 ,
  xtd::forms::cmd_f6 ,
  xtd::forms::cmd_f7 ,
  xtd::forms::cmd_f8 ,
  xtd::forms::cmd_f9 ,
  xtd::forms::cmd_g ,
  xtd::forms::cmd_h ,
  xtd::forms::cmd_i ,
  xtd::forms::cmd_ins ,
  xtd::forms::cmd_j ,
  xtd::forms::cmd_k ,
  xtd::forms::cmd_l ,
  xtd::forms::cmd_m ,
  xtd::forms::cmd_n ,
  xtd::forms::cmd_o ,
  xtd::forms::cmd_p ,
  xtd::forms::cmd_q ,
  xtd::forms::cmd_r ,
  xtd::forms::cmd_s ,
  xtd::forms::cmd_shift_0 ,
  xtd::forms::cmd_shift_1 ,
  xtd::forms::cmd_shift_2 ,
  xtd::forms::cmd_shift_3 ,
  xtd::forms::cmd_shift_4 ,
  xtd::forms::cmd_shift_5 ,
  xtd::forms::cmd_shift_6 ,
  xtd::forms::cmd_shift_7 ,
  xtd::forms::cmd_shift_8 ,
  xtd::forms::cmd_shift_9 ,
  xtd::forms::cmd_shift_a ,
  xtd::forms::cmd_shift_b ,
  xtd::forms::cmd_shift_c ,
  xtd::forms::cmd_shift_d ,
  xtd::forms::cmd_shift_e ,
  xtd::forms::cmd_shift_f ,
  xtd::forms::cmd_shift_f1 ,
  xtd::forms::cmd_shift_f10 ,
  xtd::forms::cmd_shift_f11 ,
  xtd::forms::cmd_shift_f12 ,
  xtd::forms::cmd_shift_f2 ,
  xtd::forms::cmd_shift_f3 ,
  xtd::forms::cmd_shift_f4 ,
  xtd::forms::cmd_shift_f5 ,
  xtd::forms::cmd_shift_f6 ,
  xtd::forms::cmd_shift_f7 ,
  xtd::forms::cmd_shift_f8 ,
  xtd::forms::cmd_shift_f9 ,
  xtd::forms::cmd_shift_g ,
  xtd::forms::cmd_shift_h ,
  xtd::forms::cmd_shift_i ,
  xtd::forms::cmd_shift_j ,
  xtd::forms::cmd_shift_k ,
  xtd::forms::cmd_shift_l ,
  xtd::forms::cmd_shift_m ,
  xtd::forms::cmd_shift_n ,
  xtd::forms::cmd_shift_o ,
  xtd::forms::cmd_shift_p ,
  xtd::forms::cmd_shift_q ,
  xtd::forms::cmd_shift_r ,
  xtd::forms::cmd_shift_s ,
  xtd::forms::cmd_shift_t ,
  xtd::forms::cmd_shift_u ,
  xtd::forms::cmd_shift_v ,
  xtd::forms::cmd_shift_w ,
  xtd::forms::cmd_shift_x ,
  xtd::forms::cmd_shift_y ,
  xtd::forms::cmd_shift_z ,
  xtd::forms::cmd_t ,
  xtd::forms::cmd_u ,
  xtd::forms::cmd_v ,
  xtd::forms::cmd_w ,
  xtd::forms::cmd_x ,
  xtd::forms::cmd_y ,
  xtd::forms::cmd_z ,
  xtd::forms::del ,
  xtd::forms::f1 ,
  xtd::forms::f10 ,
  xtd::forms::f11 ,
  xtd::forms::f12 ,
  xtd::forms::f2 ,
  xtd::forms::f3 ,
  xtd::forms::f4 ,
  xtd::forms::f5 ,
  xtd::forms::f6 ,
  xtd::forms::f7 ,
  xtd::forms::f8 ,
  xtd::forms::f9 ,
  xtd::forms::ins ,
  xtd::forms::none ,
  xtd::forms::shift_del ,
  xtd::forms::shift_f1 ,
  xtd::forms::shift_f10 ,
  xtd::forms::shift_f11 ,
  xtd::forms::shift_f12 ,
  xtd::forms::shift_f2 ,
  xtd::forms::shift_f3 ,
  xtd::forms::shift_f4 ,
  xtd::forms::shift_f5 ,
  xtd::forms::shift_f6 ,
  xtd::forms::shift_f7 ,
  xtd::forms::shift_f8 ,
  xtd::forms::shift_f9 ,
  xtd::forms::shift_ins
}
 Specifies shortcut keys that can be used by menu items. More...
 
enum class  xtd::forms::size_type {
  xtd::forms::auto_size ,
  xtd::forms::absolute ,
  xtd::forms::percent
}
 Specifies how rows or columns of user interface (UI) elements should be sized relative to their container. More...
 
enum class  xtd::forms::splitter_style {
  xtd::forms::draw_line ,
  xtd::forms::update_children
}
 Represent splitter style used by splitter control. More...
 
enum class  xtd::forms::tab_alignment {
  xtd::forms::top ,
  xtd::forms::bottom ,
  xtd::forms::left ,
  xtd::forms::right
}
 Specifies the locations of the tabs in a tab control. More...
 
enum class  xtd::forms::text_format_flags {
  xtd::forms::default_format ,
  xtd::forms::glyph_overhang_padding ,
  xtd::forms::left ,
  xtd::forms::top ,
  xtd::forms::horizontal_center ,
  xtd::forms::right ,
  xtd::forms::vertical_center ,
  xtd::forms::bottom ,
  xtd::forms::word_break ,
  xtd::forms::single_line ,
  xtd::forms::expand_tabs ,
  xtd::forms::no_clipping ,
  xtd::forms::external_leading ,
  xtd::forms::no_prefix ,
  xtd::forms::internal ,
  xtd::forms::text_box_control ,
  xtd::forms::path_ellipsis ,
  xtd::forms::end_ellipse ,
  xtd::forms::modify_string ,
  xtd::forms::right_to_left ,
  xtd::forms::word_ellipsis ,
  xtd::forms::no_full_width_characterB_break ,
  xtd::forms::hide_prefix ,
  xtd::forms::prefix_only ,
  xtd::forms::preserve_graphics_clipping ,
  xtd::forms::preserve_graphics_translate_transform ,
  xtd::forms::no_padding ,
  xtd::forms::left_and_right_padding
}
 Specifies the display and layout information for text strings. More...
 
enum  xtd::forms::theme_style {
  system_auto ,
  undefined ,
  light ,
  dark
}
 Specifies the style of theme. More...
 
enum class  xtd::forms::tick_style {
  xtd::forms::none ,
  xtd::forms::top_left ,
  xtd::forms::bottom_right ,
  xtd::forms::both
}
 Specifies the location of tick marks in a track_bar control. More...
 
enum class  xtd::forms::visual_styles::toggle_button_state {
  xtd::forms::visual_styles::unchecked_normal ,
  xtd::forms::visual_styles::unchecked_hot ,
  xtd::forms::visual_styles::unchecked_pressed ,
  xtd::forms::visual_styles::unchecked_disabled ,
  xtd::forms::visual_styles::checked_normal ,
  xtd::forms::visual_styles::checked_hot ,
  xtd::forms::visual_styles::checked_pressed ,
  xtd::forms::visual_styles::checked_disabled ,
  xtd::forms::visual_styles::mixed_normal ,
  xtd::forms::visual_styles::mixed_hot ,
  xtd::forms::visual_styles::mixed_pressed ,
  xtd::forms::visual_styles::mixed_disabled
}
 Specifies the visual state of a check box that is drawn with visual styles. More...
 

Typedef Documentation

◆ const_control_ref

using xtd::forms::const_control_ref = typedef std::reference_wrapper<const control>

#include <xtd.forms/include/xtd/forms/control_ref.h>

Represents a const control reference.

Namespace
xtd::forms
Library
xtd.forms

◆ control_ref

using xtd::forms::control_ref = typedef std::reference_wrapper<control>

#include <xtd.forms/include/xtd/forms/control_ref.h>

Represents a control reference.

Namespace
xtd::forms
Library
xtd.forms

◆ form_collection

using xtd::forms::form_collection = typedef std::vector<std::reference_wrapper<form> >

#include <xtd.forms/include/xtd/forms/application.h>

Represents a collection of form objects.

Namespace
xtd::forms
Library
xtd.forms
Remarks
form_collection is used by the application object to list the currently open forms in an application through the open_forms property.

◆ horizontal_control_layout_style_collection

◆ message_box_buttons

#include <xtd.forms/include/xtd/forms/message_box_buttons.h>

Specifies constants defining which buttons to display on a message_box.

Namespace
xtd::forms
Library
xtd.forms
Remarks
This enumeration is used by the message_box class.

◆ message_box_default_button

#include <xtd.forms/include/xtd/forms/message_box_default_button.h>

Specifies constants defining the default button on a message_box.

Namespace
xtd::forms
Library
xtd.forms
Remarks
This enumeration is used by the message_box class.

◆ message_box_icon

#include <xtd.forms/include/xtd/forms/message_box_icon.h>

Specifies constants defining which information to display.

Namespace
xtd::forms
Library
xtd.forms
Remarks
This enumeration is used by the message_box class. The description of each member of this enumeration contains a typical representation of the symbol. The actual graphic displayed is a function of the operating system constants. In current implementations there are four unique symbols with multiple values assigned to them.

◆ message_box_options

#include <xtd.forms/include/xtd/forms/message_box_options.h>

Specifies options on a message_box.

Namespace
xtd::forms
Library
xtd.forms
Remarks
This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values.
This enumeration is used by the MessageBox class.
If you do not want to specify this parameter when calling methods on MessageBox, you can pass in 0 instead.

◆ vertical_control_layout_style_collection

Enumeration Type Documentation

◆ anchor_styles

#include <xtd.forms/include/xtd/forms/anchor_styles.h>

Specifies how a control anchors to the edges of its container.

Namespace
xtd::forms
Library
xtd.forms
Remarks
This enumeration has a flags attribute that allows a bitwise combination of its member values.
When a control is anchored to an edge of its container, the distance between the control and the specified edge remains constant when the container resizes. For example, if a control is anchored to the right edge of its container, the distance between the right edge of the control and the right edge of the container remains constant when the container resizes. A control can be anchored to any combination of control edges. If the control is anchored to opposite edges of its container (for example, to the top and bottom), it resizes when the container resizes. If a control has its anchor property set to none, the control moves half of the distance that the container of the control is resized. For example, if a button has its anchor property set to none and the form that the control is located on is resized by 20 pixels in either direction, the button will be moved 10 pixels in both directions.
Enumerator
none 

The cause of the closure was not defined or could not be determined.

top 

The operating system is closing all applications before shutting down.

bottom 

The parent form of this multiple document interface (MDI) form is closing.

left 

The user is closing the form through the user interface (UI), for example by clicking the Close button on the form window, selecting Close from the window's control menu, or pressing ALT+F4.

right 

The Microsoft Windows Task Manager is closing the application.

◆ appearance

#include <xtd.forms/include/xtd/forms/appearance.h>

Specifies the appearance of a control.

Namespace
xtd::forms
Library
xtd.forms
Remarks
Use the members of this enumeration in controls that provide the Appearance property to set its value.
Enumerator
normal 

The default appearance defined by the control class.

button 

The appearance of a button.

switch_button 

The appearance of a switch button.

◆ arrange_direction

#include <xtd.forms/include/xtd/forms/arrange_direction.h>

Specifies the direction the system uses to arrange minimized windows.

Namespace
xtd::forms
Library
xtd.forms
Remarks
This enumeration has a flags attribute attribute that allows a bitwise combination of its member values.
This enumeration is used by the arrange_direction property of the system_information class.
Enumerator
down 

Arranges vertically, from top to bottom.

left 

Arranges horizontally, from left to right.

right 

Arranges horizontally, from right to left.

up 

Arranges vertically, from bottom to top.

◆ arrange_starting_position

#include <xtd.forms/include/xtd/forms/arrange_starting_position.h>

Specifies the starting position that the system uses to arrange minimized windows.

Namespace
xtd::forms
Library
xtd.forms
Remarks
This enumeration has a flags attribute attribute that allows a bitwise combination of its member values.
This enumeration is used by the arrange_starting_position property of the system_information class.
Enumerator
bottom_left 

Starts at the lower-left corner of the screen, which is the default position.

bottom_right 

Starts at the lower-right corner of the screen.

top_left 

Starts at the upper-left corner of the screen.

top_right 

Starts at the upper-right corner of the screen.

hide 

Hides minimized windows by moving them off the visible area of the screen.

◆ auto_size_mode

#include <xtd.forms/include/xtd/forms/auto_size_mode.h>

Specifies how a control will behave when its auto_size property is enabled.

Namespace
xtd::forms
Library
xtd.forms
Remarks
Use the members of this enumeration to set the border style for controls that have a changeable border.
Enumerator
grow_and_shrink 

The control grows or shrinks to fit its contents. The control cannot be resized manually.

grow_only 

The control grows as much as necessary to fit its contents but does not shrink smaller than the value of its size property. The form can be resized, but cannot be made so small that any of its contained controls are hidden.

◆ boot_mode

enum xtd::forms::boot_mode
strong

#include <xtd.forms/include/xtd/forms/boot_mode.h>

Specifies the mode to start the computer in.

Namespace
xtd::forms
Library
xtd::forms
Remarks
This enumeration defines identifiers that represent the standard operating system startup modes.
This enumeration is used by the boot_mode property of the system_information class.
The normal boot mode is the standard system startup mode. The fail_safe boot mode is also called safe mode. The fail_safe_with_network boot mode is also called safe mode with networking.
Enumerator
normal 

Starts the computer in standard mode.

fail_safe 

Starts the computer by using only the basic files and drivers.

fail_safe_with_network 

Starts the computer by using the basic files, drivers and the services and drivers necessary to start networking.

◆ border_style

#include <xtd.forms/include/xtd/forms/border_style.h>

Specifies the border style for a control.

Namespace
xtd::forms
Library
xtd.forms
Remarks
Use the members of this enumeration to set the border style for controls that have a changeable border.
Enumerator
none 

No border.

fixed_single 

A single-line border.

fixed_3d 

A three-dimensional border.

◆ bounds_specified

#include <xtd.forms/include/xtd/forms/bounds_specified.h>

Specifies the bounds of the control to use when defining a control's size and position. This enumeration has a flags attribute that allows a bitwise combination of its member values.

Namespace
xtd::forms
Library
xtd.forms
Remarks
Use the members of this enumeration when calling the set_bounds_core and set_bounds methods of the control class.
Enumerator
none 

No border.s.

Specifies that the left edge of the control is defined.

Specifies that the top edge of the control is defined.

location 

Specifies that both the x and y coordinates of the control are defined.

width 

Specifies that the width of the control is defined.

height 

Specifies that the height of the control is defined.

size 

Specifies that both the width and height property values of the control are defined.

all 

Specifies that both the location and size property values are defined.

◆ button_state

#include <xtd.forms/include/xtd/forms/button_state.h>

Specifies the appearance of a button.

Namespace
xtd::forms
Library
xtd.forms
Remarks
This enumeration has a flags attribute that allows a bitwise combination of its member values.
This enumeration represents the different states of a button. The default state is normal.
Enumerator
normal 

The button has its normal appearance (three-dimensional).

inactive 

The button is inactive (grayed).

pushed 

The button appears pressed.

checked 

The button has a checked or latched appearance. Use this appearance to show that a toggle button has been pressed.

flat 

The button has a flat, two-dimensional appearance.

all 

All flags except normal are set.

◆ character_casing

#include <xtd.forms/include/xtd/forms/character_casing.h>

Specifies the case of characters in a text_box control.

Namespace
xtd::forms
Library
xtd.forms
Remarks
Use the members of this enumeration to set the value of the character_casing property of the text_box control.
Enumerator
normal 

The case of characters is left unchanged.

upper 

Converts all characters to uppercase.

lower 

Converts all characters to lowercase.

◆ check_box_state

#include <xtd.forms/include/xtd/forms/visual_styles/check_box_state.h>

Specifies the visual state of a check box that is drawn with visual styles.

Namespace
xtd::forms::visual_style
Library
xtd.forms
Remarks
The check_box_state values correspond to the states of the visual_style_element objects exposed by the visual_style_element::check_box::check_box class. The check_box_state values are also used as an argument in the check_box_renderer.draw_check_box method.
Enumerator
unchecked_normal 

The check box is unchecked.

unchecked_hot 

The check box is unchecked and hot.

unchecked_pressed 

The check box is unchecked and pressed.

unchecked_disabled 

The check box is unchecked and disabled.

checked_normal 

The check box is checked.

checked_hot 

The check box is checked and hot.

checked_pressed 

The check box is checked and pressed.

checked_disabled 

The check box is checked and disabled.

mixed_normal 

The check box is three-state.

mixed_hot 

The check box is three-state and hot.

mixed_pressed 

The check box is three-state and pressed.

mixed_disabled 

The check box is three-state and disabled.

◆ check_state

#include <xtd.forms/include/xtd/forms/check_state.h>

Specifies the state of a control, such as a check box, that can be checked, unchecked, or set to an indeterminate state.

Namespace
xtd::forms
Library
xtd.forms
Remarks
Multiple methods in check_box, checked_list_box, and item_check_event_args use this enumeration.
Note
Use an indeterminately checked control when you do not want to set a default value.
Enumerator
unchecked 

The control is unchecked.

checked 

The control is checked.

indeterminate 

The control is indeterminate. An indeterminate control generally has a shaded appearance.

◆ close_reason

#include <xtd.forms/include/xtd/forms/close_reason.h>

Specifies the reason that a form was closed.

Namespace
xtd::forms
Library
xtd.forms
Remarks
The form_closing and form_closed events are raised when a form is closed, either through user action or programmatically. Handlers for these events receive parameters of type form_closing_event_args and form_closed_event_args, respectively. Both of these event argument classes use the close_reason enumeration.
Enumerator
none 

The cause of the closure was not defined or could not be determined.

windows_shut_down 

The operating system is closing all applications before shutting down.

mdi_form_closing 

The parent form of this multiple document interface (MDI) form is closing.

user_closing 

The user is closing the form through the user interface (UI), for example by clicking the Close button on the form window, selecting Close from the window's control menu, or pressing ALT+F4.

task_manager_closing 

The Microsoft Windows Task Manager is closing the application.

form_owner_closing 

The owner form is closing.

application_exit_call 

The Exit method of the Application class was invoked.

◆ color_box_styles

#include <xtd.forms/include/xtd/forms/color_box_styles.h>

Specifies constants defining which color_box styles is used.

Namespace
xtd::forms
Library
xtd.forms
Remarks
This enumeration is used by the color_box class.
Enumerator
none 

The cause of the closure was not defined or could not be determined.

alpha_color 

The color box shows alpha values and an opacity selector (slider).

allow_full_open 

The user can use the dialog box to define custom colors.

any_color 

The dialog box displays all available colors in the set of basic colors.

full_open 

The controls used to create custom colors are visible when the dialog box is opened.

show_help 

A Help button appears in the color dialog box.

solid_color_only 

The dialog box will restrict users to selecting solid colors only.

◆ combo_box_style

#include <xtd.forms/include/xtd/forms/combo_box_style.h>

Specifies the combo_box style.

Namespace
xtd::forms
Library
xtd.forms
Remarks
When a control is docked to an edge of its container, it is always positioned flush against that edge when the container is resized. If more than one control is docked to an edge, the controls appear side by side according to their z-order; controls higher in the z-order are positioned farther from the container's edge.
If left, right, top, or bottom is selected, the specified and opposite edges of the control are resized to the size of the containing control's corresponding edges. If fill is selected, all four sides of the control are resized to match the containing control's edges.
The drop_down_style property specifies whether the list is always displayed or whether the list is displayed in a drop-down. The drop_down_style property also specifies whether the text portion can be edited.
Enumerator
simple 

Specifies that the list is always visible and that the text portion is editable. This means that the user can enter a new value and is not limited to selecting an existing value in the list.

drop_down 

Specifies that the list is displayed by clicking the down arrow and that the text portion is editable. This means that the user can enter a new value and is not limited to selecting an existing value in the list. When using this setting, the append value of auto_complete_mode works the same as the suggest_append value. This is the default style.

drop_down_list 

Specifies that the list is displayed by clicking the down arrow and that the text portion is not editable. This means that the user cannot enter a new value. Only values already in the list can be selected. The list displays only if auto_complete_mode is suggest or suggest_append.

◆ content_alignment

#include <xtd.forms/include/xtd/forms/content_alignment.h>

Specifies alignment of content on the drawing surface.

Namespace
xtd::forms
Library
xtd.forms
Enumerator
top_left 

Content is vertically aligned at the top, and horizontally aligned on the left.

top_center 

Content is vertically aligned at the top, and horizontally aligned at the center.

top_right 

Content is vertically aligned at the top, and horizontally aligned on the right.

middle_left 

Content is vertically aligned in the middle, and horizontally aligned on the left.

middle_center 

Content is vertically aligned at the middle, and horizontally aligned at the center.

middle_right 

Content is vertically aligned at the middle, and horizontally aligned on the right.

bottom_left 

Content is vertically aligned in the bottom, and horizontally aligned on the left.

bottom_center 

Content is vertically aligned at the bottom, and horizontally aligned at the center.

bottom_right 

Content is vertically aligned at the bottom, and horizontally aligned on the right.

◆ control_styles

#include <xtd.forms/include/xtd/forms/control_styles.h>

Specifies the style and behavior of a control.

Namespace
xtd::forms
Library
xtd.forms
Remarks
This enumeration has a flags attribute that allows a bitwise combination of its member values.
Controls use this enumeration in various properties and methods to specify functionality. A control can enable a style by calling the set_style method and passing in the appropriate control_styles bit (or bits) and the bool value to set the bit(s) to. For example, the following line code would enable double-buffering.
my_control.set_style(control_styles::user_paint | control_styles::all_painting_in_wm_paint | double_buffer, true);
@ user_paint
If true, the control paints itself rather than the operating system doing so. If false,...
@ all_painting_in_wm_paint
If true, the control ignores the window message WM_ERASEBKGND to reduce flicker. This style should on...
If the all_painting_in_wm_paint bit is set to true, the window message WM_ERASEBKGND is ignored, and both on_paint_background and on_paint methods are called directly from the window message WM_PAINT. This generally reduces flicker unless other controls send the window message WM_ERASEBKGND to the control. You might send the window message WM_ERASEBKGRND to achieve a pseudo-transparent effect similar to supports_transparent_back_color; for example, a tool_bar with flat appearance does this.
To fully enable double-buffering, you can set the optimized_double_buffer and all_painting_in_wm_paint bits to true. However the preferred method for enabling double buffering, which yields the same result, is to set the double_buffered property for the control to true.
If the supports_transparent_back_color bit is set to true, and the back_color is set to a color whose alpha component is less than 255, on_paint_background will simulate transparency by asking its parent control to paint the background. This is not true transparency.
Note
If there is another control between the control and its parent, the current control will not show the control in the middle.
Remarks
When the user_mouse bit is set to true, the following methods are still called: control::on_mouse_down, control::on_mouse_up, control::on_mouse_enter, control::on_mouse_move, control::on_mouse_hover, control::on_mouse_leave, and control::on_mouse_wheel.
When the control is clicked, if the standard_click bit is set to true the control::on_click method is called and it raises the control::click event. When the control is double-clicked, and both the standard_click and standard_double_click bits are set to true, the click is passed on to the double_click event. Then the Control::on_double_click method is called and it raises the control::double_click event. However, the control can call on_click or on_double_click directly regardless of the standard_click and standard_double_click bit values. For more information on control click and double click behaviors, see the control::click and control::double_click topics.
When the use_text_for_accessibility bit is set and there is a value in the control's text property, the value of that control's text property determines the control's default active accessibility name and shortcut key. Otherwise, the text of the preceding label control will be used instead. This style is set by default. Certain built-in control types, such as text_box and combo_box, reset this style so that the text property of those controls will not be used by active accessibility.
Enumerator
none 

No control style..

container_control 

If true, the control is a container-like control.

user_paint 

If true, the control paints itself rather than the operating system doing so. If false, the paint event is not raised. This style only applies to classes derived from control.

opaque 

If true, the control is drawn opaque and the background is not painted.

resize_redraw 

If true, the control is redrawn when it is resized.

fixed_width 

If true, the control has a fixed width when auto-scaled. For example, if a layout operation attempts to rescale the control to accommodate a new font, the control's width remains unchanged.

fixed_height 

If true, the control has a fixed height when auto-scaled. For example, if a layout operation attempts to rescale the control to accommodate a new font, the control's height remains unchanged.

standard_click 

If true, the control implements the standard click behavior.

selectable 

If true, the control can receive focus.

user_mouse 

If true, the control does its own mouse processing, and mouse events are not handled by the operating system.

supports_transparent_back_color 

If true, the control accepts a BackColor with an alpha component of less than 255 to simulate transparency. Transparency will be simulated only if the UserPaint bit is set to true and the parent control is derived from Control.

standard_double_click 

If true, the control implements the standard double_click behavior. This style is ignored if the standard_click bit is not set to true.

all_painting_in_wm_paint 

If true, the control ignores the window message WM_ERASEBKGND to reduce flicker. This style should only be applied if the user_paint bit is set to true.

cache_text 

If true, the control keeps a copy of the text rather than getting it from the handle each time it is needed. This style defaults to false. This behavior improves performance, but makes it difficult to keep the text synchronized.

enable_notify_message 

If true, the on_notify_message(message&) method is called for every message sent to the control's wnd_proc(message&). This style defaults to false. enable_notify_message does not work in partial trust.

double_buffer 

If true, drawing is performed in a buffer, and after it completes, the result is output to the screen. Double-buffering prevents flicker caused by the redrawing of the control. If you set double_buffer to true, you should also set user_paint and all_painting_in_wm_paint to true.

optimized_double_buffer 

If true, the control is first drawn to a buffer rather than directly to the screen, which can reduce flicker. If you set this property to true, you should also set the all_painting_in_wm_paint to true.

use_text_for_accessibility 

Specifies that the value of the control's text property, if set, determines the control's default active accessibility name and shortcut key.

◆ date_time_picker_format

#include <xtd.forms/include/xtd/forms/date_time_picker_format.h>

Specifies the date and time format the date_time_picker control displays.

Namespace
xtd::forms
Library
xtd.forms
Remarks
This enumeration is used by members such as date_time_picker::format.
Enumerator
long_format 

The date_time_picker control displays the date/time value in the long date format set by the user's operating system.

short_format 

The date_time_picker control displays the date/time value in the short date format set by the user's operating system.

time 

The date_time_picker control displays the date/time value in the time format set by the user's operating system.

custom 

The date_time_picker control displays the date/time value in a custom format.

◆ dialog_result

#include <xtd.forms/include/xtd/forms/dialog_result.h>

Specifies identifiers to indicate the return value of a dialog box.

Namespace
xtd::forms
Library
xtd.forms
Remarks
The xtd::forms::button::dialog_result property and the xtd::forms::form::show_dialog method use this enumeration.
Examples
The following code example demonstrates how to display a MessageBox with the options supported by this overload of Show. After verifying that a string variable, ServerName, is empty, the example displays a MessageBox, offering the user the option to cancel the operation. If the Show method's return value evaluates to Yes, the form that displayed the MessageBox is closed.
void validate_user_entry() {
// Checks the value of the text.
if (server_name.text().size() == 0) {
// Initializes the variables to pass to the MessageBox.Show method.
string message = "You did not enter a server name. Cancel this operation?";
string caption = "No Server Name Specified";
message_box_buttons buttons = message_box_buttons::yes_no;
dialog_result result;
// Displays the MessageBox.
result = message_box::show(*this, message, caption, buttons);
if (result == dialog_result::yes) {
// Closes the parent form.
close();
}
}
}
static dialog_result show()
Displays a message box.
Definition: message_box.h:86
dialog_result
Specifies identifiers to indicate the return value of a dialog box.
Definition: dialog_result.h:39
message_dialog_buttons message_box_buttons
Specifies constants defining which buttons to display on a message_box.
Definition: message_box_buttons.h:18
@ yes
The dialog box return value is Yes (usually sent from a button labeled Yes).
Enumerator
none 

Nothing is returned from the dialog box. This means that the modal dialog continues running.

ok 

The dialog box return value is OK (usually sent from a button labeled OK).

cancel 

The dialog box return value is Cancel (usually sent from a button labeled Cancel).

abort 

The dialog box return value is Abort (usually sent from a button labeled Abort).

retry 

The dialog box return value is Retry (usually sent from a button labeled Retry).

ignore 

The dialog box return value is Ignore (usually sent from a button labeled Ignore).

yes 

The dialog box return value is Yes (usually sent from a button labeled Yes).

no 

The dialog box return value is No (usually sent from a button labeled No).

◆ dialog_style

#include <xtd.forms/include/xtd/forms/dialog_style.h>

Specifies the style of a dialog.

Namespace
xtd::forms
Library
xtd.forms
Enumerator
standard 

Standard style dialog.

system 

System style dialog.

◆ dock_style

#include <xtd.forms/include/xtd/forms/dock_style.h>

Specifies the position and manner in which a control is docked.

Namespace
xtd::forms
Library
xtd.forms
Remarks
When a control is docked to an edge of its container, it is always positioned flush against that edge when the container is resized. If more than one control is docked to an edge, the controls appear side by side according to their z-order; controls higher in the z-order are positioned farther from the container's edge.
If left, right, top, or bottom is selected, the specified and opposite edges of the control are resized to the size of the containing control's corresponding edges. If fill is selected, all four sides of the control are resized to match the containing control's edges.
Enumerator
none 

The control is not docked.

top 

The control's top edge is docked to the top of its containing control.

bottom 

The control's bottom edge is docked to the bottom of its containing control.

left 

The control's left edge is docked to the left edge of its containing control.

right 

The control's right edge is docked to the right edge of its containing control.

fill 

All the control's edges are docked to the all edges of its containing control and sized appropriately.

◆ dot_matrix_style

#include <xtd.forms/include/xtd/forms/dot_matrix_style.h>

Represent dot matrix style used by dot_matrix_display control.

Namespace
xtd::forms
Library
xtd.forms
Enumerator
round 

Round dot matrix style.

square 

Square dot matrix style.

standard 

Standard (or round) dot matrix style.

◆ flat_style

#include <xtd.forms/include/xtd/forms/flat_style.h>

Specifies the appearance of a control.

Namespace
xtd::forms
Library
xtd.forms
Remarks
This enumeration is used by members such as button_base::flat_style, group_box::flat_style, and label::flat_style.
In the case of the popup style button, this enumeration controls some behavior as well as appearance. The popup style control initially appears flat until the mouse pointer moves over it. When the mouse pointer moves over the popup control, it appears as a standard style control until the mouse pointer is moved off of it again.
If the system style is used, the appearance of the control is determined by the user's operating system and the following property values will be ignored: control_background_image, image_align, image, image_index, image_list, and text_align. In addition, the control.back_color property will be ignored for button controls. If supported, users can change the appearance of controls by adjusting the appearance settings of their operating system.
Enumerator
flat 

The control appears flat.

popup 

A control appears flat until the mouse pointer moves over it, at which point it appears three-dimensional.

standard 

The control appears three-dimensional.

system 

The appearance of the control is determined by the user's operating system.

◆ form_border_style

#include <xtd.forms/include/xtd/forms/form_border_style.h>

Specifies the border styles for a form.

Namespace
xtd::forms
Library
xtd.forms
Remarks
This enumeration is used by the form class. It represents the different styles of the form. The default style is sizable.
Enumerator
none 

No border.

fixed_single 

A fixed, single-line border.

fixed_3d 

A fixed, three-dimensional border.

fixed_dialog 

A thick, fixed dialog-style border.

sizable 

A resizable border.

fixed_tool_window 

A tool window border that is not resizable. A tool window does not appear in the taskbar or in the window that appears when the user presses ALT+TAB. Although forms that specify fixed_tool_window typically are not shown in the taskbar, you must also ensure that the show_in_taskbar property is set to false, since its default value is true.

sizable_tool_window 

A resizable tool window border. A tool window does not appear in the taskbar or in the window that appears when the user presses ALT+TAB.

◆ form_start_position

#include <xtd.forms/include/xtd/forms/form_start_position.h>

Specifies the initial position of a form.

Namespace
xtd::forms
Library
xtd.forms
Remarks
This enumeration is used by the start_position property of the form class. It represents the different start positions of the form. The default start position is windows_default_location.
Enumerator
manual 

The position of the form is determined by the Location property.

center_screen 

The form is centered on the current display, and has the dimensions specified in the form's size.

windows_default_location 

The form is positioned at the Windows default location and has the dimensions specified in the form's size.

windows_default_bounds 

The form is positioned at the Windows default location and has the bounds determined by Windows default.

center_parent 

The form is centered within the bounds of its parent form.

◆ form_window_state

#include <xtd.forms/include/xtd/forms/form_window_state.h>

Specifies how a form window is displayed.

Namespace
xtd::forms
Library
xtd.forms
Remarks
This enumeration is used by the form class. It represents the different states of the form. The default state is normal.
Enumerator
normal 

A default sized window.

minimized 

A minimized window.

maximized 

A maximized window.

full_screen 

A full screen window.

◆ image_layout

#include <xtd.forms/include/xtd/forms/image_layout.h>

Specifies the position of the image on the control.

Namespace
xtd::forms
Library
xtd.forms
Enumerator
none 

The image is left-aligned at the top across the control's client rectangle.

tile 

The image is tiled across the control's client rectangle.

center 

The image is centered within the control's client rectangle.

stretch 

The image is stretched across the control's client rectangle.

zoom 

The image is enlarged within the control's client rectangle.

◆ input_box_style

#include <xtd.forms/include/xtd/forms/input_box_style.h>

Specifies constants defining which input_box style is used.

Namespace
xtd::forms
Library
xtd.forms
Remarks
This enumeration is used by the input_box class.
Enumerator
normal 

Single line text box.

multiline 

Multiline text box.

password 

Single line text box with password characters.

◆ keys

enum xtd::forms::keys : long long
strong

#include <xtd.forms/include/xtd/forms/keys.h>

Specifies key codes and modifiers.

Namespace
xtd::forms
Library
xtd.forms
Remarks
The keys class contains constants for processing keyboard input. The members of the keys enumeration consist of a key code and a set of modifiers combined into a single integer value. In the Win32 application programming interface (API) a key value has two halves, with the high-order bits containing the key code (which is the same as a Windows virtual key code), and the low-order bits representing key modifiers such as the SHIFT, CONTROL, and ALT keys.
Warning
Do not use the values in this enumeration for combined bitwise operations. The values in the enumeration are not mutually exclusive.
Note
This enumeration provides no way to test whether the CAPS LOCK or NUM LOCK keys are currently activated. You can use one of the following techniques to determine if these keys are activated:
  • Call the IsKeyLocked method of the Control class.
  • For finer control, use the Win32 API functions GetKeyState, GetAsyncKeyState, or GetKeyboardState defined in user32.dll, to do this. For more information about calling native functions, see Consuming Unmanaged DLL Functions.
Remarks
The following table shows the key code values represented by two enumerated values, representing both the general original equipment manufacturer (OEM) keys and the more specific U.S.-keyboard associations.
Hexadecimal value  U.S. keyboard General OEM
BA oem_semicolon oem1
 BF  oem_question oem2
C0 oem_tilde oem3
 DB  oem_open_brackets oem4
 DC  oem_pipe oem5
DD  oem_close_brackets oem6
DE  oem_quotes oem7
E2  oem_backslash oem102
Examples
The following code example uses the KeyDown event to determine the type of character entered into the control.
// bool flag used to determine when a character other than a number is entered.
bool non_number_entered = false;
// Handle the KeyDown event to determine the type of character entered into the control.
void text_box1_key_down(object& sender, key_event_args& e) {
// Initialize the flag to false.
non_number_entered = false;
// Determine whether the keystroke is a number from the top of the keyboard.
if (e.key_code() < keys::d0 || e.key_code() > keys::d9) {
// Determine whether the keystroke is a number from the keypad.
if (e.key_code() < keys::num_pad0 || e.key_code() > keys::num_pad9) {
// Determine whether the keystroke is a backspace.
if(e.key_code() != keys::back) {
// A non-numerical keystroke was pressed.
// Set the flag to true and evaluate in key_press event.
non_number_entered = true;
}
}
}
//If shift key was pressed, it's not a number.
if (control::modifier_keys() == keys::Shift) {
non_number_entered = true;
}
}
// This event occurs after the KeyDown event and can be used to prevent
// characters from entering the control.
void text_box1_key_press(object& sender, key_press_event_args& e) {
// Check for the flag being set in the key_down event.
if (non_number_entered == true) {
// Stop the character from being entered into the control since it is non-numerical.
e.handled(true);
}
}
static forms::keys modifier_keys()
Gets a value indicating which of the modifier keys (SHIFT, CTRL, and ALT) is in a pressed state.
Definition: control.h:565
@ e
The E key.
@ d0
The 0 key.
@ back
The BACK key.
@ num_pad9
The 9 key on the numeric keypad.
@ d9
The 9 key.
@ num_pad0
The 0 key on the numeric keypad.
Enumerator
none 

No key pressed.

lbutton 

The left mouse button.

rbutton 

The right mouse button.

cancel 

The CANCEL key.

mbutton 

The middle mouse button (three-button mouse).

xbutton1 

The first x mouse button (five-button mouse).

xbutton2 

The second x mouse button (five-button mouse).

back 

The BACK key.

tab 

The TAB key.

line_feed 

The LINEFEED key.

clear 

The CLEAR key.

ret 

The RETURN key.

enter 

The ENTER key.

shift_key 

The SHIFT key.

control_key 

The CTRL key.

menu 

The ALT key.

pause 

The PAUSE key.

caps_lock 

The CAPS LOCK key.

capital 

The CAPS LOCK key.

kana_mode 

The IME Kana mode key.

hanguel_mode 

@breif The IME Hanguel mode key. (maintained for compatibility; use HangulMode)

hangul_mode 

The IME Hangul mode key.

junja_mode 

The IME Junja mode key.

final_mode 

The IME Final mode key.

kanji_mode 

The IME Kanji mode key.

hanja_mode 

The IME Hanja mode key.

escape 

The ESC key.

ime_convert 

The IME convert key.

ime_nonconvert 

The IME nonconvert key.

ime_accept 

The IME accept key.

ime_mode_change 

The IME mode change key.

space 

The SPACEBAR key.

page_up 

The PAGE UP key.

prior 

The PAGE UP key.

page_down 

The PAGE DOWN key.

next 

The PAGE DOWN key.

end 

The END key.

home 

The HOME key.

left 

The LEFT key.

up 

The UP key.

right 

The RIGHT key.

down 

The DOWN key.

select 

The SELECT key.

print 

The PRINT key.

execute 

The EXECUTE key.

print_screen 

The PRINT SCREEN key.

snapshot 

The PRINT SCREEN key.

insert 

The INSERT key.

del 

The DEL key.

help 

The HELP key.

d0 

The 0 key.

d1 

The 1 key.

d2 

The 2 key.

d3 

The 3 key.

d4 

The 4 key.

d5 

The 5 key.

d6 

The 6 key.

d7 

The 7 key.

d8 

The 8 key.

d9 

The 9 key.

The A key.

The B key.

The C key.

The D key.

The E key.

The F key.

The G key.

The H key.

The I key.

The J key.

The K key.

The L key.

The M key.

The N key.

The O key.

The P key.

The Q key.

The R key.

The S key.

The T key.

The U key.

The V key.

The W key.

The X key.

The Y key.

The Z key.

lwin 

The left Windows logo key (Microsoft Natural Keyboard).

rwin 

The right Windows logo key (Microsoft Natural Keyboard).

apps 

The application key (Microsoft Natural Keyboard).

sleep 

The computer sleep key.

num_pad0 

The 0 key on the numeric keypad.

num_pad1 

The 1 key on the numeric keypad.

num_pad2 

The 2 key on the numeric keypad.

num_pad3 

The 3 key on the numeric keypad.

num_pad4 

The 4 key on the numeric keypad.

num_pad5 

The 5 key on the numeric keypad.

num_pad6 

The 6 key on the numeric keypad.

num_pad7 

The 7 key on the numeric keypad.

num_pad8 

The 8 key on the numeric keypad.

num_pad9 

The 9 key on the numeric keypad.

multiply 

The multiply key.

add 

The add key.

separator 

The separator key.

subtract 

The subtract key.

decimal 

The decimal key.

divide 

The divide key.

f1 

The F1 key.

f2 

The F2 key.

f3 

The F3 key.

f4 

The F4 key.

f5 

The F5 key.

f6 

The F6 key.

f7 

The F7 key.

f8 

The F8 key.

f9 

The F9 key.

f10 

The F10 key.

f11 

The F11 key.

f12 

The F12 key.

f13 

The F13 key.

f14 

The F14 key.

f15 

The F15 key.

f16 

The F16 key.

f17 

The F17 key.

f18 

The F18 key.

f19 

The F19 key.

f20 

The F20 key.

f21 

The F21 key.

f22 

The F22 key.

f23 

The F23 key.

f24 

The F24 key.

num_lock 

The NUM LOCK key.

scroll 

The SCROLL LOCK key.

lshift_key 

The left SHIFT key.

rshift_key 

The right SHIFT key.

lcontrol_key 

The left CTRL key.

rcontrol_key 

The right CTRL key.

lmenu 

The left ALT key.

rmenu 

The right ALT key.

browser_back 

The browser back key.

browser_forward 

The browser forward key.

browser_refresh 

The browser refresh key.

browser_stop 

The browser stop key.

browser_search 

The browser search key.

browser_favorites 

The browser favorites key.

browser_home 

The browser home key.

volume_mute 

The volume mute key.

volume_down 

The volume down key.

volume_up 

The volume up key.

media_next_track 

The media next track key.

media_previous_track 

The media previous track key.

media_stop 

The media stop key.

media_play_pause 

The media play pause key.

launch_mail 

The launch mail key.

select_media 

The select media key.

launch_application1 

The start application one key.

launch_application2 

The start application two key.

oem1 

The OEM 1 key.

oem_semicolon 

The OEM Semicolon key on a US standard keyboard.

oem_plus 

The OEM plus key on any country/region keyboard.

oem_comma 

The OEM comma key on any country/region keyboard.

oem_minus 

The OEM minus key on any country/region keyboard.

oem_period 

The OEM period key on any country/region keyboard.

oem2 

The OEM 2 key.

oem_question 

The OEM question mark key on a US standard keyboard.

oem3 

The OEM 3 key.

oem_tilde 

The OEM tilde key on a US standard keyboard.

oem4 

The OEM 4 key.

oem_open_brackets 

The OEM open bracket key on a US standard keyboard.

oem5 

The OEM 5 key.

oem_pipe 

The OEM pipe key on a US standard keyboard.

oem6 

The OEM 6 key.

oem_close_brackets 

The OEM close bracket key on a US standard keyboard.

oem7 

The OEM 7 key.

oem_quotes 

The OEM singled/double quote key on a US standard keyboard.

oem8 

The OEM 8 key.

oem102 

The OEM 102 key.

oem_backslash 

The OEM angle bracket or backslash key on the RT 102 key keyboard.

process_key 

The PROCESS KEY key.

packet 

Used to pass Unicode characters as if they were keystrokes. The Packet key value is the low word of a 32-bit virtual-key value used for non-keyboard input methods.

attn 

The ATTN key.

crsel 

The CRSEL key.

exsel 

The EXSEL key.

erase_eof 

The ERASE EOF key.

play 

The PLAY key.

zoom 

The ZOOM key.

no_name 

A constant reserved for future use.

pa1 

The PA1 key.

oem_clear 

The CLEAR key.

command_key 

The CMD key.

lcommand_key 

The left CMD key.

rcommand_key 

The right CMD key.

function_key 

The FUNCTION key.

shift 

The SHIFt modifier key.

control 

The CTRL modifier key.

alt 

The ALT modifier key.

command 

The CMD modifier key.

meta 

The METTA modifier key.

function 

The FUNCTION modifier key.

key_code 

The bitmask to extract a key code from a key value.

modifiers 

The bitmask to extract modifiers from a key value.

◆ known_themed_color

#include <xtd.forms/include/xtd/forms/known_themed_color.h>

Specifies the known system colors.

Namespace
xtd::forms
Library
xtd.forms
See also
xtd::drawing::color
Enumerator
accent 

The system-defined color of the accent color (macos specific. On other platform is same as menu_highlight).

accent_text 

The system-defined color of the accent text color (macos specific. On other platform is same as highlight_text).

active_border 

The system-defined color of the active window's border.

active_caption 

The system-defined color of the background of the active window's title bar.

active_caption_text 

The system-defined color of the text in the active window's title bar.

app_workspace 

The system-defined color of the application workspace. The application workspace is the area in a multiple-document view that is not being occupied by documents.

button_face 

The system-defined face color of a 3-D element.

button_highlight 

The system-defined color that is the highlight color of a 3-D element. This color is applied to parts of a 3-D element that face the light source.

button_shadow 

The system-defined color that is the shadow color of a 3-D element. This color is applied to parts of a 3-D element that face away from the light source.

control 

The system-defined face color of a 3-D element.

control_dark 

The system-defined shadow color of a 3-D element. The shadow color is applied to parts of a 3-D element that face away from the light source.

control_dark_dark 

The system-defined color that is the dark shadow color of a 3-D element. The dark shadow color is applied to the parts of a 3-D element that are the darkest color.

control_light 

The system-defined color that is the light color of a 3-D element. The light color is applied to parts of a 3-D element that face the light source.

control_light_light 

The system-defined highlight color of a 3-D element. The highlight color is applied to the parts of a 3-D element that are the lightest color.

control_text 

The system-defined color of text in a 3-D element.

desktop 

The system-defined color of the desktop.

gradient_active_caption 

The system-defined color of the lightest color in the color gradient of an active window's title bar.

gradient_inactive_caption 

The system-defined color of the lightest color in the color gradient of an inactive window's title bar.

gray_text 

The system-defined color of dimmed text. Items in a list that are disabled are displayed in dimmed text.

highlight 

The system-defined color of the background of selected items. This includes selected menu items as well as selected text.

highlight_text 

The system-defined color of the text of selected items.

hot_track 

The system-defined color used to designate a hot-tracked item. Single-clicking a hot-tracked item executes the item.

inactive_border 

The system-defined color of an inactive window's border.

inactive_caption 

The system-defined color of the background of an inactive window's title bar.

inactive_caption_text 

The system-defined color of the text in an inactive window's title bar.

info 

The system-defined color of the background of a ToolTip.

info_text 

The system-defined color of the text of a ToolTip.

menu 

The system-defined color of a menu's background.

menu_bar 

The system-defined color of the background of a menu bar.

menu_highlight 

The system-defined color used to highlight menu items when the menu appears as a flat menu.

menu_text 

The system-defined color of a menu's text.

scroll_bar 

The system-defined color of the background of a scroll bar.

text_box 

The system-defined color of the accent color (macos specific. On other platform is same as window).

text_box_text 

The system-defined color of the accent text color (macos specific. On other platform is same as window_text).

window 

The system-defined color of the background in the client area of a window.

window_frame 

The system-defined color of a window frame.

window_text 

The system-defined color of the text in the client area of a window.

◆ lcd_style

enum xtd::forms::lcd_style
strong

#include <xtd.forms/include/xtd/forms/lcd_style.h>

Represent lcd label style used by lcd_label control.

Namespace
xtd::forms
Library
xtd.forms
Enumerator
seven_segment_display 

Seven segment display style.

nine_segment_display 

Nine segment display style.

fourteen_segment_display 

Fourteen segment display style.

sixteen_segment_display 

Sixteen segment display style.

dot_matrix_display 

Dot matrix display style.

◆ loading_indicator_style

#include <xtd.forms/include/xtd/forms/loading_indicator_style.h>

Specifies the appearance of a loading indicator control.

Namespace
xtd::forms
Library
xtd.forms
Remarks
If the system style is used, the appearance of the control is determined by the user's operating system and the following property values will be ignored: control_background_image, image_align, image, image_index, image_list, and text_align. In addition, the control.back_color property will be ignored for button controls. If supported, users can change the appearance of controls by adjusting the appearance settings of their operating system.
Enumerator
dots 

The control appears with dots style.

standard 

The control appears with standard style.

system 

The appearance of the control is determined by the user's operating system.

◆ menu_item_kind

#include <xtd.forms/include/xtd/forms/menu_item_kind.h>

Represent menu item kind used by xtd::forms::menu_item component.

Namespace
xtd::forms
Library
xtd.forms
Enumerator
normal 

Normal menu item.

check 

Check menu item.

radio 

Radio menu item.

drop_down 

Drop down menu item.

separator 

Separator menu item.

◆ message_dialog_buttons

#include <xtd.forms/include/xtd/forms/message_dialog_buttons.h>

Specifies constants defining which buttons to display on a message_box.

Namespace
xtd::forms
Library
xtd.forms
Remarks
This enumeration is used by the message_box class.
Enumerator
ok 

The message box contains an OK button.

ok_cancel 

The message box contains OK and Cancel buttons.

abort_retry_ignore 

&brief The message box contains Abort, Retry, and Ignore buttons

yes_no_cancel 

The message box contains Yes, No, and Cancel buttons.

yes_no 

The message box contains Yes and No buttons.

retry_cancel 

The message box contains Retry and Cancel buttons.

◆ message_dialog_default_button

#include <xtd.forms/include/xtd/forms/message_dialog_default_button.h>

Specifies constants defining the default button on a message_box.

Namespace
xtd::forms
Library
xtd.forms
Remarks
This enumeration is used by the message_box class.
Enumerator
button1 

The first button on the message box is the default button.

button2 

The second button on the message box is the default button.

button3 

The third button on the message box is the default button.

◆ message_dialog_icon

#include <xtd.forms/include/xtd/forms/message_dialog_icon.h>

Specifies constants defining which information to display.

Namespace
xtd::forms
Library
xtd.forms
Remarks
This enumeration is used by the message_box class. The description of each member of this enumeration contains a typical representation of the symbol. The actual graphic displayed is a function of the operating system constants. In current implementations there are four unique symbols with multiple values assigned to them.
Enumerator
none 

The message box contain no symbols.

hand 

The message box contains a symbol consisting of a white X in a circle with a red background.

stop 

The message box contains a symbol consisting of white X in a circle with a red background.

error 

The message box contains a symbol consisting of white X in a circle with a red background.

question 

The message box contains a symbol consisting of a question mark in a circle. The question-mark message icon is no longer recommended because it does not clearly represent a specific type of message and because the phrasing of a message as a question could apply to any message type. In addition, users can confuse the message symbol question mark with Help information. Therefore, do not use this question mark message symbol in your message boxes. The system continues to support its inclusion only for backward compatibility.

exclamation 

The message box contains a symbol consisting of an exclamation point in a triangle with a yellow background.

warning 

The message box contains a symbol consisting of an exclamation point in a triangle with a yellow background.

asterisk 

The message box contains a symbol consisting of a lowercase letter i in a circle.

information 

The message box contains a symbol consisting of a lowercase letter i in a circle.

◆ message_dialog_options

#include <xtd.forms/include/xtd/forms/message_dialog_options.h>

Specifies options on a message_box.

Namespace
xtd::forms
Library
xtd.forms
Remarks
This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values.
This enumeration is used by the MessageBox class.
If you do not want to specify this parameter when calling methods on MessageBox, you can pass in 0 instead.
Enumerator
default_desktop_only 

The message box is displayed on the active desktop.

right_align 

The message box text is right-aligned.

rtl_reading 

Specifies that the message box text is displayed with right to left reading order.

service_notification 

The message box is displayed on the active desktop.

◆ mouse_buttons

#include <xtd.forms/include/xtd/forms/mouse_buttons.h>

Specifies constants that define which mouse button was pressed. This enumeration has a flag attribute that allows a bitwise combination of its member values.

Namespace
xtd::forms
Library
xtd.forms
Remarks
This enumeration is used by many classes, including ax_host, control, data_grid, form, radio_button, splitter, status_bar, and up_down_base.
Enumerator
none 

No mouse button was pressed.

left 

The left mouse button was pressed.

right 

The right mouse button was pressed.

middle 

he middle mouse button was pressed.

x_button1 

The first XButton (XBUTTON1) on Microsoft IntelliMouse Explorer was pressed.

x_button2 

The second XButton (XBUTTON2) on Microsoft IntelliMouse Explorer was pressed.

Examples
lcd_label2.cpp.

◆ orientation

#include <xtd.forms/include/xtd/forms/orientation.h>

Specifies the orientation of controls or elements of controls.

Namespace
xtd::forms
Library
xtd.forms
Remarks
Use the members of this enumeration to set the border style for controls that have a changeable border.
Enumerator
horizontal 

The control or element is oriented horizontally.

vertical 

The control or element is oriented vertically.

◆ picture_box_size_mode

#include <xtd.forms/include/xtd/forms/picture_box_size_mode.h>

Specifies how an image is positioned within a picture_box.

Namespace
xtd::forms
Library
xtd.forms
Remarks
Use the members of this enumeration to set the value of the size_mode property of the picture_box.
Enumerator
normal 

The image is placed in the upper-left corner of the picture_box. The image is clipped if it is larger than the picture_box it is contained in.

stretch_image 

The image within the picture_box is stretched or shrunk to fit the size of the picture_box.

auto_size 

The picture_box is sized equal to the size of the image that it contains.

center_image 

The image is displayed in the center if the picture_box is larger than the image. If the image is larger than the picture_box, the picture is placed in the center of the picture_box and the outside edges are clipped.

zoom 

The size of the image is increased or decreased maintaining the size ratio.

◆ progress_bar_style

#include <xtd.forms/include/xtd/forms/progress_bar_style.h>

Specifies the progress_bar_style of controls or elements of controls.

Namespace
xtd::forms
Library
xtd.forms
Remarks
You can use the marquee style when you need to indicate progress is being made, but you cannot indicate the quantity of progress. The marquee style is valid only when visual styles are enabled. The Continuous style is valid only when visual styles are not enabled.
Enumerator
blocks 

Indicates progress by increasing the number of segmented blocks in a progress_bar.

continuous 

Indicates progress by increasing the size of a smooth, continuous bar in a progress_bar.

marquee 

Indicates progress by continuously scrolling a block across a progress_bar in a marquee fashion.

◆ push_button_state

#include <xtd.forms/include/xtd/forms/visual_styles/push_button_state.h>

Specifies the visual state of a button that is drawn with visual styles.

Namespace
xtd::forms::visual_style
Library
xtd.forms
Remarks
The push_button_state values correspond to the states of the visual_style_element objects exposed by the visual_style_element:button::push_button class. The push_button_state values are also used as an argument in the button_renderer.draw_button method.
Enumerator
normal 

The button has the normal appearance.

hot 

The button is hot.

pressed 

The button is pressed.

checked 

The button is checked.

disabled 

The button is disabled.

default_state 

The button has the default appearance.

◆ radio_button_state

#include <xtd.forms/include/xtd/forms/visual_styles/radio_button_state.h>

Specifies the visual state of a radio button that is drawn with visual styles.

Namespace
xtd::forms::visual_style
Library
xtd.forms
Remarks
The radio_button_state values correspond to the states of the visual_style_element objects exposed by the visual_style_element::radio_button::radio_button class. The radio_button_state values are also used as an argument in the radio_button_renderer.draw_radio_button method.
Enumerator
unchecked_normal 

The radio button is unchecked.

unchecked_hot 

The radio button is unchecked and hot.

unchecked_pressed 

The radio button is unchecked and pressed.

unchecked_disabled 

The radio button is unchecked and disabled.

checked_normal 

The radio button is checked.

checked_hot 

The radio button is checked and hot.

checked_pressed 

The radio button is checked and pressed.

checked_disabled 

The radio button is checked and disabled.

◆ segment_style

#include <xtd.forms/include/xtd/forms/segment_style.h>

Represent segment style used by seven_segment_display, fourteen_segment_display, nine_segment_display and sixteen_segment_display controls.

Namespace
xtd::forms
Library
xtd.forms
Enumerator
standard 

Standard segment style.

modern 

Modern segment style.

mixed 

Mixed (mix between standard and modern) segment style.

expanded 

Expanded segment style.

design 

Design segment style.

stick 

Stick segment style.

◆ segments

enum xtd::forms::segments
strong

#include <xtd.forms/include/xtd/forms/segments.h>

Specifies how a control anchors to the edges of its container.

Namespace
xtd::forms
Library
xtd.forms
Remarks
This enumeration has a flags attribute that allows a bitwise combination of its member values.
When a control is anchored to an edge of its container, the distance between the control and the specified edge remains constant when the container resizes. For example, if a control is anchored to the right edge of its container, the distance between the right edge of the control and the right edge of the container remains constant when the container resizes. A control can be anchored to any combination of control edges. If the control is anchored to opposite edges of its container (for example, to the top and bottom), it resizes when the container resizes. If a control has its anchor property set to none, the control moves half of the distance that the container of the control is resized. For example, if a button has its anchor property set to none and the form that the control is located on is resized by 20 pixels in either direction, the button will be moved 10 pixels in both directions.
Enumerator
none 

no segment.

The a segment.

The b segment.

The c segment.

The d segment.

The e segment.

The f segment.

The g segment.

The h segment.

The i segment.

The j segment.

The k segment.

The l segment.

The m segment.

a1 

The a1 segment.

a2 

The a2 segment.

d1 

The d1 segment.

d2 

The d2 segment.

g1 

The g1 segment.

g2 

The g2 segment.

dp 

The dp segment (dot point).

pc 

The cp segment (punctuation colon).

◆ selection_mode

#include <xtd.forms/include/xtd/forms/selection_mode.h>

Specifies the selection behavior of a list box.

Namespace
xtd::forms
Library
xtd.forms
Remarks
This enumeration is used by classes such as list_box and checked_list_box.
Enumerator
none 

No items can be selected.

one 

Only one item can be selected.

multi_simple 

Multiple items can be selected.

multi_extended 

Multiple items can be selected, and the user can use the SHIFT, CTRL, and arrow keys to make selections.

◆ shortcut

enum xtd::forms::shortcut
strong

#include <xtd.forms/include/xtd/forms/shortcut.h>

Specifies shortcut keys that can be used by menu items.

Namespace
xtd::forms
Library
xtd.forms
Remarks
Use the members of this enumeration to set the value of the xtd::forms::menu_item::shortcut property of the xtd::forms::menu_item class.
Enumerator
alt_0 

The shortcut keys ALT+0.

alt_1 

The shortcut keys ALT+1.

alt_2 

The shortcut keys ALT+2.

alt_3 

The shortcut keys ALT+3.

alt_4 

The shortcut keys ALT+4.

alt_5 

The shortcut keys ALT+5.

alt_6 

The shortcut keys ALT+6.

alt_7 

The shortcut keys ALT+7.

alt_8 

The shortcut keys ALT+8.

alt_9 

The shortcut keys ALT+9.

alt_bksp 

The shortcut keys ALT+BACKSPACE.

alt_down_arrow 

The shortcut keys ALT+DOWNARROW.

alt_f1 

The shortcut keys ALT+F1.

alt_f10 

The shortcut keys ALT+F10.

alt_f11 

The shortcut keys ALT+F11.

alt_f12 

The shortcut keys ALT+F12.

alt_f2 

The shortcut keys ALT+F2.

alt_f3 

The shortcut keys ALT+F3.

alt_f4 

The shortcut keys ALT+F4.

alt_f5 

The shortcut keys ALT+F5.

alt_f6 

The shortcut keys ALT+F6.

alt_f7 

The shortcut keys ALT+F7.

alt_f8 

The shortcut keys ALT+F8.

alt_f9 

The shortcut keys ALT+F9.

alt_left_arrow 

The shortcut keys ALT+LEFTARROW.

alt_right_arrow 

The shortcut keys ALT+RIGHTARROW.

alt_up_arrow 

The shortcut keys ALT+UPARROW.

cmd_0 

The shortcut keys CMD+0.

cmd_1 

The shortcut keys CMD+1.

cmd_2 

The shortcut keys CMD+2.

cmd_3 

The shortcut keys CMD+3.

cmd_4 

The shortcut keys CMD+4.

cmd_5 

The shortcut keys CMD+5.

cmd_6 

The shortcut keys CMD+6.

cmd_7 

The shortcut keys CMD+7.

cmd_8 

The shortcut keys CMD+8.

cmd_9 

The shortcut keys CMD+9.

cmd_a 

The shortcut keys CMD+A.

cmd_b 

The shortcut keys CMD+B.

cmd_c 

The shortcut keys CMD+C.

cmd_d 

The shortcut keys CMD+D.

cmd_del 

The shortcut keys CMD+DELETE.

cmd_e 

The shortcut keys CMD+E.

cmd_f 

The shortcut keys CMD+F.

cmd_f1 

The shortcut keys CMD+F1.

cmd_f10 

The shortcut keys CMD+F10.

cmd_f11 

The shortcut keys CMD+F11.

cmd_f12 

The shortcut keys CMD+F12.

cmd_f2 

The shortcut keys CMD+F2.

cmd_f3 

The shortcut keys CMD+F3.

cmd_f4 

The shortcut keys CMD+F4.

cmd_f5 

The shortcut keys CMD+F5.

cmd_f6 

The shortcut keys CMD+F6.

cmd_f7 

The shortcut keys CMD+F7.

cmd_f8 

The shortcut keys CMD+F8.

cmd_f9 

The shortcut keys CMD+F9.

cmd_g 

The shortcut keys CMD+G.

cmd_h 

The shortcut keys CMD+H.

cmd_i 

The shortcut keys CMD+I.

cmd_ins 

The shortcut keys CMD+INSERT.

cmd_j 

The shortcut keys CMD+J.

cmd_k 

The shortcut keys CMD+K.

cmd_l 

The shortcut keys CMD+L.

cmd_m 

The shortcut keys CMD+M.

cmd_n 

The shortcut keys CMD+N.

cmd_o 

The shortcut keys CMD+O.

cmd_p 

The shortcut keys CMD+P.

cmd_q 

The shortcut keys CMD+Q.

cmd_r 

The shortcut keys CMD+R.

cmd_s 

The shortcut keys CMD+S.

cmd_shift_0 

The shortcut keys CMD+SHIFT+0.

cmd_shift_1 

The shortcut keys CMD+SHIFT+1.

cmd_shift_2 

The shortcut keys CMD+SHIFT+2.

cmd_shift_3 

The shortcut keys CMD+SHIFT+3.

cmd_shift_4 

The shortcut keys CMD+SHIFT+4.

cmd_shift_5 

The shortcut keys CMD+SHIFT+5.

cmd_shift_6 

The shortcut keys CMD+SHIFT+6.

cmd_shift_7 

The shortcut keys CMD+SHIFT+7.

cmd_shift_8 

The shortcut keys CMD+SHIFT+8.

cmd_shift_9 

The shortcut keys CMD+SHIFT+9.

cmd_shift_a 

The shortcut keys CMD+SHIFT+A.

cmd_shift_b 

The shortcut keys CMD+SHIFT+B.

cmd_shift_c 

The shortcut keys CMD+SHIFT+C.

cmd_shift_d 

The shortcut keys CMD+SHIFT+D.

cmd_shift_e 

The shortcut keys CMD+SHIFT+E.

cmd_shift_f 

The shortcut keys CMD+SHIFT+F.

cmd_shift_f1 

The shortcut keys CMD+SHIFT+F1.

cmd_shift_f10 

The shortcut keys CMD+SHIFT+F10.

cmd_shift_f11 

The shortcut keys CMD+SHIFT+F11.

cmd_shift_f12 

The shortcut keys CMD+SHIFT+F12.

cmd_shift_f2 

The shortcut keys CMD+SHIFT+F2.

cmd_shift_f3 

The shortcut keys CMD+SHIFT+F3.

cmd_shift_f4 

The shortcut keys CMD+SHIFT+F4.

cmd_shift_f5 

The shortcut keys CMD+SHIFT+F5.

cmd_shift_f6 

The shortcut keys CMD+SHIFT+F6.

cmd_shift_f7 

The shortcut keys CMD+SHIFT+F7.

cmd_shift_f8 

The shortcut keys CMD+SHIFT+F8.

cmd_shift_f9 

The shortcut keys CMD+SHIFT+F9.

cmd_shift_g 

The shortcut keys CMD+SHIFT+G.

cmd_shift_h 

The shortcut keys CMD+SHIFT+H.

cmd_shift_i 

The shortcut keys CMD+SHIFT+I.

cmd_shift_j 

The shortcut keys CMD+SHIFT+J.

cmd_shift_k 

The shortcut keys CMD+SHIFT+K.

cmd_shift_l 

The shortcut keys CMD+SHIFT+L.

cmd_shift_m 

The shortcut keys CMD+SHIFT+M.

cmd_shift_n 

The shortcut keys CMD+SHIFT+N.

cmd_shift_o 

The shortcut keys CMD+SHIFT+O.

cmd_shift_p 

The shortcut keys CMD+SHIFT+P.

cmd_shift_q 

The shortcut keys CMD+SHIFT+Q.

cmd_shift_r 

The shortcut keys CMD+SHIFT+R.

cmd_shift_s 

The shortcut keys CMD+SHIFT+S.

cmd_shift_t 

The shortcut keys CMD+SHIFT+T.

cmd_shift_u 

The shortcut keys CMD+SHIFT+U.

cmd_shift_v 

The shortcut keys CMD+SHIFT+V.

cmd_shift_w 

The shortcut keys CMD+SHIFT+W.

cmd_shift_x 

The shortcut keys CMD+SHIFT+X.

cmd_shift_y 

The shortcut keys CMD+SHIFT+Y.

cmd_shift_z 

The shortcut keys CMD+SHIFT+Z.

cmd_t 

The shortcut keys CMD+T.

cmd_u 

The shortcut keys CMD+U.

cmd_v 

The shortcut keys CMD+V.

cmd_w 

The shortcut keys CMD+W.

cmd_x 

The shortcut keys CMD+X.

cmd_y 

The shortcut keys CMD+Y.

cmd_z 

The shortcut keys CMD+Z.

del 

The shortcut keys DELETE.

f1 

The shortcut keys F1.

f10 

The shortcut keys F10.

f11 

The shortcut keys F11.

f12 

The shortcut keys F12.

f2 

The shortcut keys F2.

f3 

The shortcut keys F3.

f4 

The shortcut keys F4.

f5 

The shortcut keys F5.

f6 

The shortcut keys F6.

f7 

The shortcut keys F7.

f8 

The shortcut keys F8.

f9 

The shortcut keys F9.

ins 

The shortcut keys INSERT.

none 

No shortcut key is associated with the menu item.

shift_del 

The shortcut keys SHIFT+DELETE.

shift_f1 

The shortcut keys SHIFT+F1.

shift_f10 

The shortcut keys SHIFT+F10.

shift_f11 

The shortcut keys SHIFT+11.

shift_f12 

The shortcut keys SHIFT+F12.

shift_f2 

The shortcut keys SHIFT+F2.

shift_f3 

The shortcut keys SHIFT+F3.

shift_f4 

The shortcut keys SHIFT+F4.

shift_f5 

The shortcut keys SHIFT+F5.

shift_f6 

The shortcut keys SHIFT+F6.

shift_f7 

The shortcut keys SHIFT+F7.

shift_f8 

The shortcut keys SHIFT+F8.

shift_f9 

The shortcut keys SHIFT+F9.

shift_ins 

The shortcut keys SHIFT+INSERT.

Examples
main_menu.cpp.

◆ size_type

enum xtd::forms::size_type
strong

#include <xtd.forms/include/xtd/forms/size_type.h>

Specifies how rows or columns of user interface (UI) elements should be sized relative to their container.

Namespace
xtd::forms
Library
xtd.forms
Remarks
Use the members of this enumeration to set the value of the size_mode property of the picture_box.
Enumerator
auto_size 

The control should be automatically sized to share space with its peers.

absolute 

The control should be sized to an exact number of pixels.

percent 

The control should be sized as a percentage of the parent container.

◆ splitter_style

#include <xtd.forms/include/xtd/forms/splitter_style.h>

Represent splitter style used by splitter control.

Namespace
xtd::forms
Library
xtd.forms
Enumerator
draw_line 

Draw line splitter style.

update_children 

Update children splitter style.

◆ tab_alignment

#include <xtd.forms/include/xtd/forms/tab_alignment.h>

Specifies the locations of the tabs in a tab control.

Namespace
xtd::forms
Library
xtd.forms
Remarks
This enumeration is used by members such as tab_control::alignment.
Enumerator
top 

The tabs are located across the top of the control.

bottom 

The tabs are located across the bottom of the control.

left 

The tabs are located along the left edge of the control.

right 

The tabs are located along the right edge of the control.

◆ text_format_flags

#include <xtd.forms/include/xtd/forms/text_format_flags.h>

Specifies the display and layout information for text strings.

Namespace
xtd::forms
Library
xtd.forms
Remarks
The text_format_flags enumeration is used by the text_renderer when drawing and measuring text. The text_renderer does not support adding tab stops to drawn text, although you can expand existing tab stops using the expand_tabs flag.
Enumerator
default_format 

Applies the default formatting, which is left-aligned.

glyph_overhang_padding 

Adds padding to the bounding rectangle to accommodate overhanging glyphs. This is the default.

left 

Aligns the text on the left side of the clipping area. This is the default.

top 

Aligns the text on the top of the bounding rectangle. This is the default.

horizontal_center 

Centers the text horizontally within the bounding rectangle.

right 

Aligns the text on the right side of the clipping area.

vertical_center 

Centers the text vertically, within the bounding rectangle.

bottom 

Aligns the text on the bottom of the bounding rectangle. Applied only when the text is a single line.v.

word_break 

Breaks the text at the end of a word.

single_line 

Displays the text in a single line.

expand_tabs 

Expands tab characters. The default number of characters per tab is eight. The word_ellipsis, path_ellipsis, and end_ellipsis values cannot be used with expand_tabs.

no_clipping 

Allows the overhanging parts of glyphs and unwrapped text reaching outside the formatting rectangle to show.

external_leading 

Includes the font external leading in line height. Typically, external leading is not included in the height of a line of text.

no_prefix 

Turns off processing of prefix characters. Typically, the ampersand (&) mnemonic-prefix character is interpreted as a directive to underscore the character that follows, and the double-ampersand (&&) mnemonic-prefix characters as a directive to print a single ampersand. By specifying no_prefix, this processing is turned off. For example, an input string of "A&bc&&d" with no_prefix applied would result in output of "A&bc&&d". Compare with prefix_only.

internal 

Uses the system font to calculate text metrics.

text_box_control 

Specifies the text should be formatted for display on a TextBox control.

path_ellipsis 

Removes the center of trimmed lines and replaces it with an ellipsis. When used to draw text by text_renderer, the string is not modified unless the modify_string flag is specified. Compare with end_ellipsis and word_ellipsis.

end_ellipse 

Removes the end of trimmed lines, and replaces them with an ellipsis. When used to draw text by text_renderer, the string is not modified unless the modify_string flag is specified. Compare with path_ellipsis and word_ellipsis.

modify_string 

Has no effect on the drawn text or text measurements. When used to draw text by TextRenderer, modifies the specified string parameter to match the displayed text if ellipsis are shown. This value has no effect unless end_ellipsis or path_ellipsis is specified.

right_to_left 

Displays the text from right to left.

word_ellipsis 

Trims the line to the nearest word and an ellipsis is placed at the end of a trimmed line. Compare with end_ellipsis and path_ellipsis.

no_full_width_characterB_break 

A legacy value that has no effect. It prevents a line break at a double-wide character string, so that the line-breaking rule is equivalent to that for single-wide character strings.

hide_prefix 

Ignores the ampersand (&) prefix character in the text, so that the letter that follows won't be underlined, but other mnemonic-prefix characters are still processed.

prefix_only 

Draws only an underline at the position of the character following the ampersand (&) prefix character and doesn't draw any other characters in the string.

preserve_graphics_clipping 

Preserves the clipping specified by a graphics object. Applies only to methods receiving an idevice_context that is a graphics.

preserve_graphics_translate_transform 

Preserves the transformation specified by a graphics. Applies only to methods receiving an ideviceContext that is a graphics.

no_padding 

Does not add padding to the bounding rectangle.

left_and_right_padding 

Adds padding to both sides of the bounding rectangle.

◆ theme_style

#include <xtd.forms/include/xtd/forms/theme_style.h>

Specifies the style of theme.

Library
xtd.forms
Remarks
Use the members of this enumeration to set the value of the theme_style property of the theme class.

◆ tick_style

#include <xtd.forms/include/xtd/forms/tick_style.h>

Specifies the location of tick marks in a track_bar control.

Namespace
xtd::forms
Library
xtd.forms
Remarks
Use the members of this enumeration to set the value of the tick_style property of the track_bar control.
Enumerator
none 

No tick marks appear in the control.

top_left 

Tick marks are located on the top of a horizontal control or on the left of a vertical control.

bottom_right 

Tick marks are located on the bottom of a horizontal control or on the right side of a vertical control.

both 

Tick marks are located on both sides of the control.

◆ toggle_button_state

#include <xtd.forms/include/xtd/forms/visual_styles/toggle_button_state.h>

Specifies the visual state of a check box that is drawn with visual styles.

Namespace
xtd::forms::visual_style
Library
xtd.forms
Remarks
The toggle_button_state values correspond to the states of the visual_style_element objects exposed by the visual_style_element::toggle_button class. The toggle_button_state values are also used as an argument in the toggle_button_renderer.toggle_button method.
Enumerator
unchecked_normal 

The check box is unchecked.

unchecked_hot 

The check box is unchecked and hot.

unchecked_pressed 

The check box is unchecked and pressed.

unchecked_disabled 

The check box is unchecked and disabled.

checked_normal 

The check box is checked.

checked_hot 

The check box is checked and hot.

checked_pressed 

The check box is checked and pressed.

checked_disabled 

The check box is checked and disabled.

mixed_normal 

The check box is three-state.

mixed_hot 

The check box is three-state and hot.

mixed_pressed 

The check box is three-state and pressed.

mixed_disabled 

The check box is three-state and disabled.