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

#include <status_bar.h>

Definition

Represents a Windows status bar control.

class forms_export_ status_bar : public xtd::forms::control
Inheritance
xtd::objectxtd::forms::componentxtd::forms::controlxtd::forms::status_bar
Namespace
xtd::forms
Library
xtd.forms
Examples
The following code example demonstrates the use of xtd::forms::status_bar control.
#include <xtd/xtd>
using namespace xtd;
using namespace xtd::drawing;
using namespace xtd::forms;
namespace examples {
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.border_style(xtd::forms::status_bar_panel_border_style::sunken);
status_bar_panel1.tool_tip_text("Status one tool tip text");
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.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 image image_from_color(const color& color) {
bitmap bitmap(16, 16);
auto g = graphics::from_image(bitmap);
g.fill_ellipse(solid_brush(color), 0, 0, bitmap.width(), bitmap.height());
g.draw_ellipse(pens::black(), 0, 0, bitmap.width() - 1, bitmap.height() - 1);
return 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);
};
}
int main() {
application::run(examples::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.

Protected Attributes

friend form
 
friend status_bar_panel
 

Alias

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

Constructors

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

Properties

xtd::drawing::font default_font () const override
 Gets the default font of the control. More...
 
drawing::size default_size () const override
 Gets the default size of the control. More...
 
dock_style dock () const override
 Gets which control borders are docked to its parent control and determines how a control is resized with its parent. More...
 
controldock (dock_style dock) override
 Sets which control borders are docked to its parent control and determines how a control is resized with its parent. More...
 
const status_bar_panel_collectionpanels () const
 Gets the collection of xtd::forms::status_bar panels contained within the control. More...
 
status_bar_panel_collectionpanels ()
 Gets the collection of xtd::forms::status_bar panels contained within the control. More...
 
virtual bool show_panels () const
 Gets a value indicating whether any panels that have been added to the control are displayed. More...
 
virtual status_barshow_panels (bool value)
 Sets a value indicating whether any panels that have been added to the control are displayed. More...
 
virtual bool show_tool_tips () const
 Gets a value indicating whether the status bar displays a xtd::forms::tool_tip for each button. More...
 
virtual status_barshow_tool_tips (bool value)
 Sets a value indicating whether the status bar displays a xtd::forms::tool_tip for each button. More...
 
virtual bool sizing_grip () const
 Gets a value indicating whether a sizing grip is displayed in the lower-right corner of the control. More...
 
virtual status_barsizing_grip (bool value)
 Sets a value indicating whether a sizing grip is displayed in the lower-right corner of the control. More...
 

Events

xtd::event< status_bar, xtd::forms::status_bar_draw_item_event_handlerdraw_item
 Occurs when a visual aspect of an owner-drawn status bar control changes. More...
 
xtd::event< status_bar, xtd::forms::status_bar_panel_click_event_handlerpanel_click
 Occurs when a xtd::forms::status_bar_panel object on a xtd::forms::status_bar control is clicked. More...
 

Protetced properties

forms::create_params create_params () const override
 Gets the required creation parameters when the control handle is created. More...
 

Protetced methods

virtual void on_draw_item (xtd::forms::status_bar_draw_item_event_args &e)
 Raises the xtd::forms::status_bar::daw_item event. More...
 
virtual void on_panel_click (const xtd::forms::status_bar_panel_click_event_args &e)
 Raises the xtd::forms::status_bar::panel_click event. More...
 
void on_handle_created (const event_args &e) override
 Raises the xtd::forms::control::handle_created event. More...
 
void on_handle_destroyed (const event_args &e) override
 Raises the xtd::forms::control::handle_destroyed event. More...
 
void on_paint (xtd::forms::paint_event_args &e) override
 Raises the xtd::forms::control::paint event. More...
 
void on_main_panel_paint (object &sender, xtd::forms::paint_event_args &e)
 
void on_resize (const event_args &e) override
 Raises the xtd::forms::control::region event. More...
 
void wnd_proc (message &message) override
 Processes Windows messages. More...
 

Additional Inherited Members

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

Member Typedef Documentation

◆ status_bar_panel_collection

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

◆ create_params()

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

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

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

Reimplemented from xtd::forms::control.

◆ default_font()

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

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
overridevirtual

Gets the default size of the control.

Returns
The default size of the control.

Reimplemented from xtd::forms::control.

◆ dock() [1/2]

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

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
dockOne of the td::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.

◆ 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
eA 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_handle_created()

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

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

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

Reimplemented from xtd::forms::control.

◆ 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
eAn 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
eAn xtd::event_args that contains the event data.

Reimplemented from xtd::forms::control.

◆ 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
eA 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_resize()

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

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

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

Reimplemented from xtd::forms::control.

◆ panels() [1/2]

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

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
virtual

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
valuetrue 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
virtual

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
valuetrue 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
virtual

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

◆ wnd_proc()

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

Processes Windows messages.

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

Reimplemented from xtd::forms::control.

Member Data Documentation

◆ 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

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: