View source for RibbonX Collections

== Description ==
The section describes the generic interface of Dynamic RibbonX collection and the operations that can be performed on them.


== Properties ==
{{DocTableBegin | Col1Name=Property Name | Col2Name=Description}}
{{DocTableEntry | name=count}}
{{DocTableEntry | name=isEmpty}}
{{DocTableEntry | name=isLive}}
{{DocTableEntry | name=item}}
{{DocTableEntry | name=parent}}
{{DocTableEnd}}

== Methods ==
{{DocTableBegin | Col1Name=Method Name | Col2Name=Description}}
{{DocTableEntry | name=add}}
{{DocTableEntry | name=getItemIfExists}}
{{DocTableEntry | name=remove}}
{{DocTableEntry | name=removeAll}}
{{DocTableEntry | name=operator()_sq}}
{{DocTableEntry | name=operator()}}
{{DocTableEnd}}

== Remarks ==

== Examples ==

=== VBA ===
<syntaxhighlight lang="vb" line>
Public Sub ColectionsVBASample()
    
    ' Create a new group and play with its buttons collection
    Dim myGroup As rxGroup
    Set myGroup = New rxGroup
    
    ' Print number of buttons in the group (prints 0)
    Debug.Print myGroup.Buttons.Count
    
    ' Create a new button and give it an id
    Dim myButton As rxButton
    Set myButton = New rxButton
    myButton.id = "my_button"
        
    ' Add the button to the group's buttons collection
    myGroup.Buttons.Add myButton
    
    ' Print number of buttons in the group (prints 1)
    Debug.Print myGroup.Buttons.Count
        
    ' Access an item by index
    Dim myButton2 As rxButton
    Set myButton2 = myGroup.Buttons.Item(1)
    ' Or alternatively
    Set myButton2 = myGroup.Buttons(1)
    
    ' Access an item by id
    Dim myButton3 As rxButton
    Set myButton3 = myGroup.Buttons.Item("my_button")
    ' Or alternatively
    Set myButton3 = myGroup.Buttons("my_button")
    
    ' Remove an item by index
    myGroup.Buttons.Remove 1
    
    ' Print number of buttons in the group (prints 0)
    Debug.Print myGroup.Buttons.Count
    
    ' Add the item back and remove it by object reference
    myGroup.Buttons.Add myButton
    ' Get another ref to the button
    Dim myButton4 As rxButton
    Set myButton4 = myGroup.Buttons("my_button")
    ' Remove
    myGroup.Buttons.Remove myButton4
    
    ' Print number of buttons in the group (prints 0)
    Debug.Print myGroup.Buttons.Count
    
End Sub
</syntaxhighlight>

=== C# ===
<syntaxhighlight lang="csharp" line>
private void CollectionsCSSample()
{
    // Create a new tab and play with its groups collection
    rxTab myTab = new rxTab();
            
    // Print the number of groups in the tab (prints 0)
    System.Diagnostics.Debug.WriteLine(myTab.groups.count);

    // Create a new group and give it an id
    rxGroup myGroup = new rxGroup();
    myGroup.id = "my_group";

    // Add the group to the tab's groups collection
    myTab.groups.add(myGroup);

    // Print the number of groups in the tab (prints 1)
    System.Diagnostics.Debug.WriteLine(myTab.groups.count);

    // Access an item by index
    rxGroup myGroup2 = myTab.groups[1];

    // Access an item by id
    rxGroup myGroup3 = myTab.groups["my_group"];

    // Remove an item by index
    myTab.groups.remove(1);

    // Print the number of groups in the tab (prints 0)
    System.Diagnostics.Debug.WriteLine(myTab.groups.count);

    // Add the item back and remove it by object reference
    myTab.groups.add(myGroup);
    myTab.groups.remove(myTab.groups["my_group"]);

    // Print the number of groups in the tab (prints 0)
    System.Diagnostics.Debug.WriteLine(myTab.groups.count);
}
</syntaxhighlight>

=== VB.NET ===
<syntaxhighlight lang="vb" line>
Private Sub CollectionsVBSample()

    ' Create a new group and play with its checkboxes collection
    Dim myGroup As rxGroup = New rxGroup

    ' Print the number of checkboxes in the group (prints 0)
    System.Diagnostics.Debug.WriteLine(myGroup.checkBoxes.count)

    ' Create a new checkbox and give it an id
    Dim myCheck As rxCheckBox = New rxCheckBox
    myCheck.id = "my_checkbox"

    ' Add the checkbox to the group's checkboxes collection
    myGroup.checkBoxes.add(myCheck)

    ' Print the number of checkboxes in the group (prints 1)
    System.Diagnostics.Debug.WriteLine(myGroup.checkBoxes.count)

    ' Access an item by index
    Dim myCheck2 As rxCheckBox = myGroup.checkBoxes.item(1)
    ' Or alternatively
    myCheck = myGroup.checkBoxes(1)

    ' Access an item by id
    Dim myCheck3 As rxCheckBox = myGroup.checkBoxes.item("my_checkbox")
    ' Or alternatively
    myCheck3 = myGroup.checkBoxes("my_checkbox")

    ' Remove an item by index
    myGroup.checkBoxes.remove(1)

    ' Print the number of checkboxes in the group (prints 0)
    System.Diagnostics.Debug.WriteLine(myGroup.checkBoxes.count)

    ' Add the item back and remove it by object reference
    myGroup.checkBoxes.add(myCheck)
    myGroup.checkBoxes.remove(myGroup.checkBoxes("my_checkbox"))

    ' Print the number of checkboxes in the group (prints 0)
    System.Diagnostics.Debug.WriteLine(myGroup.checkBoxes.count)

End Sub
</syntaxhighlight>

=== C++ ===
<syntaxhighlight lang="cpp" line>
</syntaxhighlight>