Class GroupBar.GroupBarItemCollection
The collection of GroupBarItem objects in the GroupBar control.
Inheritance
Implements
Inherited Members
Namespace: Syncfusion.Windows.Forms.Tools
Assembly: Syncfusion.Shared.Base.dll
Syntax
public class GroupBarItemCollection : CollectionBase, IList, ICollection, IEnumerable
Remarks
Each group in the GroupBar is an instance of the GroupBarItem type and the collection of these groups is represented by an instance of the GroupBarItemCollection class. GroupBarItems may be added or removed using the IList and ICollection interface methods implemented by the GroupBarItemCollection. GroupBarItems
Constructors
GroupBarItemCollection(GroupBar)
Creates an instance of the GroupBarItemCollection class.
Declaration
public GroupBarItemCollection(GroupBar groupbar)
Parameters
Type | Name | Description |
---|---|---|
GroupBar | groupbar | The GroupBar control that contains this collection. |
Fields
bLockUpdate
Declaration
protected bool bLockUpdate
Field Value
Type |
---|
System.Boolean |
groupBarHost
Declaration
protected GroupBar groupBarHost
Field Value
Type |
---|
GroupBar |
Properties
Item[Int32]
Gets / sets a GroupBarItem in the collection.
Declaration
public GroupBarItem this[int index] { get; set; }
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | The zero-based index of the GroupBarItem to get / set. |
Property Value
Type |
---|
GroupBarItem |
Methods
Add(GroupBarItem)
Adds the GroupBarItem to the collection.
Declaration
public int Add(GroupBarItem item)
Parameters
Type | Name | Description |
---|---|---|
GroupBarItem | item | The GroupBarItem to be added. |
Returns
Type | Description |
---|---|
System.Int32 | The index of the new item within the collection. |
AddRange(GroupBarItem[])
Adds an array of GroupBarItems to the GroupBar control's GroupBarItems collection.
Declaration
public void AddRange(GroupBarItem[] items)
Parameters
Type | Name | Description |
---|---|---|
GroupBarItem[] | items | An array of GroupBarItem objects. |
Contains(GroupBarItem)
Indicates whether the specified GroupBarItem is present in the collection.
Declaration
public bool Contains(GroupBarItem item)
Parameters
Type | Name | Description |
---|---|---|
GroupBarItem | item | The GroupBarItem to locate in the collection. |
Returns
Type | Description |
---|---|
System.Boolean | True if the item is present; False otherwise. |
CopyTo(GroupBarItem[], Int32)
Declaration
public void CopyTo(GroupBarItem[] array, int index)
Parameters
Type | Name | Description |
---|---|---|
GroupBarItem[] | array | |
System.Int32 | index |
IndexOf(GroupBarItem)
Returns the zero-based index of the GroupBarItem in the collection.
Declaration
public int IndexOf(GroupBarItem item)
Parameters
Type | Name | Description |
---|---|---|
GroupBarItem | item | The GroupBarItem to locate in the collection. |
Returns
Type | Description |
---|---|
System.Int32 | The zero-based index of the item; -1 if the item is not present. |
Insert(Int32, GroupBarItem)
Inserts the GroupBarItem into the collection at the specified index.
Declaration
public void Insert(int index, GroupBarItem item)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | The zero-based index at which the item is to be inserted. |
GroupBarItem | item | The GroupBarItem to be inserted. |
OnClearComplete()
Declaration
protected override void OnClearComplete()
Overrides
OnInsert(Int32, Object)
Declaration
protected override void OnInsert(int index, object value)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | |
System.Object | value |
Overrides
OnInsertComplete(Int32, Object)
Declaration
protected override void OnInsertComplete(int index, object value)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | |
System.Object | value |
Overrides
Remove(GroupBarItem)
Removes the GroupBarItem from the collection.
Declaration
public void Remove(GroupBarItem item)
Parameters
Type | Name | Description |
---|---|---|
GroupBarItem | item | The GroupBarItem to be removed. |
RemoveAt(Int32)
Removes the GroupBarItem specified by the index parameter.
Declaration
public void RemoveAt(int index)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | A zero-based index specifying the GroupBarItem to be removed. |