StatusBarPanel

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.1.0.0)

• Component
  • Component
    • BindableComponent
      • StatusBarPanel

Represents a panel in a StatusBar control.

C#

public class StatusBarPanel : BindableComponent

VB.NET

Public Class StatusBarPanel
    Inherits BindableComponent

Constructors

StatusBarPanel()

Initializes a new instance of the StatusBarPanel class.

Properties

Alignment

HorizontalAlignment: Returns or sets the alignment of text and icons within the status bar panel. (Default: Left)

AllowHtml

Boolean: Returns or sets a value indicating that the control can display html in the Text property. (Default: False)

AutoSize

StatusBarPanelAutoSize: Returns or sets whether the status bar panel is automatically resized. (Default: None)

BorderStyle

StatusBarPanelBorderStyle: Returns or sets the border style of the status bar panel. (Default: Solid)

Icon

Image: Returns or sets the icon to display within the status bar panel.

IconIndex

Int32: Returns or sets the index value of the image assigned to the StatusBarPanel. (Default: -1)

Throws:

• ArgumentException The assigned value is less than -1.

IconSource

String: Returns or sets the theme name or URL for the icon to display in the StatusBarPanel.

ImageKey

String: Returns or sets the name of the image assigned to the StatusBarPanel. (Default: "")

MinWidth

Int32: Returns or sets the minimum allowed width of the status bar panel within the StatusBar control. (Default: 10)

Throws:

• ArgumentException A value less than 0 is assigned to the property.

Name

String: Returns or sets the name to apply to the StatusBarPanel.

Padding

Padding: Returns or sets padding within the statusbar panel.

Parent

StatusBar: Returns the StatusBar control that hosts the status bar panel.

Tag

Object: Returns or sets an object that contains data about the StatusBarPanel. (Default: null)

Text

String: Returns or sets the text of the status bar panel. (Default: "")

When AllowHtml is set to true, the text can contain HTML content. If the text contains new lines (CRLF) but doesn't contain HTML elements (at least one "<") all CRLF are automatically substituted with "<br/>".

ToolTipText

String: Returns or sets ToolTip text associated with the status bar panel. (Default: "")

Width

Int32: Returns or sets the width of the status bar panel within the StatusBar control. (Default: 100)

Throws:

• ArgumentException The width specified is less than the value of the MinWidth property.

Methods

BeginInit()

Begins the initialization of a StatusBarPanel.

Dispose(disposing)

Disposes the StatusBarPanel and removes it from the StatusBar.

Parameter	Type	Description
disposing	Boolean	true when this method is called by the application rather than a finalizer.

EndInit()

Ends the initialization of a StatusBarPanel.

OnClick(e)

Fires the Click event.

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

OnWebRender(config)

Renders the client component.

Parameter	Type	Description
config	Object	Dynamic configuration object.

Update()

Updates the component on the client. Overridden to repaint the parent control in design mode.

Events

Click

EventHandler Fired when the StatusBarPanel is clicked.

Inherited By

Name	Description
StatusBarControl	Represents a panel in a StatusBar control that can host any Control.

Implements

Name	Description
IUserData	Provides access to the UserData and Tag properties associated to the component implementing this interface.
IBindableComponent	Bindable components implement this interface.
IWisejComponent	All wisej components implement this interface.
IWisejSerializable	Allows an object to serialize itself.