In This Article

StatusBar Class

Represents a statusbar control.

[ToolboxBitmap(typeof(StatusBar))]
public class StatusBar : UIControl, IUIControl, IUIElement, ILogicalTreeNode, IDpiAwareElement, IDisposable, IWeakEventListener
Inheritance:
object MarshalByRefObject Component Control ScrollableControl UIControl object
Implements:
IUIControl IUIElement ILogicalTreeNode IDpiAwareElement IDisposable IWeakEventListener

Constructors

StatusBar()

Initializes a new instance of the StatusBar class.

public StatusBar()

Remarks

The default constructor initializes all fields to their default values.

Properties

Anchor

Gets or sets which edges of the control are anchored to the edges of its container.

[Browsable(false)]
public override AnchorStyles Anchor { get; set; }

Property Value

AnchorStyles:

A bitwise combination of the AnchorStyles values. The default is Top and Left.

Dock

Gets or sets which edge of the parent container a control is docked to.

public override DockStyle Dock { get; set; }

Property Value

DockStyle:

One of the DockStyle values. The default is Bottom.

Enabled

Gets or sets a value indicating whether the control can respond to user interaction.

[Browsable(false)]
public bool Enabled { get; set; }

Property Value

bool:

true if the control can respond to user interaction; otherwise, false. The default is true.

GripperVisible

Gets or sets whether the gripper is visible.

public bool GripperVisible { get; set; }

Property Value

bool:

true if the gripper is visible; otherwise, false.

ImageList

Gets or sets the ImageList used for panel images.

public ImageList ImageList { get; set; }

Property Value

ImageList:

An ImageList. The default value is a null reference.

Panels

Gets the StatusBarPanelCollection containing the panels in the control.

public StatusBarPanelCollection Panels { get; }

Property Value

StatusBarPanelCollection:

The StatusBarPanelCollection containing the panels in the control.

Renderer

Gets or sets the control-specific IStatusBarRenderer used to render the control.

public IStatusBarRenderer Renderer { get; set; }

Property Value

IStatusBarRenderer:

The control-specific IStatusBarRenderer used to render the control.

Remarks

If this value is null, then the global renderer will be used instead.

RendererResolved

Gets the IStatusBarRenderer used to render the control.

[Browsable(false)]
public IStatusBarRenderer RendererResolved { get; }

Property Value

IStatusBarRenderer:

The IStatusBarRenderer used to render the control.

Remarks

This property will return a global renderer if there is no control instance renderer override. The registered renderer type with the UIRendererManager for this property is IStatusBarRenderer.

TabIndex

Gets or sets the tab order of the control within its container.

[Browsable(false)]
public int TabIndex { get; set; }

Property Value

int:

The index value of the control within the set of controls within its container that are included in the tab order.

TabStop

Gets or sets a value indicating whether the user can give the focus to this control using the TAB key.

[Browsable(false)]
public bool TabStop { get; set; }

Property Value

bool:

true if the user can give the focus to the control using the TAB key; otherwise, false. The default is true.

Methods

ArrangeOverride(Size)

Positions child elements and determines an arrange size.

protected override Size ArrangeOverride(Size finalSize)
Parameter Type Description
finalSize Size

The final area within the parent that this element should use to arrange itself and its children.

Returns

Size:

The actual size used.

Remarks

Element authors should override this method, call Arrange on each visible child element and position each child element. It is required that a parent element calls Arrange on each child or they won't be rendered.

CreateChildren()

Invoked when the collection of child elements is to be created.

protected override IList CreateChildren()

Returns

IList:

The IList that should be assigned to the Children property.

Remarks

By default no child collection is created.

Dispose(bool)

Disposes any resources used by the object.

protected override void Dispose(bool disposing)
Parameter Type Description
disposing bool

Whether the object is being disposed.

DpiScaleChanged(SizeF)

Called when the DPI-based scale factor of the element changes.

public override void DpiScaleChanged(SizeF scaleFactor)
Parameter Type Description
scaleFactor SizeF

The new scale factor where Width is applied to the x-axis, and Height is applied to the y-axis.

See Also

GetCursor(Point)

Gets the Cursor that should be used when the mouse is over the element at the specified Point.

public override Cursor GetCursor(Point point)
Parameter Type Description
point Point

The Point to examine.

Returns

Cursor:

The Cursor that should be used when the mouse is over the element at the specified Point.

MeasureOverride(Graphics, Size)

Measures the size in layout required for child elements and determines a size for the element itself.

protected override Size MeasureOverride(Graphics g, Size availableSize)
Parameter Type Description
g Graphics

The Graphics object to use for measurement.

availableSize Size

The available size that this element can give to child elements. Infinity can be specified as a value to indicate that the element will size to whatever content is available.

Returns

Size:

The size that this element determines it needs during layout, based on its calculations of child element sizes.

Remarks

Element authors should override this method, call Measure on each visible child element and determine the total size required.

OnMouseLeave(EventArgs)

Raises the OnMouseLeave event.

protected override void OnMouseLeave(EventArgs e)
Parameter Type Description
e EventArgs

An EventArgs that contains the event data.

OnMouseMove(MouseEventArgs)

Raises the OnMouseMove event.

protected override void OnMouseMove(MouseEventArgs e)
Parameter Type Description
e MouseEventArgs

A MouseEventArgs that contains the event data.

OnRender(PaintEventArgs)

Renders the element.

protected override void OnRender(PaintEventArgs e)
Parameter Type Description
e PaintEventArgs

A PaintEventArgs that contains the event data.

OnStatusBarPanelClick(StatusBarPanelMouseEventArgs)

Raises the StatusBarPanelClick event.

protected virtual void OnStatusBarPanelClick(StatusBarPanelMouseEventArgs e)
Parameter Type Description
e StatusBarPanelMouseEventArgs

A StatusBarPanelMouseEventArgs that contains the event data.

WndProc(ref Message)

Occurs when a message is sent to the control.

protected override void WndProc(ref Message m)
Parameter Type Description
m Message

Information about the message.

Events

StatusBarPanelClick

Occurs when a StatusBarPanel is clicked..

public event StatusBarPanelMouseEventHandler StatusBarPanelClick

Event Type

StatusBarPanelMouseEventHandler

Inherited Members