Not logged in▾
Log In Register
Forgot Password Resend Validation E-mail
In This Article

StatusBarPanel Class

Namespace:
ActiproSoftware.UI.WinForms.Controls.Bars
Assembly:
ActiproSoftware.Bars.WinForms.dll

Represents the base class for a StatusBar panel.

[TypeConverter(typeof(StatusBarPanelConverter))]
public class StatusBarPanel : UIElement, IInputElement, IUIElement, ILogicalTreeNode, IDpiAwareElement, IDisposable
Inheritance:
object MarshalByRefObject DisposableObject LogicalTreeNodeBase UIElement object
Derived:
StatusBarLabelPanel StatusBarProgressBarPanel
Implements:
IInputElement IUIElement ILogicalTreeNode IDpiAwareElement IDisposable

Constructors

StatusBarPanel()

Initializes a new instance of the StatusBarPanel class.

public StatusBarPanel()

Remarks

The default constructor initializes all fields to their default values.

Properties

AutoSize

Gets or sets the auto-size style to apply to the panel.

public StatusBarPanelAutoSize AutoSize { get; set; }

Property Value

StatusBarPanelAutoSize:

A StatusBarPanelAutoSize indicating the auto-size style to apply to the panel.

BackgroundFill

Gets or sets the BackgroundFill to use for the background of the panel.

public BackgroundFill BackgroundFill { get; set; }

Property Value

BackgroundFill:

The BackgroundFill to use for the background of the panel.

Border

Gets or sets a SimpleBorder that indicates the type of border for the panel.

public SimpleBorder Border { get; set; }

Property Value

SimpleBorder:

A SimpleBorder that indicates the type of border for the panel.

CaptureMouseWhenPressed

Indicates whether to automatically capture the mouse when the element is pressed.

protected override bool CaptureMouseWhenPressed { get; }

Property Value

bool:

true if the mouse should automatically be captured when the element is pressed; otherwise, false.

Key

Gets or sets the key of the panel.

public string Key { get; set; }

Property Value

string:

The key of the panel.

MinimumWidth

Gets or sets the minimum width for the panel.

public int MinimumWidth { get; set; }

Property Value

int:

The minimum width for the panel.

Remarks

This property is used for panels that auto-size using the Spring and Content settings.

Padding

Gets or sets a Padding that describes the padding of the panel.

public Padding Padding { get; set; }

Property Value

Padding:

A Padding that describes the padding of the panel.

StatusBar

Gets the StatusBar that contains the panel, if any.

[Browsable(false)]
public StatusBar StatusBar { get; }

Property Value

StatusBar:

The StatusBar that contains the panel, if any.

Tag

Gets or sets the object that contains user-defined data about the object.

[TypeConverter(typeof(StringConverter))]
public object Tag { get; set; }

Property Value

object:

An object that contains user-defined data about the control. The default is null.

Remarks

Any type derived from the object class can be assigned to this property.

ToolTipText

Gets or sets the tool tip text for the panel.

public string ToolTipText { get; set; }

Property Value

string:

The tool tip text for the panel.

Visible

Gets or sets whether the panel is visible.

public bool Visible { get; set; }

Property Value

bool:

true if the panel is visible; otherwise, false.

Width

Gets or sets the width of the panel.

public int Width { get; set; }

Property Value

int:

The width of the panel.

Remarks

This property is used for panels that do not auto-size.

Methods

OnMouseUp(MouseEventArgs)

Raises the MouseUp event.

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

A MouseEventArgs that contains the event data.

ResetBackgroundFill()

Resets the BackgroundFill property to its default value.

public virtual void ResetBackgroundFill()

ResetBorder()

Resets the Border property to its default value.

public virtual void ResetBorder()

ResetPadding()

Resets the Padding property to its default value.

public virtual void ResetPadding()

ShouldSerializeBackgroundFill()

Indicates whether the BackgroundFill property should be persisted.

public virtual bool ShouldSerializeBackgroundFill()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

ShouldSerializeBorder()

Indicates whether the Border property should be persisted.

public virtual bool ShouldSerializeBorder()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

ShouldSerializePadding()

Indicates whether the Padding property should be persisted.

public virtual bool ShouldSerializePadding()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

Inherited Members