Gets the collection of contextual tab groups in the ribbon control.

Syntax

Visual Basic (Declaration)
<CategoryAttribute("Common Properties")> <BindableAttribute(Bindable=True, Direction=BindingDirection.OneWay)> Public ReadOnly Property ContextualTabGroups As Collection(Of UXRibbonContextualTabGroup)

Visual Basic (Usage)	Copy Code
Dim instance As UXRibbonBar Dim value As Collection(Of UXRibbonContextualTabGroup) value = instance.ContextualTabGroups

C#
[CategoryAttribute("Common Properties")] [BindableAttribute(Bindable=true, Direction=BindingDirection.OneWay)] public Collection<UXRibbonContextualTabGroup> ContextualTabGroups {get;}

Delphi
public read-only property ContextualTabGroups: Collection;

JScript
CategoryAttribute("Common Properties") BindableAttribute(Bindable=, Direction=BindingDirection.OneWay) public function get ContextualTabGroups : Collection

Managed Extensions for C++
[CategoryAttribute("Common Properties")] [BindableAttribute(Bindable=true, Direction=BindingDirection.OneWay)] public: __property Collection<UXRibbonContextualTabGroup> get_ContextualTabGroups();

C++/CLI
[CategoryAttribute("Common Properties")] [BindableAttribute(Bindable=true, Direction=BindingDirection.OneWay)] public: property Collection<UXRibbonContextualTabGroup^>^ ContextualTabGroups { Collection<UXRibbonContextualTabGroup^>^ get(); }

C++/CLI

[CategoryAttribute("Common Properties")]
[BindableAttribute(Bindable=true, Direction=BindingDirection.OneWay)]
public:
property Collection<UXRibbonContextualTabGroup^>^ ContextualTabGroups {
   Collection<UXRibbonContextualTabGroup^>^ get();
}

Remarks

Contextual tab is a unique ribbon concept that defines the tab's visibility based on a specific context. The contextual tab is useful to hide application commands that are irrelevant unless certain context is available. For example, you can design the ribbon to show the search related commands when the search textbox is focused, such as shown in the illustration below.

To use contextual tab in UXRibbonBar, you need to configure several things as follows:

Define a UXRibbonContextualTabGroup with a unique name and some other attributes such as Content for the display text, Background and IndicatorBackground for the visual brushes.
Specify which tab belongs to which contextual group. You set the ContextualTabGroupName property to the unique name of UXRibbonContextualTabGroup you defined earlier.
Set the ActiveContextualTabs property of UXRibbonBar to determine the active contextual tab groups. To activate multiple contextual tab groups, set the property with each tab group name separated by comma character.

The following code shows how to configure the contextual tabs and set the active contextual tab initially.

XAML	Copy Code
<Intersoft:UXRibbonBar RibbonTitle="Documentation" ActiveContextualTabs="TableContextualTabGroup"> ... <Intersoft:UXRibbonBar.ContextualTabGroups> <Intersoft:UXRibbonContextualTabGroup x:Name="TableContextualTabGroup" Content="Table" IndicatorBackground="#FF5BA4F2" Background="#FF0759A5" AutoSelectMode="Always" /> </Intersoft:UXRibbonBar.ContextualTabGroups> <Intersoft:UXRibbonTab Header="Home" /> <Intersoft:UXRibbonTab Header="Table" ContextualTabGroupName="TableContextualTabGroup" /> </Intersoft:UXRibbonBar>

XAML

Copy Code

<Intersoft:UXRibbonBar RibbonTitle="Documentation" ActiveContextualTabs="TableContextualTabGroup">
        ...
    <Intersoft:UXRibbonBar.ContextualTabGroups>
        <Intersoft:UXRibbonContextualTabGroup x:Name="TableContextualTabGroup" Content="Table" 
                        IndicatorBackground="#FF5BA4F2" Background="#FF0759A5" AutoSelectMode="Always" />
    </Intersoft:UXRibbonBar.ContextualTabGroups>
    <Intersoft:UXRibbonTab Header="Home" />
    <Intersoft:UXRibbonTab Header="Table" ContextualTabGroupName="TableContextualTabGroup" />                
</Intersoft:UXRibbonBar>

The result looks like the following figure.

Requirements

Target Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows Server 2008 family

Syntax

Remarks

Requirements

See Also

Reference

Intersoft ClientUI Documentation
ContextualTabGroups Property
See Also Send Feedback