Difference between revisions of "RibbonX Collections"

From Ribbon Commander Documentation
Jump to: navigation, search
(Created page with "{{Under Construction}}")
 
Line 1: Line 1:
 
{{Under Construction}}
 
{{Under Construction}}
 +
 +
 +
== 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[]}}
 +
{{DocTableEntry | name=operator()}}
 +
{{DocTableEnd}}
 +
 +
== Remarks ==
 +
 +
== Examples ==
 +
 +
=== VBA ===
 +
<syntaxhighlight lang="vb" line>
 +
</syntaxhighlight>
 +
 +
=== C# ===
 +
<syntaxhighlight lang="csharp" line>
 +
</syntaxhighlight>
 +
 +
=== VB.NET ===
 +
<syntaxhighlight lang="vb" line>
 +
</syntaxhighlight>
 +
 +
=== C++ ===
 +
<syntaxhighlight lang="cpp" line>
 +
</syntaxhighlight>

Revision as of 15:36, 14 March 2013

This section is under construction. Please do not rely on any information it contains.


Description

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


Properties

Property Name
Description
count Read-only property; returns the count of items in a collection
isEmpty Read-only property; returns true if the control is empty
isLive Read-only property; returns true if the control is live
item (VBA/VB.NET-specific) Returns a reference to a collection member by index or id
parent The control's parent object

Methods

Method Name
Description
add Adds an item to the collection
getItemIfExists Returns a reference to a collection member by index or id. Does not throw if the index or id is out of bounds.
remove Removes an item from the collection (by index or item reference)
removeAll Removes all items from the collection
{{Name_operator[]}} {{Desc_operator[]}}
operator() (VBA/VB.NET-specific) Returns are reference to a collection member by index or id

Remarks

Examples

VBA

  1.  

C#

  1.  

VB.NET

  1.  

C++

  1.