BarCommandLinkCollection Class

public class BarCommandLinkCollection : UIElementCollection, IDisposable

public BarCommandLink this[int index] { get; }

Parameter	Type	Description
index	int	The index of the item to return.

Property Value

BarCommandLink:

The BarCommandLink at the specified index.

public BarCommandLink this[string commandFullName] { get; }

Parameter	Type	Description
commandFullName	string	The FullName to locate in the collection.

Property Value

BarCommandLink:

The first BarCommandLink in the collection that is based on a BarCommand with the specified FullName.

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

• PluralElementName

public BarCommandLink Add(BarCommandLink item)

Parameter	Type	Description
item	BarCommandLink	The BarCommandLink to add to the collection.

Returns

BarCommandLink:

The BarCommandLink that was created.

public void AddRange(BarCommandLink[] items)

Parameter	Type	Description
items	BarCommandLink[]	The array of BarCommandLink objects to add.

public void Clear()

public BarCommandLink[] CloneToArray()

Returns

BarCommandLink[]:

An array of BarCommandLink items.

public virtual bool Contains(string commandFullName)

Parameter	Type	Description
commandFullName	string	The FullName to locate in the collection.

Returns

bool:

true if a BarCommandLink that is based on a BarCommand with the specified FullName is in the collection; otherwise, false.

public int FindNextVisibleCommandLink(int startIndex)

Parameter	Type	Description
startIndex	int	The index of the exclusive starting point of the search.

Returns

int:

The index of the next visible BarCommandLink that occurs after the specified index.

public int FindPreviousVisibleCommandLink(int startIndex)

Parameter	Type	Description
startIndex	int	The index of the exclusive starting point of the search.

Returns

int:

The index of the next visible BarCommandLink that occurs before the specified index.

public virtual int IndexOf(string commandFullName, bool visibleOnly)

Parameter	Type	Description
commandFullName	string	The FullName to locate in the collection.
visibleOnly	bool	Whether to only look for visible command links.

Returns

int:

The zero-based index of the first occurrence of a BarCommandLink that is based on a BarCommand with the specified FullName within the entire collection, if found; otherwise, -1.

public virtual int IndexOf(string commandFullName, string defaultText, int startIndex, bool visibleOnly)

Parameter	Type	Description
commandFullName	string	The FullName to locate in the collection.
defaultText	string	The default text of the BarCommandLink. This value can be null to allow any default text.
startIndex	int	The start index to search.
visibleOnly	bool	Whether to only look for visible command links.

Returns

int:

The zero-based index of the first occurrence of a BarCommandLink that is based on a BarCommand with the specified FullName at or after the start index, if found; otherwise, -1.

public BarCommandLink Insert(int index, BarCommandLink item)

Parameter	Type	Description
index	int	The zero-based index at which the BarCommandLink should be inserted.
item	BarCommandLink	The BarCommandLinkto insert.

Returns

BarCommandLink:

The BarCommandLink that was inserted.

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.

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.

protected override void OnValidate(ILogicalTreeNode value, int existingIndex)

Parameter	Type	Description
value	ILogicalTreeNode	The object to validate.
existingIndex	int	The index within the collection of the object that would be replaced by the value.

public void Remove(BarCommandLink item)

Parameter	Type	Description
item	BarCommandLink	The BarCommandLink to remove.

public void RemoveAt(int index)

Parameter	Type	Description
index	int	The zero-based index of the BarCommandLink to be removed.

public BarCommandLink[] ToArray()

Returns

BarCommandLink[]:

An array of BarCommandLink items.