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

StatusBarPanelCollection Class

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

Represents a collection of StatusBarPanel objects.

public class StatusBarPanelCollection : UIElementCollection, IDisposable
Inheritance:
object MarshalByRefObject DisposableObject LogicalTreeNodeCollection UIElementCollection object
Implements:
IDisposable

Remarks

This class is a zero-based indexed collection.

Constructors

StatusBarPanelCollection(IUIElement)

Initializes a new instance of the StatusBarPanelCollection class.

public StatusBarPanelCollection(IUIElement owner)
Parameter Type Description
owner IUIElement

The owner of the collection.

See Also

Properties

IsReadOnly

Gets a value indicating whether the collection is read-only.

public override bool IsReadOnly { get; }

Property Value

bool:

true if the collection is read-only; otherwise, false.

See Also

this[int]

Gets or sets the StatusBarPanel at the specified index.

[C#] In C#, this property is the indexer for the StatusBarPanelCollection class. 

public StatusBarPanel this[int index] { get; set; }
Parameter Type Description
index int

The index of the StatusBarPanel to return.

Property Value

StatusBarPanel:

The StatusBarPanel at the specified index.

See Also

this[string]

Gets the StatusBarPanel with the specified key.

public StatusBarPanel this[string key] { get; }
Parameter Type Description
key string

The key of the StatusBarPanel to return.

Property Value

StatusBarPanel:

The StatusBarPanel with the specified key.

See Also

SingularElementName

Gets the short, singular name of the type of child elements in the collection.

protected override string SingularElementName { get; }

Property Value

string:

The short, singular name of the type of child elements in the collection.

Remarks

This value is used within the design-time environment when indicating the count of elements in the collection.

See Also

Methods

Add(StatusBarPanel)

Adds the specified item to the collection.

public int Add(StatusBarPanel item)
Parameter Type Description
item StatusBarPanel

The StatusBarPanel to add to the collection.

Returns

int:

The position into which the new item was inserted.

See Also

AddRange(StatusBarPanel[])

Adds multiple items to the collection.

public void AddRange(StatusBarPanel[] items)
Parameter Type Description
items StatusBarPanel[]

The array of StatusBarPanel objects to add.

See Also

Clear()

Removes all items from the collection.

public void Clear()

See Also

Contains(string)

Determines whether the a StatusBarPanel with the specified key is in the collection.

public virtual bool Contains(string key)
Parameter Type Description
key string

The key of the StatusBarPanel to look for.

Returns

bool:

true if the collection contains a StatusBarPanel with the specified key; otherwise, false.

See Also

IndexOf(string)

Returns the index of the StatusBarPanel with the specified key in the collection.

public int IndexOf(string key)
Parameter Type Description
key string

The key of the StatusBarPanel to look for.

Returns

int:

If found, the index where the StatusBarPanel is in the collection; otherwise, -1.

See Also

Insert(int, StatusBarPanel)

Inserts a StatusBarPanel into the collection at the specified index.

public void Insert(int index, StatusBarPanel item)
Parameter Type Description
index int

The zero-based index at which the StatusBarPanel should be inserted.
item StatusBarPanel

The StatusBarPanelto insert.

See Also

OnObjectAdded(int, ILogicalTreeNode)

Performs additional custom processes after an object is added to the collection.

protected override void OnObjectAdded(int index, ILogicalTreeNode value)
Parameter Type Description
index int

The zero-based index at which the object was inserted.
value ILogicalTreeNode

The object that was inserted.

Remarks

The default implementation of this method is intended to be overridden by a derived class to perform some action after the specified object is added.

See Also

OnObjectRemoving(int, ILogicalTreeNode)

Performs additional custom processes before an object is removed from the collection.

protected override void OnObjectRemoving(int index, ILogicalTreeNode value)
Parameter Type Description
index int

The zero-based index from which the object was removed.
value ILogicalTreeNode

The object that was removed.

Remarks

The default implementation of this method is intended to be overridden by a derived class to perform some action before the specified object is removed.

See Also

Remove(StatusBarPanel)

Removes the specified StatusBarPanel from the collection.

public void Remove(StatusBarPanel pane)
Parameter Type Description
pane StatusBarPanel

The StatusBarPanel to remove.

See Also

RemoveAt(int)

Removes the StatusBarPanel at the specified index from the collection.

public void RemoveAt(int index)
Parameter Type Description
index int

The index of the StatusBarPanel to remove.

See Also

ToArray()

Copies the items of the collection to a new StatusBarPanel array.

public StatusBarPanel[] ToArray()

Returns

StatusBarPanel[]:

An array of StatusBarPanel items.

See Also

Inherited Members

See Also