Key Property (ContextualTabGroup)

Returns/sets the key of the ContextualTabGroup in the ContextualTabGroupCollection.

Syntax

Visual Basic

'Declaration
 
Public Property Key As String

C#

public string Key {get; set;}

Exceptions

Exception	Description
System.InvalidOperationException	If an attempt is made to add a ContextualTabGroup whose Key property value conflicts with the value of the Key property of an existing ContextualTabGroup in the collection.

Remarks

The Key of the ContextualTabGroup is not required but provides a convenient way to locate a group within the ContextualTabGroups collection. If the Key is provided, it must be unique with respect to the other ContextualTabGroup instances in the ContextualTabGroups collection of the Ribbon.

Example

ContextualTabGroup Sample

Visual Basic

Private xamRibbon As XamRibbon
'Code to Create XamRibbon object..

Private Sub contextualTabGroupProperties()
'ContextualTabGroup properties
    Dim contextualTG As New ContextualTabGroup()
    contextualTG.Caption = "Sample CTG"			'Caption
    contextualTG.Key = "CG1"						'Color
    contextualTG.BaseBackColor = Colors.Aqua		'BaseBackColor
    contextualTG.IsVisible = True					'IsVisible
    xamRibbon.ContextualTabGroups.Add(contextualTG)'add tabs to Contextual Tab Groups
    Dim designTabItem As New RibbonTabItem()
    designTabItem.Header = "Desin"
    contextualTG.Tabs.Add(designTabItem)
   
    Dim layoutTabItem As New RibbonTabItem()
    layoutTabItem.Header = "Layout"
    contextualTG.Tabs.Add(layoutTabItem)
End Sub

C#

XamRibbon xamRibbon;
//Code to Create XamRibbon object..


//ContextualTabGroup properties
private void contextualTabGroupProperties()
{
	ContextualTabGroup contextualTG = new ContextualTabGroup();
	contextualTG.Caption = "Sample CTG";				//Caption
	contextualTG.Key = "CG1";							//Color
	contextualTG.BaseBackColor = Colors.Aqua;			//BaseBackColor
	contextualTG.IsVisible = true;						//IsVisible
	xamRibbon.ContextualTabGroups.Add(contextualTG);

	//add tabs to Contextual Tab Groups
	RibbonTabItem designTabItem = new RibbonTabItem();
	designTabItem.Header = "Desin";
	contextualTG.Tabs.Add(designTabItem);           

	RibbonTabItem layoutTabItem = new RibbonTabItem();
	layoutTabItem.Header = "Layout";
	contextualTG.Tabs.Add(layoutTabItem);
}

XAML

<!-- Create a ContextualTabGroup.There are 6 different ContextualTabGroup Colors: Orange, Purple, Blue, Green, Yellow, and Red. -->
<igRibbon:ContextualTabGroup Key="SelectionGroup" Caption="Selection" IsVisible="True">
    <igRibbon:ContextualTabGroup.Tabs>

        <!-- Add a RibbonTabItem to this ContextualTabGroup.  Multiple TabItems can be added
        to the same ConxtextualTabGroup.  Each Tab will contain the same color as the ContextualTabGroup. -->
        <igRibbon:RibbonTabItem Header="Font Selection">
            <igRibbon:RibbonGroup Id="FontSelection" Caption="Font">
                <igRibbon:ToolHorizontalWrapPanel>
                    <igRibbon:ComboEditorTool
                      Id="fontFamilyCombo_Selection"
                      x:Name="fontFamilyCombo_Selection"
                      DropDownResizeMode="VerticalOnly"
                      IsEditable="False" Caption="Font Size"
                      EditAreaWidth="148.0" Value="Arial">
                            <igRibbon:ComboEditorTool.ItemsProvider>
                                <igEditors:ComboBoxItemsProvider>
                                    <Label Content="Arial"/>
                                    <Label Content="Arial Black"/>
                                    <Label Content="Calibri"/>
                                    <Label Content="Times New Roman"/>
                                </igEditors:ComboBoxItemsProvider>
                            </igRibbon:ComboEditorTool.ItemsProvider>
                        </igRibbon:ComboEditorTool>
                    
                    <igRibbon:ComboEditorTool
                      Id="fontSizeCombo_Selection"
                      x:Name="fontSizeCombo_Selection"
                      IsEditable="False"
                      DropDownResizeMode="VerticalOnly"
                      EditAreaWidth="118.0" Caption="Font Size"
                      ValueType="{x:Type s:Double}" Value="10" >
                            <igRibbon:ComboEditorTool.ItemsProvider>
                                <igEditors:ComboBoxItemsProvider>
                                    <Label Width="50" Content="8"/>
                                    <Label Width="50" Content="9"/>
                                    <Label Width="50" Content="10"/>
                                </igEditors:ComboBoxItemsProvider>
                            </igRibbon:ComboEditorTool.ItemsProvider>
                        </igRibbon:ComboEditorTool>
                    
                    <igRibbon:MenuTool
                        igRibbon:RibbonGroup.MaximumSize="ImageOnly"
                        SmallImage="Images\icons\Ribbon\FontColor.png" >
                        <TextBlock Text="Colors"/>
                    </igRibbon:MenuTool>
                </igRibbon:ToolHorizontalWrapPanel>
            </igRibbon:RibbonGroup>
        </igRibbon:RibbonTabItem>

    </igRibbon:ContextualTabGroup.Tabs>
</igRibbon:ContextualTabGroup>

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2