xtd::forms::status_bar Class Reference

Inheritance diagram for xtd::forms::status_bar:

Definition

Represents a Windows status bar control.

class forms_export_ status_bar : public xtd::forms::control

Inheritance

xtd::object → xtd::forms::component → xtd::forms::control → xtd::forms::status_bar

Header

#include <xtd/forms/status_bar>

Namespace

xtd::forms

Library

xtd.forms

Appearance

	Windows	macOS	Gnome
Light
Dark

Examples

The following code example demonstrates the use of xtd::forms::status_bar control.

#include <xtd/forms/application>
#include <xtd/forms/form>
#include <xtd/forms/progress_bar>
#include <xtd/forms/status_bar>
#include <xtd/forms/timer>
#include <xtd/drawing/pens>
 
using namespace xtd;
using namespace xtd::drawing;
using namespace xtd::forms;
 
namespace status_bar_example {
  class form1 : public form {
  public:
    form1() {
      text("Status bar example");
      client_size({820, 500});
      
      status_bar1.parent(*this);
      status_bar1.panels().push_back_range({status_bar_panel1, status_bar_panel2, status_bar_panel3, status_bar_panel4});
      status_bar1.show_panels(true);
      
      status_bar_panel1.auto_size(xtd::forms::status_bar_panel_auto_size::contents);
      status_bar_panel1.border_style(xtd::forms::status_bar_panel_border_style::sunken);
      status_bar_panel1.tool_tip_text("Status one tool tip text");
      
      status_bar_panel2.auto_size(xtd::forms::status_bar_panel_auto_size::contents);
      status_bar_panel2.border_style(xtd::forms::status_bar_panel_border_style::sunken);
      
      status_bar_panel3.auto_size(xtd::forms::status_bar_panel_auto_size::spring);
      status_bar_panel3.border_style(xtd::forms::status_bar_panel_border_style::sunken);
      
      status_bar_panel4.auto_size(xtd::forms::status_bar_panel_auto_size::contents);
      status_bar_panel4.border_style(xtd::forms::status_bar_panel_border_style::sunken);
      
      timer1.interval_milliseconds(50);
      timer1.tick += [&] {
        progress_bar1.value(progress_bar1.value() < progress_bar1.maximum() ? progress_bar1.value() + 1 : progress_bar1.minimum());
      };
      timer1.enabled(true);
    }
    
  private:
    static auto image_from_color(const xtd::drawing::color& color)->image {
      auto colored_bitmap = bitmap{16, 16};
      auto g = graphics::from_image(colored_bitmap);
      g.fill_ellipse(solid_brush(color), 0, 0, colored_bitmap.width(), colored_bitmap.height());
      g.draw_ellipse(pens::black(), 0, 0, colored_bitmap.width() - 1, colored_bitmap.height() - 1);
      return colored_bitmap;
    }
    
    forms::status_bar status_bar1;
    status_bar_panel status_bar_panel1 = status_bar_panel::create_panel("Status one", image_from_color(color::light_green));
    status_bar_panel status_bar_panel2 = status_bar_panel::create_panel("Status two");
    status_bar_panel status_bar_panel3 = status_bar_panel::create_panel("Status three");
    timer timer1;
    progress_bar progress_bar1;
    status_bar_panel status_bar_panel4 = status_bar_panel::create_control(progress_bar1);
  };
}
 
auto main() -> int {
  application::run(status_bar_example::form1 {});
}

Remarks

Typically, a xtd::forms::status_bar control consists of xtd::forms::status_bar_panel objects, each of which displays text and/or an image. You can also provide owner-drawn panels to provide custom panels such as a progress bar or a series of images that displays the state of your application. A xtd::forms::status_bar control typically displays information about an object being viewed on a xtd::forms::form, the object's components, or contextual information that relates to that object's operation within your application.

The xtd::forms::status_bar control provides properties that enable you to customize the appearance of the control. If the xtd::forms::status_bar is displayed on a form that can be resized, you can use the xtd::forms::status_bar::sizing_grip property to display a sizing grip in the lower-right corner of the form to indicate to users that the form can be resized. The xtd::forms::status_bar::show_panels property enables you to display panels within your xtd::forms::status_bar or to display only the value of the xtd::forms::status_bar::text property of the control.

The default xtd::forms::status_bar has no panels. To add panels to a xtd::forms::status_bar you can use the xtd::forms::status_bar::status_bar_panel_collection::push_back method of the xtd::forms::status_bar::status_bar_ppanel_collection class that is accessible through the xtd::forms::status_bar::panels property of the control. You can also use the xtd::forms::status_bar::status_bar_panel_collection object provided through the xtd::forms::status_bar::panels property to remove panels from the control and access a specific xtd::forms::status_bar_panel to manipulate the panel.

If you want to determine when a xtd::forms::status_bar_panel object within a xtd::forms::status_bar control is clicked, you can create an event handler for the xtd::forms::status_bar::panel_click event. To perform owner-draw operations on a panel, you can create an event handler for the xtd::forms::status_bar::draw_item event. The event data passed to the event handler provides information on the panel to draw and a xtd::drawing::graphics object to use to perform drawing tasks.

When you create an instance of xtd::forms::status_bar, the read/write properties are set to initial values. For a list of these values, see the xtd::forms::status_bar constructor.

Examples

application_enable_dark_mode.cpp, application_enable_light_mode.cpp, hello_world_xtd.cpp, some_controls.cpp, some_system_controls.cpp, status_bar.cpp, status_bar_without_panels.cpp, and themes.cpp.

Protected Attributes
friend	status_bar_panel
friend	form

Public Aliases
using	status_bar_panel_collection = xtd::forms::layout::arranged_element_collection< status_bar_panel_ref >
	Represents the collection of panels in a xtd::forms::status_bar control.

Public Events
xtd::event< status_bar, xtd::forms::status_bar_draw_item_event_handler >	draw_item
	Occurs when a visual aspect of an owner-drawn status bar control changes.
xtd::event< status_bar, xtd::forms::status_bar_panel_click_event_handler >	panel_click
	Occurs when a xtd::forms::status_bar_panel object on a xtd::forms::status_bar control is clicked.

Public Constructors
	status_bar ()
	Initializes a new instance of the xtd::forms::status_bar class.

Public Properties
dock_style	dock () const noexcept override
	Gets which control borders are docked to its parent control and determines how a control is resized with its parent.
control &	dock (dock_style dock) override
	Sets which control borders are docked to its parent control and determines how a control is resized with its parent.
const status_bar_panel_collection &	panels () const noexcept
	Gets the collection of xtd::forms::status_bar panels contained within the control.
status_bar_panel_collection &	panels ()
	Gets the collection of xtd::forms::status_bar panels contained within the control.
virtual bool	show_panels () const noexcept
	Gets a value indicating whether any panels that have been added to the control are displayed.
virtual status_bar &	show_panels (bool value)
	Sets a value indicating whether any panels that have been added to the control are displayed.
virtual bool	show_tool_tips () const noexcept
	Gets a value indicating whether the status bar displays a xtd::forms::tool_tip for each button.
virtual status_bar &	show_tool_tips (bool value)
	Sets a value indicating whether the status bar displays a xtd::forms::tool_tip for each button.
virtual bool	sizing_grip () const noexcept
	Gets a value indicating whether a sizing grip is displayed in the lower-right corner of the control.
virtual status_bar &	sizing_grip (bool value)
	Sets a value indicating whether a sizing grip is displayed in the lower-right corner of the control.

Public Static Methods
static status_bar	create ()
	A factory to create an xtd::forms::status_bar.
static status_bar	create (const status_bar_panel_collection &panels)
	A factory to create an xtd::forms::status_bar with specified panels.
static status_bar	create (const status_bar_panel_collection &panels, const xtd::string &name)
	A factory to create an xtd::forms::status_bar with specified panels, and name.
static status_bar	create (xtd::forms::dock_style style)
	A factory to create an xtd::forms::status_bar with specified style.
static status_bar	create (xtd::forms::dock_style style, const status_bar_panel_collection &panels)
	A factory to create an xtd::forms::status_bar with specified style, and panels.
static status_bar	create (xtd::forms::dock_style style, const status_bar_panel_collection &panels, const xtd::string &name)
	A factory to create an xtd::forms::status_bar with specified style, panels, and name.
static status_bar	create (const xtd::string &text)
	A factory to create an xtd::forms::status_bar with specified text.
static status_bar	create (const xtd::string &text, const xtd::string &name)
	A factory to create an xtd::forms::status_bar with specified text, and name.
static status_bar	create (xtd::forms::dock_style style, const xtd::string &text)
	A factory to create an xtd::forms::status_bar with specified style, and text.
static status_bar	create (xtd::forms::dock_style style, const xtd::string &text, const xtd::string &name)
	A factory to create an xtd::forms::status_bar with specified style, text, and name.
static status_bar	create (const control &parent)
	A factory to create an xtd::forms::status_bar with specified parent.
static status_bar	create (const control &parent, const status_bar_panel_collection &panels)
	A factory to create an xtd::forms::status_bar with specified parent, and panels.
static status_bar	create (const control &parent, const status_bar_panel_collection &panels, const xtd::string &name)
	A factory to create an xtd::forms::status_bar with specified parent, panels, and name.
static status_bar	create (const control &parent, xtd::forms::dock_style style)
	A factory to create an xtd::forms::status_bar with specified parent, and style.
static status_bar	create (const control &parent, xtd::forms::dock_style style, const status_bar_panel_collection &panels)
	A factory to create an xtd::forms::status_bar with specified parent, style, and panels.
static status_bar	create (const control &parent, xtd::forms::dock_style style, const status_bar_panel_collection &panels, const xtd::string &name)
	A factory to create an xtd::forms::status_bar with specified parent, style, panels, and name.
static status_bar	create (const control &parent, const xtd::string &text)
	A factory to create an xtd::forms::status_bar with specified parent, and text.
static status_bar	create (const control &parent, const xtd::string &text, const xtd::string &name)
	A factory to create an xtd::forms::status_bar with specified parent, text, and name.
static status_bar	create (const control &parent, xtd::forms::dock_style style, const xtd::string &text)
	A factory to create an xtd::forms::status_bar with specified parent, style, and text.
static status_bar	create (const control &parent, xtd::forms::dock_style style, const xtd::string &text, const xtd::string &name)
	A factory to create an xtd::forms::status_bar with specified parent, style, text, and name.

Protetced properties
forms::create_params	create_params () const noexcept override
	Gets the required creation parameters when the control handle is created.
xtd::drawing::font	default_font () const noexcept override
	Gets the default font of the control.
drawing::size	default_size () const noexcept override
	Gets the default size of the control.

Protetced methods
xtd::uptr< xtd::object >	clone () const override
	Creates a new object that is a copy of the current instance.
virtual void	on_draw_item (xtd::forms::status_bar_draw_item_event_args &e)
	Raises the xtd::forms::status_bar::daw_item event.
virtual void	on_panel_click (const xtd::forms::status_bar_panel_click_event_args &e)
	Raises the xtd::forms::status_bar::panel_click event.
void	on_handle_created (const event_args &e) override
	Raises the xtd::forms::control::handle_created event.
void	on_handle_destroyed (const event_args &e) override
	Raises the xtd::forms::control::handle_destroyed event.
void	on_main_panel_paint (object &sender, xtd::forms::paint_event_args &e)
void	on_paint (xtd::forms::paint_event_args &e) override
	Raises the xtd::forms::control::paint event.
void	on_resize (const event_args &e) override
	Raises the xtd::forms::control::region event.
void	wnd_proc (message &message) override
	Processes Windows messages.

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

Member Typedef Documentation

status_bar_panel_collection

using xtd::forms::status_bar::status_bar_panel_collection = xtd::forms::layout::arranged_element_collection<status_bar_panel_ref>

Represents the collection of panels in a xtd::forms::status_bar control.

Constructor & Destructor Documentation

status_bar()

xtd::forms::status_bar::status_bar

(

)

Initializes a new instance of the xtd::forms::status_bar class.

Remarks

The default xtd::forms::status_bar has no panels.

When you create an instance of xtd::forms::status_bar, the following read/write properties are set to initial values.

Property	Initial value
xtd::forms::status_bar::dock	xtd::forms::dock_style::bottom
xtd::forms::status_bar::show_panels	false
xtd::forms::status_bar::sizing_grip	true

Member Function Documentation

dock() [1/2]

dock_style xtd::forms::status_bar::dock ( ) const

overridevirtualnoexcept

Gets which control borders are docked to its parent control and determines how a control is resized with its parent.

Returns

One of the xtd::forms::dock_style values. The default is xtd::forms::dock_style::none.

Remarks

Use the xtd::forms::control::dock property to define how a control is automatically resized as its parent control is resized. For example, setting xtd::forms::control::dock to xtd::forms::dock_style::left causes the control to align itself with the left edges of its parent control and to resize as the parent control is resized. Controls are docked in their Z-order, which is the visual layering of controls on a form along the form's Z-axis (depth).

A control can be docked to one edge of its parent container or can be docked to all edges and fill the parent container.

Setting the xtd::forms::control::margin property on a docked control has no effect on the distance of the control from the edges of its container.

Note

The xtd::forms::control::anchor and xtd::forms::control::dock properties are mutually exclusive. Only one can be set at a time, and the last one set takes precedence.

Notes to Inheritors

When overriding the xtd::forms::control::dock property in a derived class, use the base class's xtd::forms::control::dock property to extend the base implementation. Otherwise, you must provide all the implementation. You are not required to override both the get and set methods of the xtd::forms::control::dock property; you can override only one if needed.

Reimplemented from xtd::forms::control.

dock() [2/2]

control & xtd::forms::status_bar::dock ( dock_style  dock )

overridevirtual

Sets which control borders are docked to its parent control and determines how a control is resized with its parent.

Parameters

dock	One of the xtd::forms::dock_style values. The default is xtd::forms::dock_style::none.

Returns

Current control.

Remarks

Use the xtd::forms::control::dock property to define how a control is automatically resized as its parent control is resized. For example, setting xtd::forms::control::dock to xtd::forms::dock_style::left causes the control to align itself with the left edges of its parent control and to resize as the parent control is resized. Controls are docked in their Z-order, which is the visual layering of controls on a form along the form's Z-axis (depth).

A control can be docked to one edge of its parent container or can be docked to all edges and fill the parent container.

Setting the xtd::forms::control::margin property on a docked control has no effect on the distance of the control from the edges of its container.

Note

The xtd::forms::control::anchor and xtd::forms::control::dock properties are mutually exclusive. Only one can be set at a time, and the last one set takes precedence.

Notes to Inheritors

When overriding the xtd::forms::control::dock property in a derived class, use the base class's xtd::forms::control::dock property to extend the base implementation. Otherwise, you must provide all the implementation. You are not required to override both the get and set methods of the xtd::forms::control::dock property; you can override only one if needed.

Reimplemented from xtd::forms::control.

panels() [1/2]

const status_bar_panel_collection & xtd::forms::status_bar::panels ( ) const

noexcept

Gets the collection of xtd::forms::status_bar panels contained within the control.

Returns

A xtd::forms::status_bar::status_bar_panel_collection containing the xtd::forms::status_bar_panel objects of the xtd::forms::status_bar control.

Remarks

The xtd::forms::status_bar control can display a number of panels to provide information to the user of your application. For example, a panel could display the current time or the progress of a file download. Each panel displayed by the xtd::forms::status_bar control is an instance of the xtd::forms::status_bar_panel class. The xtd::forms::status_bar::panels property enables you to obtain a reference to the collection of xtd::forms::status_bar_panel objects that are currently stored in the xtd::forms::status_bar control. With this reference, you can add panels, remove panels, access a specific panel within the collection, and obtain a count of the panels in the xtd::forms::status_bar control. For more information on the tasks that can be performed with the panel collection, see the xtd::forms::status_bar::status_bar_panel_collection class reference topics.

panels() [2/2]

status_bar_panel_collection & xtd::forms::status_bar::panels

(

)

Gets the collection of xtd::forms::status_bar panels contained within the control.

Returns

A xtd::forms::status_bar::status_bar_panel_collection containing the xtd::forms::status_bar_panel objects of the xtd::forms::status_bar control.

Remarks

The xtd::forms::status_bar control can display a number of panels to provide information to the user of your application. For example, a panel could display the current time or the progress of a file download. Each panel displayed by the xtd::forms::status_bar control is an instance of the xtd::forms::status_bar_panel class. The xtd::forms::status_bar::panels property enables you to obtain a reference to the collection of xtd::forms::status_bar_panel objects that are currently stored in the xtd::forms::status_bar control. With this reference, you can add panels, remove panels, access a specific panel within the collection, and obtain a count of the panels in the xtd::forms::status_bar control. For more information on the tasks that can be performed with the panel collection, see the xtd::forms::status_bar::status_bar_panel_collection class reference topics.

show_panels() [1/2]

virtual bool xtd::forms::status_bar::show_panels ( ) const

virtualnoexcept

Gets a value indicating whether any panels that have been added to the control are displayed.

Returns

true if panels are displayed; otherwise, false. The default is false.

Remarks

By default, the xtd::forms::status_bar control displays the value of its xtd::forms::status_bar::text property without any panels. When xtd::forms::status_bar::show_panels is set to true, any xtd::forms::status_bar objects specified in the StatusBar control are displayed. No panels are initially created when you create an instance of the xtd::forms::status_bar class. You can add panels to a xtd::forms::status_bar control by using the xtd::forms::status_bar::status_bar_panel_collection::push_back method of the xtd::forms::status_bar::status_bar_panel_collection class. This collection class can be accessed through the xtd::forms::status_bar::panels property of xtd::forms::status_bar.

show_panels() [2/2]

virtual status_bar & xtd::forms::status_bar::show_panels ( bool  value )

virtual

Sets a value indicating whether any panels that have been added to the control are displayed.

Parameters

value

true if panels are displayed; otherwise, false. The default is false.

Returns

Current status_bar instance.

Remarks

By default, the xtd::forms::status_bar control displays the value of its xtd::forms::status_bar::text property without any panels. When xtd::forms::status_bar::show_panels is set to true, any xtd::forms::status_bar objects specified in the StatusBar control are displayed. No panels are initially created when you create an instance of the xtd::forms::status_bar class. You can add panels to a xtd::forms::status_bar control by using the xtd::forms::status_bar::status_bar_panel_collection::push_back method of the xtd::forms::status_bar::status_bar_panel_collection class. This collection class can be accessed through the xtd::forms::status_bar::panels property of xtd::forms::status_bar.

show_tool_tips() [1/2]

virtual bool xtd::forms::status_bar::show_tool_tips ( ) const

virtualnoexcept

Gets a value indicating whether the status bar displays a xtd::forms::tool_tip for each button.

Returns

true if the status bar display a xtd::forms::tool_tip for each button; otherwise, false. The default is false.

Remarks

To set the text displayed by the xtd::forms::tool_tip, set the xtd::forms::tool_bar_button::tool_tip_text property of each xtd::forms::tool_bar_button on the xtd::forms::tool_bar. To cause the xtd::forms::tool_tip to display as the user moves the mouse pointer over the status bar button, set the xtd::forms::tool_bar::show_tool_tips property to true.

show_tool_tips() [2/2]

virtual status_bar & xtd::forms::status_bar::show_tool_tips ( bool  value )

virtual

Sets a value indicating whether the status bar displays a xtd::forms::tool_tip for each button.

Parameters

value

true if the status bar display a xtd::forms::tool_tip for each button; otherwise, false. The default is false.

Returns

Current tool_bar instance.

Remarks

To set the text displayed by the xtd::forms::tool_tip, set the xtd::forms::tool_bar_button::tool_tip_text property of each xtd::forms::tool_bar_button on the xtd::forms::tool_bar. To cause the xtd::forms::tool_tip to display as the user moves the mouse pointer over the status bar panel, set the xtd::forms::tool_bar::show_tool_tips property to true.

sizing_grip() [1/2]

virtual bool xtd::forms::status_bar::sizing_grip ( ) const

virtualnoexcept

Gets a value indicating whether a sizing grip is displayed in the lower-right corner of the control.

Returns

true if a sizing grip is displayed; otherwise, false. The default is true.

Remarks

You can use this property to display a sizing grip to provide an indication to the user when a form is resizable. If the xtd::forms::form_border_style property of your xtd::forms::form is set to a border style that is not resizable, such as xtd::forms::form_border_style::fixed_3d or xtd::forms::form_border_style::fixed_dialog, you should set the xtd::forms::status_bar::sizing_grip property to false to prevent the user from thinking that the form can be resized.

sizing_grip() [2/2]

virtual status_bar & xtd::forms::status_bar::sizing_grip ( bool  value )

virtual

Sets a value indicating whether a sizing grip is displayed in the lower-right corner of the control.

Parameters

value

true if a sizing grip is displayed; otherwise, false. The default is true.

Returns

Current status_bar instance.

Remarks

You can use this property to display a sizing grip to provide an indication to the user when a form is resizable. If the xtd::forms::form_border_style property of your xtd::forms::form is set to a border style that is not resizable, such as xtd::forms::form_border_style::fixed_3d or xtd::forms::form_border_style::fixed_dialog, you should set the xtd::forms::status_bar::sizing_grip property to false to prevent the user from thinking that the form can be resized.

create() [1/20]

static status_bar xtd::forms::status_bar::create ( )

static

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

Returns

New xtd::forms::status_bar created.

create() [2/20]

static status_bar xtd::forms::status_bar::create ( const status_bar_panel_collection &  panels )

static

A factory to create an xtd::forms::status_bar with specified panels.

Parameters

panels

A xtd::forms::status_bar::status_bar_panel_collection containing the xtd::forms::status_bar_panel objects of the xtd::forms::status_bar.

Returns

New xtd::forms::status_bar created.

create() [3/20]

static status_bar xtd::forms::status_bar::create ( const status_bar_panel_collection &  panels, const xtd::string &  name  )

static

A factory to create an xtd::forms::status_bar with specified panels, and name.

Parameters

panels	A xtd::forms::status_bar::status_bar_panel_collection containing the xtd::forms::status_bar_panel objects of the xtd::forms::status_bar.
name	The name of the xtd::forms::status_bar.

Returns

New xtd::forms::status_bar created.

create() [4/20]

static status_bar xtd::forms::status_bar::create ( xtd::forms::dock_style  style )

static

A factory to create an xtd::forms::status_bar with specified style.

Parameters

style

One of the xtd::forms::dock_style values.

Returns

New xtd::forms::status_bar created.

create() [5/20]

static status_bar xtd::forms::status_bar::create ( xtd::forms::dock_style  style, const status_bar_panel_collection &  panels  )

static

A factory to create an xtd::forms::status_bar with specified style, and panels.

Parameters

style	One of the xtd::forms::dock_style values.
panels	A xtd::forms::status_bar::status_bar_panel_collection containing the xtd::forms::status_bar_panel objects of the xtd::forms::status_bar.

Returns

New xtd::forms::status_bar created.

create() [6/20]

static status_bar xtd::forms::status_bar::create ( xtd::forms::dock_style  style, const status_bar_panel_collection &  panels, const xtd::string &  name  )

static

A factory to create an xtd::forms::status_bar with specified style, panels, and name.

Parameters

style	One of the xtd::forms::dock_style values.
panels	A xtd::forms::status_bar::status_bar_panel_collection containing the xtd::forms::status_bar_panel objects of the xtd::forms::status_bar.
name	The name of the xtd::forms::status_bar.

Returns

New xtd::forms::status_bar created.

create() [7/20]

static status_bar xtd::forms::status_bar::create ( const xtd::string &  text )

static

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

Parameters

text	The text of the xtd::forms::status_bar.

Returns

New xtd::forms::status_bar created.

create() [8/20]

static status_bar xtd::forms::status_bar::create ( const xtd::string &  text, const xtd::string &  name  )

static

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

Parameters

text	The text of the xtd::forms::status_bar.
name	The name of the xtd::forms::status_bar.

Returns

New xtd::forms::status_bar created.

create() [9/20]

static status_bar xtd::forms::status_bar::create ( xtd::forms::dock_style  style, const xtd::string &  text  )

static

A factory to create an xtd::forms::status_bar with specified style, and text.

Parameters

style	One of the xtd::forms::dock_style values.
text	The text of the xtd::forms::status_bar.

Returns

New xtd::forms::status_bar created.

create() [10/20]

static status_bar xtd::forms::status_bar::create ( xtd::forms::dock_style  style, const xtd::string &  text, const xtd::string &  name  )

static

A factory to create an xtd::forms::status_bar with specified style, text, and name.

Parameters

style	One of the xtd::forms::dock_style values.
text	The text of the xtd::forms::status_bar.
name	The name of the xtd::forms::status_bar.

Returns

New xtd::forms::status_bar created.

create() [11/20]

static status_bar xtd::forms::status_bar::create ( const control &  parent )

static

A factory to create an xtd::forms::status_bar with specified parent.

Parameters

parent

The parent that contains the new created xtd::forms::status_bar.

Returns

New xtd::forms::status_bar created.

create() [12/20]

static status_bar xtd::forms::status_bar::create ( const control &  parent, const status_bar_panel_collection &  panels  )

static

A factory to create an xtd::forms::status_bar with specified parent, and panels.

Parameters

parent	The parent that contains the new created xtd::forms::status_bar.
panels	A xtd::forms::status_bar::status_bar_panel_collection containing the xtd::forms::status_bar_panel objects of the xtd::forms::status_bar.

Returns

New xtd::forms::status_bar created.

create() [13/20]

static status_bar xtd::forms::status_bar::create ( const control &  parent, const status_bar_panel_collection &  panels, const xtd::string &  name  )

static

A factory to create an xtd::forms::status_bar with specified parent, panels, and name.

Parameters

parent	The parent that contains the new created xtd::forms::status_bar.
panels	A xtd::forms::status_bar::status_bar_panel_collection containing the xtd::forms::status_bar_panel objects of the xtd::forms::status_bar.
name	The name of the xtd::forms::status_bar.

Returns

New xtd::forms::status_bar created.

create() [14/20]

static status_bar xtd::forms::status_bar::create ( const control &  parent, xtd::forms::dock_style  style  )

static

A factory to create an xtd::forms::status_bar with specified parent, and style.

Parameters

parent	The parent that contains the new created xtd::forms::status_bar.
style	One of the xtd::forms::dock_style values.

Returns

New xtd::forms::status_bar created.

create() [15/20]

static status_bar xtd::forms::status_bar::create ( const control &  parent, xtd::forms::dock_style  style, const status_bar_panel_collection &  panels  )

static

A factory to create an xtd::forms::status_bar with specified parent, style, and panels.

Parameters

parent	The parent that contains the new created xtd::forms::status_bar.
style	One of the xtd::forms::dock_style values.
panels	A xtd::forms::status_bar::status_bar_panel_collection containing the xtd::forms::status_bar_panel objects of the xtd::forms::status_bar.

Returns

New xtd::forms::status_bar created.

create() [16/20]

static status_bar xtd::forms::status_bar::create ( const control &  parent, xtd::forms::dock_style  style, const status_bar_panel_collection &  panels, const xtd::string &  name  )

static

A factory to create an xtd::forms::status_bar with specified parent, style, panels, and name.

Parameters

parent	The parent that contains the new created xtd::forms::status_bar.
style	One of the xtd::forms::dock_style values.
panels	A xtd::forms::status_bar::status_bar_panel_collection containing the xtd::forms::status_bar_panel objects of the xtd::forms::status_bar.
name	The name of the xtd::forms::status_bar.

Returns

New xtd::forms::status_bar created.

create() [17/20]

static status_bar xtd::forms::status_bar::create ( const control &  parent, const xtd::string &  text  )

static

A factory to create an xtd::forms::status_bar with specified parent, and text.

Parameters

parent	The parent that contains the new created xtd::forms::status_bar.
text	The text of the xtd::forms::status_bar.

Returns

New xtd::forms::status_bar created.

create() [18/20]

static status_bar xtd::forms::status_bar::create ( const control &  parent, const xtd::string &  text, const xtd::string &  name  )

static

A factory to create an xtd::forms::status_bar with specified parent, text, and name.

Parameters

parent	The parent that contains the new created xtd::forms::status_bar.
text	The text of the xtd::forms::status_bar.
name	The name of the xtd::forms::status_bar.

Returns

New xtd::forms::status_bar created.

create() [19/20]

static status_bar xtd::forms::status_bar::create ( const control &  parent, xtd::forms::dock_style  style, const xtd::string &  text  )

static

A factory to create an xtd::forms::status_bar with specified parent, style, and text.

Parameters

parent	The parent that contains the new created xtd::forms::status_bar.
style	One of the xtd::forms::dock_style values.
text	The text of the xtd::forms::status_bar.

Returns

New xtd::forms::status_bar created.

create() [20/20]

static status_bar xtd::forms::status_bar::create ( const control &  parent, xtd::forms::dock_style  style, const xtd::string &  text, const xtd::string &  name  )

static

A factory to create an xtd::forms::status_bar with specified parent, style, text, and name.

Parameters

parent	The parent that contains the new created xtd::forms::status_bar.
style	One of the xtd::forms::dock_style values.
text	The text of the xtd::forms::status_bar.
name	The name of the xtd::forms::status_bar.

Returns

New xtd::forms::status_bar created.

create_params()

forms::create_params xtd::forms::status_bar::create_params ( ) const

overrideprotectedvirtualnoexcept

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

Returns

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

Remarks

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

Notes for inheritors

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

Reimplemented from xtd::forms::control.

default_font()

xtd::drawing::font xtd::forms::status_bar::default_font ( ) const

overrideprotectedvirtualnoexcept

Gets the default font of the control.

Returns

The default font of the control. The value returned will vary depending on the user's operating system the local culture setting of their system.

Reimplemented from xtd::forms::control.

default_size()

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

overrideprotectedvirtualnoexcept

Gets the default size of the control.

Returns

The default size of the control.

Reimplemented from xtd::forms::control.

clone()

xtd::uptr< xtd::object > xtd::forms::status_bar::clone ( ) const

overrideprotectedvirtual

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

Returns

A new object that is a copy of this instance.

Notes to Implementers

All controls must be override the clone method.

Reimplemented from xtd::forms::control.

on_draw_item()

virtual void xtd::forms::status_bar::on_draw_item ( xtd::forms::status_bar_draw_item_event_args &  e )

protectedvirtual

Raises the xtd::forms::status_bar::daw_item event.

Parameters

e	A xtd::forms::status_bar_draw_item_event_args that contains the event data.

Remarks

Raising an event invokes the event handler through a delegate.

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

The xtd::forms::status_bar::on_draw_item method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

Notes to Inheritors

When overriding xtd::forms::status_bar::on_draw_item in a derived class, be sure to call the base class's xtd::forms::status_bar::on_draw_item method so that registered delegates receive the event.

on_panel_click()

virtual void xtd::forms::status_bar::on_panel_click ( const xtd::forms::status_bar_panel_click_event_args &  e )

protectedvirtual

Raises the xtd::forms::status_bar::panel_click event.

Parameters

e	A xtd::forms::status_bar_panel_click_event_args that contains the event data.

Remarks

Raising an event invokes the event handler through a delegate.

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

The xtd::forms::status_bar::on_panel_click method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

Notes to Inheritors

When overriding xtd::forms::status_bar::on_panel_click in a derived class, be sure to call the base class's xtd::forms::status_bar::on_panel_click method so that registered delegates receive the event.

on_handle_created()

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

overrideprotectedvirtual

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

Parameters

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

Reimplemented from xtd::forms::control.

on_handle_destroyed()

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

overrideprotectedvirtual

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

Parameters

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

Reimplemented from xtd::forms::control.

on_paint()

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

overrideprotectedvirtual

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

Parameters

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

Reimplemented from xtd::forms::control.

on_resize()

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

overrideprotectedvirtual

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

Parameters

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

Reimplemented from xtd::forms::control.

wnd_proc()

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

overrideprotectedvirtual

Processes Windows messages.

Parameters

m	The Windows Message to process.

Remarks

All messages are sent to the wnd_proc method after getting filtered through the pre_process_message method.

Notes to Inheritors

Inheriting controls should call the base class's wnd_proc(message&) method to process any messages that they do not handle.

Reimplemented from xtd::forms::control.

Member Data Documentation

draw_item

xtd::event<status_bar, xtd::forms::status_bar_draw_item_event_handler> xtd::forms::status_bar::draw_item

Occurs when a visual aspect of an owner-drawn status bar control changes.

Remarks

You can use this event to perform drawing operations in an owner-drawn xtd::forms::status_bar control. For example, if you display an owner-drawn xtd::forms::status_bar_panel that displays a progress bar, you can use this event to perform the drawing of the progress bar on the panel. The data provided to the event through the xtd::forms::status_bar_draw_item_event_args object passed as a parameter to the event handler enables you to determine the panel that needs to be drawn and the xtd::drawing::graphics to use to draw to the panel. This event is only raised when the xtd::forms::status_bar_panel::style property of a xtd::forms::status_bar_panel in a xtd::forms::status_bar control is set to xtd::forms::status_bar_panel_style::owner_draw.

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

panel_click

xtd::event<status_bar, xtd::forms::status_bar_panel_click_event_handler> xtd::forms::status_bar::panel_click

Occurs when a xtd::forms::status_bar_panel object on a xtd::forms::status_bar control is clicked.

Remarks

You can use this event to perform tasks when a panel within a xtd::forms::status_bar control is clicked. The data provided to the event through the xtd::forms::status_bar_panel_click_event_args passed as a parameter to the event handler enables you to determine the xtd::forms::status_bar_panel that was clicked by the user in order to perform tasks on the selected panel.

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

---

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

• xtd.forms/include/xtd/forms/status_bar.h