RibbonItemCollection Class
- Namespace
TXTextControl.Windows. Forms. Ribbon
- Package
TXTextControl.from the private NuGet feed or Text Control Offline PackagesTextControl. WinForms. SDK
- Assembly
TXTextControl.Windows. Forms. dll
- Install
dotnet add package TXTextControl..NET 8 and later. For .NET Framework, referenceTextControl. WinForms. SDK TXTextControl.from the setup.Windows. Forms. dll
- Inherits
- Collection
Base - Ribbon
Item Collection
- Collection
- Implements
- IEnumerable, IEnumerator
Description
An instance of the RibbonItemCollection class contains controls of type RibbonButton, RibbonComboBox, RibbonLabel, RibbonListView, RibbonTextBox or RibbonSeperator and can be obtained with the RibbonGroup.RibbonItems, Ribbon.ApplicationMenuHelpPaneItems, Ribbon.ApplicationMenuItems, RibbonMenuButton.DropDownItems or RibbonListView.DropDownItems property. It is inherited from the abstract class System.Collections.CollectionBase and implements the System.Collections.IEnumerable and System.Collections.IEnumerator interfaces. The following describes only the properties, methods and events defined through the RibbonItemCollection class. For a list of properties, methods and events of these classes and interfaces see the .NET Framework reference.
Syntax
public class RibbonItemCollection : CollectionBase, IEnumerable, IEnumeratorPublic Class RibbonItemCollection
Inherits CollectionBase
Implements IEnumerable, IEnumeratorExamples
The following example includes the item value from a Ribbon Item Collection object in application diagnostics. The created object is then available to the surrounding document workflow.
Console.WriteLine($"Item: {ribbonItemCollection[10]}");
Console.WriteLine("Ribbon Item Collection is ready for use.");Console.WriteLine($"Item: {ribbonItemCollection.Item(10)}")
Console.WriteLine("Ribbon Item Collection is ready for use.")Members
Properties
| Property | Description |
|---|---|
| Current | Not described in the reference. public object Current { get; } |
| Item | Gets a control of type RibbonButton, RibbonComboBox, RibbonLabel, RibbonListView, RibbonTextBox or RibbonSeperator from the collection. This property is the indexer for the RibbonItemCollection class. |
Methods
| Method | Description |
|---|---|
| Add | Adds a control of the type RibbonButton, RibbonComboBox, RibbonLabel, RibbonListView, RibbonTextBox or RibbonSeperator to the end of the collection. |
| AddRange | Adds an array of controls to the end of the collection. These controls must be objects of type RibbonButton, RibbonComboBox, RibbonLabel, RibbonListView, RibbonTextBox or RibbonSeperator. |
| Contains | Determines whether a control is in the collection. |
| Insert | Inserts a control of the type RibbonButton, RibbonComboBox, RibbonLabel, RibbonListView, RibbonTextBox or RibbonSeperator at the specified index. |
| InsertRange | Inserts an array of controls at the specified index. These controls must be objects of type RibbonButton, RibbonComboBox, RibbonLabel, RibbonListView, RibbonTextBox or RibbonSeperator. |
| MoveNext | Not described in the reference. public bool MoveNext(); |
| Remove | Removes a control of the type RibbonButton, RibbonComboBox, RibbonLabel, RibbonListView, RibbonTextBox or RibbonSeperator from this collection. |
| RemoveAt | Not described in the reference. public void RemoveAt(int index); |
| Reset | Not described in the reference. public void Reset(); |