All pages
Powered by GitBook
1 of 8

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

StatusBar.StatusBarPanelCollection

Wisej.Web.StatusBar StatusBarPanelCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Represents the collection of StatusBarPanel controls in a StatusBar control.

public class StatusBarPanelCollection : IList, ICollection, IEnumerable, IList<StatusBarPanel>, ICollection<StatusBarPanel>, IEnumerable<StatusBarPanel>
Public Class StatusBarPanelCollection
    Inherits IList
    Implements ICollection, IEnumerable, IList(Of StatusBarPanel), ICollection(Of StatusBarPanel), IEnumerable(Of StatusBarPanel)

Properties

IsReadOnly

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

Item(index)

: Returns or sets the at the specified index.

Item(name)

: Returns the identified by the name.

Methods

Add(text)

Adds a with the specified text to the collection.

Parameter
Type
Description

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

Add(panel)

Adds a to the collection.

Parameter
Type
Description

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

Throws:

  • The being added to the collection was null.

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

AddRange(panels)

Adds an array of to the collection.

Parameter
Type
Description

Clear()

Removes all panels from the collection.

Clear(dispose)

Removes and optionally disposes all objects from the collection.

Parameter
Type
Description

Contains(panel)

Determines whether the specified is located within the collection.

Parameter
Type
Description

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

ContainsKey(key)

Determines whether the collection contains a with the specified key.

Parameter
Type
Description

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

GetEnumerator()

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

Returns: . An that represents the item collection.

IndexOf(panel)

Returns the index within the collection of the specified .

Parameter
Type
Description

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

IndexOfKey(key)

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

Parameter
Type
Description

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

Insert(index, panel)

Inserts the specified into the collection at the specified index.

Parameter
Type
Description

Throws:

  • The panel parameter is null.

  • The panel parameter's parent is not null.

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

Remove(panel)

Removes the specified from the collection.

Parameter
Type
Description

Throws:

  • The assigned to the panel parameter is null.

RemoveAt(index)

Removes the located at the specified index within the collection.

Parameter
Type
Description

Throws:

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

RemoveByKey(key)

Removes the with the specified key from the collection.

Parameter
Type
Description

text

String

The text for the StatusBarPanel that is being added.

panel

StatusBarPanel

A StatusBarPanel that represents the panel to add to the collection.

panels

StatusBarPanel[]

Array of StatusBarPanel objects to add to the collection.

dispose

Boolean

Indicates whether the removed StatusBarPanel objects should be disposed.

panel

StatusBarPanel

The StatusBarPanel to locate in the collection.

key

String

The name of the item to find in the collection.

panel

StatusBarPanel

The StatusBarPanel to locate in the collection.

key

String

The name of the StatusBarPanel to find in the collection.

index

Int32

The zero-based index location where the panel is inserted.

panel

StatusBarPanel

A StatusBarPanel representing the panel to insert.

panel

StatusBarPanel

The StatusBarPanel representing the panel to remove from the collection.

index

Int32

The zero-based index of the item to remove.

key

String

The name of the StatusBarPanel to remove from the collection.

Boolean
StatusBarPanel
StatusBarPanel
StatusBarPanel
StatusBarPanel
StatusBarPanel
StatusBarPanel
StatusBarPanel
StatusBarPanel
Int32
ArgumentNullException
StatusBarPanel
ArgumentException
StatusBarPanel
StatusBarPanel
StatusBarPanel
StatusBarPanel
Boolean
StatusBarPanel
StatusBarPanel
Boolean
StatusBarPanel
StatusBarPanel
IEnumerator
IEnumerator
StatusBarPanel
Int32
StatusBarPanel
StatusBarPanel
Int32
StatusBarPanel
StatusBarPanel
ArgumentNullException
ArgumentException
ArgumentOutOfRangeException
Count
StatusBarPanelCollection
StatusBarPanel
ArgumentNullException
StatusBarPanel
StatusBarPanel
ArgumentOutOfRangeException
Count
StatusBarPanelCollection
StatusBarPanel

StatusBarPanelAutoSize

Wisej.Web.StatusBarPanelAutoSize

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.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

Name
Description

Used By

Name
Description

Contents

The width of the StatusBarPanel is determined by its contents.

None

The StatusBarPanel does not change size when the StatusBar control resizes.

Spring

The StatusBarPanel uses the available space on the StatusBar (the space not taken up by other panels whose AutoSize property is set to None or Contents) and shares it with other panels that have their AutoSize property set to Spring.

StatusBarPanel.AutoSize

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

StatusBarPanelBorderStyle

Wisej.Web.StatusBarPanelBorderStyle

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.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

Name
Description

Used By

Name
Description

StatusBarPanelClickEventHandler

Wisej.Web.StatusBarPanelClickEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.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

Name
Type
Description

Fired By

Name
Description

Dashed

A dashed line border.

Dotted

A dotted line border.

Double

A double solid line border.

None

No border.

Solid

A solid line border.

StatusBarPanel.BorderStyle

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

sender

Object

The source of the event.

e

StatusBarPanelClickEventArgs

A StatusBarPanelClickEventArgs that contains the event data.

StatusBar.PanelClick

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

StatusBar

Wisej.Web.StatusBar

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.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.

Constructors

StatusBar()

Initializes a new instance of the class.

Properties

DefaultSize

: Returns the default size of the control.

Dock

: Returns or sets the docking behavior of the control. (Default: Bottom)

PanelCount

: Returns the number of child panels without forcing the creation of the collection.

Panels

: Returns the collection of panels contained within the control.

ShowPanels

: Returns or sets whether any panels that have been added to the control are displayed. (Default: True)

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

SizingGrip

: Returns or sets whether a sizing grip is displayed in the lower-right corner of the control. (Default: True)

Text

: Returns or sets the text displayed in the control when if doesn't contain any or when is false. (Default: "")

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

TextAlign

: Returns or sets how text is aligned in a control. (Default: Left)

Methods

Dispose(disposing)

Disposes of the resources (other than memory) used by the .

Parameter
Type
Description

OnAddReferences(items)

Returns a collection of referenced components or collection of components.

Parameter
Type
Description

OnBindingContextChanged(e)

Fires the event.

Parameter
Type
Description

OnPanelClick(e)

Fires the event.

Parameter
Type
Description

OnWebEvent(e)

Processes the event from the client.

Parameter
Type
Description

OnWebRender(config)

Renders the client component.

Parameter
Type
Description

Events

PanelClick

Fired when a object on a control is clicked.

Implements

Name
Description

StatusBarControl

Wisej.Web.StatusBarControl

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

  • Component

    • Component

Represents a panel in a control that can host any .

Constructors

StatusBarControl()

Initializes a new instance of .

Properties

Control

: Returns or sets the to be hosted. (Default: null)

Methods

OnAddReferences(items)

Adds references components to the list. Referenced components can be added individually or as a reference to a collection.

Parameter
Type
Description

OnWebEvent(e)

Processes the event from the client.

Parameter
Type
Description

OnWebRender(config)

Renders the client component.

Parameter
Type
Description

Implements

Name
Description

disposing

Boolean

true when this method is called by the application rather than a finalizer.

items

IList

e

EventArgs

An EventArgs that contains the event data.

e

StatusBarPanelClickEventArgs

A StatusBarPanelClickEventArgs that contains the event data.

e

WisejEventArgs

Event arguments.

config

Object

Dynamic configuration object.

IUserData

Provides access to the UserData and Tag properties associated to the component implementing this interface.

IBindableComponent

Bindable components implement this interface.

IDropTarget

Controls that support drag & drop operations implement this interface.

IWisejComponent

All wisej components implement this interface.

IWisejControl

All wisej controls derived from the Control class must implement this interface.

IWisejSerializable

Allows an object to serialize itself.

Public Class StatusBar
    Inherits Control
StatusBar
Size
DockStyle
StatusBar
Int32
StatusBarPanelCollection
StatusBar
Boolean
Text
StatusBarPanel
Text
Boolean
String
StatusBar
StatusBarPanel
ShowPanels
StatusBar
StatusBarPanel
ShowPanels
HorizontalAlignment
StatusBar
StatusBar
BindingContextChanged
OnPanelClick
StatusBarPanelClickEventHandler
StatusBarPanel
StatusBar
public class StatusBar : Control

items

IList

Container for the referenced components or collections.

e

WisejEventArgs

Event arguments.

config

Object

Dynamic configuration object.

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.

BindableComponent
StatusBarPanel
StatusBarControl
StatusBar
Control
Public Class StatusBarControl
    Inherits StatusBarPanel
StatusBarControl
Control
Control
public class StatusBarControl : StatusBarPanel

StatusBarPanel

Wisej.Web.StatusBarPanel

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

  • Component

    • Component

Represents a panel in a control.

Constructors

StatusBarPanel()

Initializes a new instance of the class.

Properties

Alignment

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

AllowHtml

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

AutoSize

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

BorderStyle

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

Icon

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

IconIndex

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

Throws:

  • The assigned value is less than -1.

IconSource

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

ImageKey

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

MinWidth

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

Throws:

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

Name

: Returns or sets the name to apply to the .

Padding

: Returns or sets padding within the statusbar panel.

Parent

: Returns the control that hosts the status bar panel.

Tag

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

Text

: 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

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

Width

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

Throws:

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

Methods

BeginInit()

Begins the initialization of a .

Dispose(disposing)

Disposes the and removes it from the .

Parameter
Type
Description

EndInit()

Ends the initialization of a .

OnClick(e)

Fires the event.

Parameter
Type
Description

OnWebRender(config)

Renders the client component.

Parameter
Type
Description

Update()

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

Events

Click

Fired when the is clicked.

Inherited By

Name
Description

Implements

Name
Description

StatusBarPanelClickEventArgs

Wisej.Web.StatusBarPanelClickEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Provides data for the

disposing

Boolean

true when this method is called by the application rather than a finalizer.

e

EventArgs

An EventArgs that contains the event data.

config

Object

Dynamic configuration object.

StatusBarControl

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

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.

BindableComponent
StatusBarPanel
StatusBar
Public Class StatusBarPanel
    Inherits BindableComponent
StatusBarPanel
HorizontalAlignment
Boolean
StatusBarPanelAutoSize
StatusBarPanelBorderStyle
Image
Int32
StatusBarPanel
ArgumentException
String
StatusBarPanel
String
StatusBarPanel
Int32
StatusBar
ArgumentException
String
StatusBarPanel
Padding
StatusBar
StatusBar
Object
StatusBarPanel
String
String
Int32
StatusBar
ArgumentException
MinWidth
StatusBarPanel
StatusBarPanel
StatusBar
StatusBarPanel
Click
EventHandler
StatusBarPanel
public class StatusBarPanel : BindableComponent
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.

Name
Type
Description

statusBarPanel

The that represents the panel that was clicked.

button

One of the values that represents the mouse buttons that were clicked while over the .

clicks

The number of times that the mouse button was clicked.

x

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

Initializes a new instance of the StatusBarPanelClickEventArgs class.

Name
Type
Description

statusBarPanel

The that represents the panel that was clicked.

button

One of the values that represents the mouse buttons that were clicked while over the .

clicks

The number of times that the mouse button was clicked.

x

StatusBarPanelClickEventArgs(args)

Initializes a new instance of the StatusBarPanelClickEventArgs class.

Name
Type
Description

args

The event arguments received from the client.

Properties

StatusBarPanel

StatusBarPanel: Returns the StatusBarPanel to draw.

Used By

Name
Description

Represents the method that will handle the event of a .

MouseEventArgs
StatusBarPanelClickEventArgs
PanelClick

The x-coordinate of the mouse click.

y

Int32

The y-coordinate of the mouse click.

The x-coordinate of the mouse click.

y

Int32

The y-coordinate of the mouse click.

role

String

The internal role assigned to the element that generated the pointer event.

StatusBarPanel
StatusBarPanel
MouseButtons
MouseButtons
StatusBarPanel
Int32
Int32
StatusBarPanel
StatusBarPanel
MouseButtons
MouseButtons
StatusBarPanel
Int32
Int32
WisejEventArgs
StatusBarPanelClickEventHandler
PanelClick
StatusBar