Intersoft ClientUI Documentation
UXRibbonContextualTabGroup Class
Members  See Also  Send Feedback
Intersoft.Client.UI.Aqua.UXRibbon Namespace : UXRibbonContextualTabGroup Class






Represents a contextual tab group that display a collection of commands that are relevant only when users select a particular object type.

Object Model

UXRibbonContextualTabGroup Class

Syntax

Visual Basic (Declaration) 
<DescriptionAttribute("Represents a contextual tab group that display a collection of commands that are relevant only when users select a particular object type.")>
<TemplatePartAttribute(Name="RootElement", Type=System.Windows.Controls.Grid)>
<TemplatePartAttribute(Name="OuterBorder", Type=System.Windows.Controls.Border)>
<TemplatePartAttribute(Name="InnerBorder", Type=System.Windows.Controls.Border)>
Public Class UXRibbonContextualTabGroup 
   Inherits Intersoft.Client.Framework.ISContentControl
   Implements IControl, IFramework, ILicensing 
Visual Basic (Usage)Copy Code
Dim instance As UXRibbonContextualTabGroup
C# 
[DescriptionAttribute("Represents a contextual tab group that display a collection of commands that are relevant only when users select a particular object type.")]
[TemplatePartAttribute(Name="RootElement", Type=System.Windows.Controls.Grid)]
[TemplatePartAttribute(Name="OuterBorder", Type=System.Windows.Controls.Border)]
[TemplatePartAttribute(Name="InnerBorder", Type=System.Windows.Controls.Border)]
public class UXRibbonContextualTabGroup : Intersoft.Client.Framework.ISContentControl, IControl, IFramework, ILicensing 
Delphi 
public class UXRibbonContextualTabGroup = class(Intersoft.Client.Framework.ISContentControl, IControl, IFramework, ILicensing)
JScript 
DescriptionAttribute("Represents a contextual tab group that display a collection of commands that are relevant only when users select a particular object type.")
TemplatePartAttribute(Name="RootElement", Type=System.Windows.Controls.Grid)
TemplatePartAttribute(Name="OuterBorder", Type=System.Windows.Controls.Border)
TemplatePartAttribute(Name="InnerBorder", Type=System.Windows.Controls.Border)
public class UXRibbonContextualTabGroup extends Intersoft.Client.Framework.ISContentControl implements IControl, IFramework, ILicensing 
Managed Extensions for C++ 
[DescriptionAttribute("Represents a contextual tab group that display a collection of commands that are relevant only when users select a particular object type.")]
[TemplatePartAttribute(Name="RootElement", Type=System.Windows.Controls.Grid)]
[TemplatePartAttribute(Name="OuterBorder", Type=System.Windows.Controls.Border)]
[TemplatePartAttribute(Name="InnerBorder", Type=System.Windows.Controls.Border)]
public __gc class UXRibbonContextualTabGroup : public Intersoft.Client.Framework.ISContentControl, IControl, IFramework, ILicensing 
C++/CLI 
[DescriptionAttribute("Represents a contextual tab group that display a collection of commands that are relevant only when users select a particular object type.")]
[TemplatePartAttribute(Name="RootElement", Type=System.Windows.Controls.Grid)]
[TemplatePartAttribute(Name="OuterBorder", Type=System.Windows.Controls.Border)]
[TemplatePartAttribute(Name="InnerBorder", Type=System.Windows.Controls.Border)]
public ref class UXRibbonContextualTabGroup : public Intersoft.Client.Framework.ISContentControl, IControl, IFramework, ILicensing 

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>

The result looks like the following figure.

When the contextual tab group is activated, you can customize the AutoSelectMode behavior to further enhance the user experience.

  • Always

    When the contextual tab group is active, the first tab in the collection will be selected by default.

  • Disabled

    Automatic tab selection is disabled.

  • LastSelection

    When the contextual tab group is active, the previously selected tab will be reselected by default.

To learn more about UXRibbonContextualTabGroup, see Working with Contextual Tab.

Inheritance Hierarchy

System.Object
   System.Windows.DependencyObject
      System.Windows.UIElement
         System.Windows.FrameworkElement
            System.Windows.Controls.Control
               System.Windows.Controls.ContentControl
                  Intersoft.Client.Framework.ISContentControl
                     Intersoft.Client.UI.Aqua.UXRibbon.UXRibbonContextualTabGroup

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

See Also

© 2012 All Rights Reserved.