New to Telerik UI for WinForms? Start a free 30-day trial

A collection that stores RadItem objects.

Definition

Namespace:Telerik.WinControls

Assembly:Telerik.WinControls.UI.dll

Syntax:

C#
public class RadCommandBarBaseItemCollection : CollectionBase, IList, ICollection, IEnumerable

Inheritance: objectCollectionBaseRadCommandBarBaseItemCollection

Implements: ICollectionIEnumerableIList

Inherited Members CollectionBase.Clear()CollectionBase.RemoveAt(int)CollectionBase.OnInsert(int, object)CollectionBase.InnerListCollectionBase.ListCollectionBase.CapacityCollectionBase.Count...

Constructors

Initializes an empty collection of command-bar items.

C#
public RadCommandBarBaseItemCollection()

Initializes a collection containing the items from the specified array.

C#
public RadCommandBarBaseItemCollection(RadCommandBarBaseItem[] value)
Parameters:valueRadCommandBarBaseItem[]

The items to add to the collection.

Initializes a collection containing the items from another command-bar item collection.

C#
public RadCommandBarBaseItemCollection(RadCommandBarBaseItemCollection value)
Parameters:valueRadCommandBarBaseItemCollection

The collection whose items are copied.

Initializes a collection whose items are synchronized with the specified element's children.

C#
public RadCommandBarBaseItemCollection(RadElement owner)
Parameters:ownerRadElement

The element that owns the collection items.

Properties

Gets or sets the item type used as the default when creating entries in the collection editor.

C#
public virtual Type DefaultType { get; set; }

Gets or sets an array of the excluded items' types for this collection.

C#
[Browsable(false)]
public virtual Type[] ExcludedTypes { get; set; }

Gets the first item, or null when the collection is empty.

C#
[Browsable(false)]
public RadItem First { get; }

Gets or sets an array of the items' types in the collection.

C#
public virtual Type[] ItemTypes { get; set; }

Gets the last item, or null when the collection is empty.

C#
[Browsable(false)]
public RadItem Last { get; }

Gets or sets the owner of the collection.

C#
public RadElement Owner { get; set; }

Gets or sets an array of the sealed items' types for this collection. That are types that are allowed but not their descendants.

C#
[Browsable(false)]
public virtual Type[] SealedTypes { get; set; }

Represents the entry at the specified index of the RadItem.

C#
public RadCommandBarBaseItem this[int index] { get; set; }
Parameters:indexint

The zero-based index of the entry to locate in the collection.

Property Value:

The entry at the specified index of the collection.

Exceptions: ArgumentOutOfRangeException

index is outside the valid range of indexes for the collection.

Gets the first found item, with Name property equal to itemName specified, case-sensitive.

C#
public RadCommandBarBaseItem this[string itemName] { get; }
Parameters:itemNamestring

item Name

Property Value:

RadItem if found, null (Nothing in VB.NET) otherwise

Methods

Adds a RadItem with the specified value to the Telerik.WinControls.RadItemCollection .

C#
public int Add(RadCommandBarBaseItem value)
Parameters:valueRadCommandBarBaseItem

The RadItem to add.

Returns:

int

The index at which the new element was inserted.

Copies the elements of an array to the end of the RadItemCollection.

C#
public void AddRange(params RadCommandBarBaseItem[] value)
Parameters:valueRadCommandBarBaseItem[]

An array of type RadItem containing the objects to add to the collection.

Adds the contents of another RadItemCollection to the end of the collection.

C#
public void AddRange(RadCommandBarBaseItemCollection value)
Parameters:valueRadCommandBarBaseItemCollection

A RadItemCollection containing the objects to add to the collection.

Moves any item marked as the add-new item to the end of the collection without raising change notifications.

C#
public void AdjustNewItem()

Gets a value indicating whether the RadItemCollection contains the specified RadItem.

C#
public bool Contains(RadCommandBarBaseItem value)
Parameters:valueRadCommandBarBaseItem

The RadItem to locate.

Returns:

bool

true if the RadItem is contained in the collection; otherwise, false.

Copies the RadItemCollection values to a one-dimensional Array instance at the specified index.

C#
public void CopyTo(RadCommandBarBaseItem[] array, int index)
Parameters:arrayRadCommandBarBaseItem[]

The one-dimensional Array that is the destination of the values copied from RadItemCollection .

indexint

The index in array where copying begins.

Exceptions: ArgumentException

array is multidimensional.

-or-

The number of elements in the RadItemCollection is greater than the available space between index and the end of array.

ArgumentNullException

array is null.

ArgumentOutOfRangeException

index is less than array's lowbound.

Returns an enumerator for the command-bar items in this collection.

C#
public RadCommandBarBaseItemCollection.RadCommandBarBaseItemEnumerator GetEnumerator()
Returns:

RadCommandBarBaseItemCollection.RadCommandBarBaseItemEnumerator

An enumerator that traverses the collection.

Returns the index of a RadItem in the RadItemCollection .

C#
public int IndexOf(RadCommandBarBaseItem value)
Parameters:valueRadCommandBarBaseItem

The RadItem to locate.

Returns:

int

The index of the RadItem of value in the RadItemCollection, if found; otherwise, -1.

Inserts a RadItem into the RadItemCollection at the specified index.

C#
public void Insert(int index, RadCommandBarBaseItem value)
Parameters:indexint

The zero-based index where value should be inserted.

valueRadCommandBarBaseItem

The RadItem to insert.

Reports the start of a clear operation and removes owned items from the owner's child collection.

C#
protected override void OnClear()

Overrides: CollectionBase.OnClear()

Reports that all items have been removed.

C#
protected override void OnClearComplete()

Overrides: CollectionBase.OnClearComplete()

Adds an inserted item to the owner's child collection and reports the completed insertion.

C#
protected override void OnInsertComplete(int index, object value)
Parameters:indexint

The index where the item was inserted.

valueobject

The inserted item.

Overrides: CollectionBase.OnInsertComplete(int, object)

Handles item-collection ownership bookkeeping and raises ItemsChanged unless notifications are suspended.

C#
protected virtual void OnItemsChanged(RadCommandBarBaseItem target, ItemsChangeOperation operation)
Parameters:targetRadCommandBarBaseItem

The affected item, or null for collection-level changes.

operationItemsChangeOperation

The operation being reported.

Reports that removal is about to occur.

C#
protected override void OnRemove(int index, object value)
Parameters:indexint

The index of the item being removed.

valueobject

The item being removed.

Overrides: CollectionBase.OnRemove(int, object)

Removes the item from the owner's child collection after it is removed from this collection.

C#
protected override void OnRemoveComplete(int index, object value)
Parameters:indexint

The index from which the item was removed.

valueobject

The removed item.

Overrides: CollectionBase.OnRemoveComplete(int, object)

C#
protected override void OnSet(int index, object oldValue, object newValue)
Parameters:indexintoldValueobjectnewValueobject

Overrides: CollectionBase.OnSet(int, object, object)

Adds the replacement item to the owner's child collection if it is not already a child.

C#
protected override void OnSetComplete(int index, object oldValue, object newValue)
Parameters:indexint

The index of the replaced item.

oldValueobject

The item previously at the index.

newValueobject

The replacement item.

Overrides: CollectionBase.OnSetComplete(int, object, object)

Reports that sorting is about to occur.

C#
protected virtual void OnSort()

Notifies the owner element that the collection order has changed.

C#
protected void OnSortComplete()

Ensures that inserted values are command-bar items.

C#
protected override void OnValidate(object value)
Parameters:valueobject

The value being validated.

Exceptions: InvalidOperationException

value is not a RadCommandBarBaseItem.

Overrides: CollectionBase.OnValidate(object)

Removes a specific RadItem from the RadItemCollection .

C#
public void Remove(RadItem value)
Parameters:valueRadItem

The RadItem to remove from the RadItemCollection .

Removes one notification suspension, if any.

C#
public void ResumeNotifications()

Sorts the elements in the entire RadElementCollection using the IComparable implementation of each element.

C#
public void Sort()

Sorts the elements in the entire RadElementCollection using the specified comparer.

C#
public void Sort(IComparer comparer)
Parameters:comparerIComparer

The IComparer implementation to use when comparing elements.

Sorts the elements in a range of elements in RadElementCollection using the specified comparer.

C#
public void Sort(int index, int count, IComparer comparer)
Parameters:indexint

The zero-based starting index of the range to sort.

countint

The length of the range to sort.

comparerIComparer

The IComparer implementation to use when comparing elements.

Suppresses ItemsChanged callbacks and item collection-owner updates until the matching call to ResumeNotifications(). Nested calls require a matching resume for each suspension; suppressed changes are not replayed.

C#
public void SuspendNotifications()

Retrieves an array of the items in the collection.

C#
public RadCommandBarBaseItem[] ToArray()
Returns:

RadCommandBarBaseItem[]

Events

Fires when item is changed.

C#
public event RadCommandBarBaseItemCollectionItemChangedDelegate ItemsChanged