Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

• Component

  • Component

    • StatusBarPanel

      • StatusBarControl

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

public class StatusBarControl : StatusBarPanel

Public Class StatusBarControl
    Inherits StatusBarPanel

Constructors

StatusBarControl()

Properties

Control

Control: Returns or sets the Control to be hosted.

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Specifies the appearance of the border for a StatusBarPanel on a StatusBar control.

public enum StatusBarPanelBorderStyle : Enum

Public Enum StatusBarPanelBorderStyle As [Enum]

Fields

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Specifies how a StatusBarPanel on a StatusBar control behaves when the control resizes.

public enum StatusBarPanelAutoSize : Enum

Public Enum StatusBarPanelAutoSize As [Enum]

Fields

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

• Control

  • StatusBar

Displays information to the user in a about the object being viewed, the object's components, or the object's operation.

public class StatusBar : Control

Public Class StatusBar
    Inherits Control

Constructors

StatusBar()

Initializes a new instance of the StatusBar class.

Properties

Dock

DockStyle: Returns or sets the docking behavior of the StatusBar control.

Panels

StatusBarPanelCollection: Returns the collection of StatusBar panels contained within the control.

Boolean: Returns or sets whether any panels that have been added to the control are displayed.

The StatusBar control displays the value of its Text property without any panels by default. When ShowPanels is set to true, the StatusBarPanel children specified in the StatusBar control are displayed; otherwise they are hidden and the Text is displayed instead.

Boolean: Returns or sets whether a sizing grip is displayed in the lower-right corner of the control.

String: Returns or sets the text displayed in the StatusBar control when if doesn't contain any StatusBarPanel or when ShowPanels is false.

The text assigned to the StatusBar is displayed only if it doesn't contain any StatusBarPanel or if the property ShowPanels is false.

HorizontalAlignment: Returns or sets how text is aligned in a StatusBar control.

Events

StatusBarPanelClickEventHandler Fired when a StatusBarPanel object on a StatusBar control is clicked.

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the collection of StatusBarPanel controls in a StatusBar control.

public class StatusBarPanelCollection : IList, ICollection, IEnumerable

Public Class StatusBarPanelCollection
    Inherits IList
    Implements ICollection, IEnumerable

Properties

IsReadOnly

Boolean: Returns a value indicating whether this collection is read-only.

Item(index)

StatusBarPanel: Returns or sets the StatusBarPanel at the specified index.

Item(name)

StatusBarPanel: Returns the StatusBarPanel identified by the name.

Methods

Add(text)

Adds a StatusBarPanel with the specified text to the collection.

Returns: StatusBarPanel. A StatusBarPanel that represents the panel that was added to the collection.

Adds a StatusBarPanel to the collection.

Returns: Int32. The zero-based index of the item in the collection.

Throws:

• ArgumentNullException The StatusBarPanel being added to the collection was null.

• ArgumentException The parent of the StatusBarPanel specified in the panel parameter is not null.

Adds an array of StatusBarPanel to the collection.

Removes all panels from the collection.

Removes and optionally disposes all StatusBarPanel objects from the collection.

Determines whether the specified StatusBarPanel is located within the collection.

Returns: Boolean. true if the StatusBarPanel is located within the collection; otherwise, false.

Determines whether the collection contains a StatusBarPanel with the specified key.

Returns: Boolean. true to indicate the collection contains a StatusBarPanel with the specified key; otherwise, false.

Returns an enumerator to use to iterate through the StatusBarPanel objects in the collection.

Returns: IEnumerator. An IEnumerator that represents the item collection.

Returns the index within the collection of the specified StatusBarPanel.

Returns: Int32. The zero-based index where the StatusBarPanel is located within the collection; otherwise, negative one (-1).

Returns the index of the first occurrence of a StatusBarPanel with the specified key.

Returns: Int32. The zero-based index of the first occurrence of the StatusBarPanel with the specified key, if found; otherwise, -1.

Inserts the specified StatusBarPanel into the collection at the specified index.

Throws:

• ArgumentNullException The panel parameter is null.

• ArgumentException The panel parameter's parent is not null.

• ArgumentOutOfRangeException The index parameter is less than zero or greater than the value of the Count property of the StatusBarPanelCollection class.

Removes the specified StatusBarPanel from the collection.

Throws:

• ArgumentNullException The StatusBarPanel assigned to the panel parameter is null.

Removes the StatusBarPanel located at the specified index within the collection.

Throws:

• ArgumentOutOfRangeException The index parameter is less than zero or greater than or equal to the value of the Count property of the StatusBarPanelCollection class.

Removes the StatusBarPanel with the specified key from the collection.

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

• MouseEventArgs

  • StatusBarPanelClickEventArgs

Provides data for the PanelClick event.

public class StatusBarPanelClickEventArgs : MouseEventArgs

Public Class StatusBarPanelClickEventArgs
    Inherits MouseEventArgs

Constructors

StatusBarPanelClickEventArgs(statusBarPanel, button, clicks, x, y)

Initializes a new instance of the StatusBarPanelClickEventArgs class.

StatusBarPanelClickEventArgs(statusBarPanel, button, clicks, x, y, role)

Initializes a new instance of the StatusBarPanelClickEventArgs class.

Initializes a new instance of the StatusBarPanelClickEventArgs class.

Properties

StatusBarPanel: Returns the StatusBarPanel to draw.

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

• Component

  • Component

    • StatusBarPanel

Represents a panel in a StatusBar control.

public class StatusBarPanel : Component

Public Class StatusBarPanel
    Inherits Component

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.

AllowHtml

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

StatusBarPanelAutoSize: Returns or sets whether the status bar panel is automatically resized.

StatusBarPanelBorderStyle: Returns or sets the border style of the status bar panel.

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

Int32: Returns or sets the index value of the image assigned to the StatusBarPanel.

Throws:

• ArgumentException The assigned value is less than -1.

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

String: Returns or sets the name of the image assigned to the StatusBarPanel.

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

Throws:

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

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

Padding: Returns or sets padding within the statusbar panel.

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

Object: Returns or sets an object that contains data about the StatusBarPanel.

String: Returns or sets the text of the status bar panel.

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

String: Returns or sets ToolTip text associated with the status bar panel.

Int32: Returns or sets the width of the status bar panel within the StatusBar control.

Throws:

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

Methods

Begins the initialization of a StatusBarPanel.

Ends the initialization of a StatusBarPanel.

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

Events

EventHandler Fired when the StatusBarPanel is clicked.

Inherited By

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the PanelClick event of a StatusBar.

public delegate void StatusBarPanelClickEventHandler(Object sender, StatusBarPanelClickEventArgs e)

Public Delegate Sub StatusBarPanelClickEventHandler(ByVal sender As [Object], ByVal e As StatusBarPanelClickEventArgs)

Parameters

Fired By