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

StatusBarLabelPanel Class

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

Represents a label panel for a StatusBar.

public class StatusBarLabelPanel : StatusBarPanel, IInputElement, IUIElement, ILogicalTreeNode, IDpiAwareElement, IDisposable, IImageListProvider
Inheritance:
object MarshalByRefObject DisposableObject LogicalTreeNodeBase UIElement StatusBarPanel object
Implements:
IInputElement IUIElement ILogicalTreeNode IDpiAwareElement IDisposable IImageListProvider

Constructors

StatusBarLabelPanel()

Initializes a new instance of the StatusBarLabelPanel class.

public StatusBarLabelPanel()

Remarks

The default constructor initializes all fields to their default values.

StatusBarLabelPanel(string, int, string)

Initializes a new instance of the StatusBarLabelPanel class.

public StatusBarLabelPanel(string key, int width, string text)
Parameter Type Description
key string

The key of the panel.
width int

The width of the panel.
text string

The text to display in the panel.

StatusBarLabelPanel(string, int, string, StatusBarPanelAutoSize)

Initializes a new instance of the StatusBarLabelPanel class.

public StatusBarLabelPanel(string key, int width, string text, StatusBarPanelAutoSize autoSize)
Parameter Type Description
key string

The key of the panel.
width int

The width of the panel.
text string

The text to display in the panel.
autoSize StatusBarPanelAutoSize

The auto-size style to apply to the panel.

Properties

Enabled

Gets or sets whether the panel is enabled.

public bool Enabled { get; set; }

Property Value

bool:

true if the panel is enabled; otherwise, false.

ForeColor

Gets or sets the Color to use for drawing the Text.

public Color ForeColor { get; set; }

Property Value

Color:

The Color to use for drawing the Text.

HorizontalAlignment

Gets or sets the horizontal alignment of text in the panel.

public HorizontalAlignment HorizontalAlignment { get; set; }

Property Value

HorizontalAlignment:

A HorizontalAlignment indicating the horizontal alignment of text in the panel..

Image

Gets or sets the image that is displayed for the panel.

public Image Image { get; set; }

Property Value

Image:

The Image displayed for the panel. The default value is null.

ImageIndex

Gets or sets the index of an image within an ImageList that is displayed on the panel.

[ImageIndex]
[TypeConverter(typeof(ImageIndexConverter))]
public int ImageIndex { get; set; }

Property Value

int:

The index of an image within an ImageList that is displayed on the panel. The default value is -1.

ImageLayoutStyle

Gets or sets the layout style of the panel's image in relation to the text.

public StatusBarPanelImageLayoutStyle ImageLayoutStyle { get; set; }

Property Value

StatusBarPanelImageLayoutStyle:

The layout style of the panel's image in relation to the text.

ImageSizeToFit

Gets or sets whether the to size the panel's image to fit in the panel.

public bool ImageSizeToFit { get; set; }

Property Value

bool:

true if the panel's image should be sized to fit in the panel; otherwise, false.

InvalidateOnMouseEvents

Gets whether to invalidate the element when mouse events occur.

protected override bool InvalidateOnMouseEvents { get; }

Property Value

bool:

true if the element should be invalidated when mouse events occur.

Gets or sets whether the panel is a link.

public bool IsLink { get; set; }

Property Value

bool:

true if the panel is a link; otherwise, false.

LinkBehavior

Gets or sets the link behavior.

public StatusBarLabelPanelLinkBehavior LinkBehavior { get; set; }

Property Value

StatusBarLabelPanelLinkBehavior:

A StatusBarLabelPanelLinkBehavior that specifies the link behavior.

LinkVisited

Gets or sets whether the link has been visited.

public bool LinkVisited { get; set; }

Property Value

bool:

true if the link has been visited; otherwise, false.

Text

Gets or sets the text to display in the panel.

public string Text { get; set; }

Property Value

string:

The text to display in the panel.

TextTrimming

Gets or sets the StringTrimming to use for text in the panel.

public StringTrimming TextTrimming { get; set; }

Property Value

StringTrimming:

The StringTrimming to use for text in the panel.

Methods

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.

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.

OnRender(PaintEventArgs)

Renders the element.

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

A PaintEventArgs that contains the event data.

ResetForeColor()

Resets the ForeColor property to its default value.

public virtual void ResetForeColor()

ShouldSerializeForeColor()

Indicates whether the ForeColor property should be persisted.

public virtual bool ShouldSerializeForeColor()

Returns

bool:

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

Inherited Members