Context Menu in Windows Forms Tabbed Form (SfTabbedForm)

21 Jan 202510 minutes to read

The context menu for the tabbed form can be set using the TabbedFormControl.TabContextMenu property.

C#

public Form1()
{
    InitializeComponent();
    tabbedFormControl = new SfTabbedFormControl();

    for (int i = 1; i <= 15; i++)
        tabbedFormControl.Tabs.Add(new TabPageAdv() { Text = "Document" + i });

    this.Controls.Add(tabbedFormControl);

    this.TabbedFormControl = tabbedFormControl;

    #region Context Menu Customization
    ContextMenuStrip tabContextMenu = new ContextMenuStrip();
    tabContextMenu.Items.Add("Close", null, OnCloseMenuClicked);
    tabbedFormControl.TabContextMenu = tabContextMenu;
	#endregion

}

VB.NET

Public Sub New()
	InitializeComponent()
	tabbedFormControl = New SfTabbedFormControl()

	For i As Integer = 1 To 15
		tabbedFormControl.Tabs.Add(New TabPageAdv() With {.Text = "Document" & i})
	Next i

	Me.Controls.Add(tabbedFormControl)

	Me.TabbedFormControl = tabbedFormControl

	#Region "Context Menu Customization"
	Dim tabContextMenu As New ContextMenuStrip()
	tabContextMenu.Items.Add("Close", Nothing, OnCloseMenuClicked)
	tabbedFormControl.TabContextMenu = tabContextMenu
	#End Region
End Sub

Customize context menu in tabs like web browser

The context menu can be customized when opening the context menu by handling the ContextMenuOpening event. The following code example demonstrates how to provide context menu in tabs like web browser using the TabContextMenu property.

C#

TabPageAdv clickedTab;
SfTabbedFormControl tabbedFormControl;
#region Constructor
public Form1()
{
    InitializeComponent();

    tabbedFormControl = new SfTabbedFormControl();

    for (int i = 1; i <= 3; i++)
        tabbedFormControl.Tabs.Add(new TabPageAdv() { Text = "Document" + i });

    this.Controls.Add(tabbedFormControl);

    this.TabbedFormControl = tabbedFormControl;

    #region Context Menu Customization
    ContextMenuStrip tabContextMenu = new ContextMenuStrip();
    tabContextMenu.Items.Add("Close", null, OnCloseMenuClicked);
    tabContextMenu.Items.Add("Close all but this", null, OnCloseAllMenuClicked);
    tabContextMenu.Items.Add("Close tabs to the right", null, OnCloseTabsToRightMenuClicked);
    tabbedFormControl.TabContextMenu = tabContextMenu;
    tabbedFormControl.ContextMenuOpening += TabbedFormControl_ContextMenuOpening;
    #endregion
}
#endregion

#region ContextMenu events
/// <summary>
/// Occurs when context menu on the tab is opened.
/// </summary>
private void TabbedFormControl_ContextMenuOpening(object sender, ContextMenuOpeningEventArgs e)
{
    clickedTab = e.Tab;
    var tabs = tabbedFormControl.Tabs.OfType<TabPageAdv>();
    var tabsExistsInRight = tabs.Any(tab => tab.TabIndex > e.Tab.TabIndex);

    if (tabs.Count() == 1)
    {
        e.ContextMenu.Items[1].Enabled = false;
        e.ContextMenu.Items[2].Enabled = false;
    }
    else if (!tabsExistsInRight)
        e.ContextMenu.Items[2].Enabled = false;
    else
    {
        e.ContextMenu.Items[0].Enabled = true;
        e.ContextMenu.Items[1].Enabled = true;
        e.ContextMenu.Items[2].Enabled = true;
    }
}

/// <summary>
/// Occurs when the Close menu item is clicked.
/// </summary>
private void OnCloseMenuClicked(object sender, EventArgs e)
{
    if (clickedTab != null)
    {
        if (this.TabbedFormControl.Tabs.OfType<TabPageAdv>().Count() == 1)
            this.Close();
        else
            clickedTab.Close();
    }
}

/// <summary>
/// /// <summary>
/// Occurs when Close All But This menu item is clicked.
/// </summary>
private void OnCloseAllMenuClicked(object sender, EventArgs e)
{
    var tabs = tabbedFormControl.Tabs.OfType<TabPageAdv>();
    var removedTabs = new ObservableCollection<TabPageAdv>();
    foreach (var tab in tabs)
    {
        if (clickedTab != null && tab != clickedTab)
            removedTabs.Add(tab);
    }

    foreach (var tab in removedTabs)
    {
        tab.Close();
    }
}

/// <summary>
/// /// <summary>
/// Occurs when Close Right To This menu item is clicked.
/// </summary>
private void OnCloseTabsToRightMenuClicked(object sender, EventArgs e)
{
    var tabs = tabbedFormControl.Tabs.OfType<TabPageAdv>();
    var removedTabs = new ObservableCollection<TabPageAdv>();
    foreach (var tab in tabs)
    {
        if (clickedTab != null && tab.TabIndex > clickedTab.TabIndex)
            removedTabs.Add(tab);
    }

    foreach (var tab in removedTabs)
    {
        tab.Close();
    }
}
#endregion

VB.NET

Private clickedTab As TabPageAdv
Private tabbedFormControl As SfTabbedFormControl
#Region "Constructor"
Public Sub New()
	InitializeComponent()

	tabbedFormControl = New SfTabbedFormControl()

	For i As Integer = 1 To 3
		tabbedFormControl.Tabs.Add(New TabPageAdv() With {.Text = "Document" & i})
	Next i

	Me.Controls.Add(tabbedFormControl)

	Me.TabbedFormControl = tabbedFormControl

'	#Region "Context Menu Customization"
	Dim tabContextMenu As New ContextMenuStrip()
	tabContextMenu.Items.Add("Close", Nothing, AddressOf OnCloseMenuClicked)
	tabContextMenu.Items.Add("Close all but this", Nothing, AddressOf OnCloseAllMenuClicked)
	tabContextMenu.Items.Add("Close tabs to the right", Nothing, AddressOf OnCloseTabsToRightMenuClicked)
	tabbedFormControl.TabContextMenu = tabContextMenu
	AddHandler tabbedFormControl.ContextMenuOpening, AddressOf TabbedFormControl_ContextMenuOpening
'	#End Region
End Sub
#End Region

#Region "ContextMenu events"
''' <summary>
''' Occurs when context menu on the tab is opening.
''' </summary>
Private Sub TabbedFormControl_ContextMenuOpening(ByVal sender As Object, ByVal e As ContextMenuOpeningEventArgs)
	clickedTab = e.Tab
	Dim tabs = tabbedFormControl.Tabs.OfType(Of TabPageAdv)()
	Dim tabsExistsInRight = tabs.Any(Function(tab) tab.TabIndex > e.Tab.TabIndex)

	If tabs.Count() = 1 Then
		e.ContextMenu.Items(1).Enabled = False
		e.ContextMenu.Items(2).Enabled = False
	ElseIf Not tabsExistsInRight Then
		e.ContextMenu.Items(2).Enabled = False
	Else
		e.ContextMenu.Items(0).Enabled = True
		e.ContextMenu.Items(1).Enabled = True
		e.ContextMenu.Items(2).Enabled = True
	End If
End Sub

''' <summary>
''' Occurs when Close menu item is clicked.
''' </summary>
Private Sub OnCloseMenuClicked(ByVal sender As Object, ByVal e As EventArgs)
	If clickedTab IsNot Nothing Then
		If Me.TabbedFormControl.Tabs.OfType(Of TabPageAdv)().Count() = 1 Then
			Me.Close()
		Else
			clickedTab.Close()
		End If
	End If
End Sub

''' <summary>
''' /// <summary>
''' Occurs when Close All But This Menu item is clicked.
''' </summary>
Private Sub OnCloseAllMenuClicked(ByVal sender As Object, ByVal e As EventArgs)
	Dim tabs = tabbedFormControl.Tabs.OfType(Of TabPageAdv)()
	Dim removedTabs = New ObservableCollection(Of TabPageAdv)()
	For Each tab In tabs
		If clickedTab IsNot Nothing AndAlso tab IsNot clickedTab Then
			removedTabs.Add(tab)
		End If
	Next tab

	For Each tab In removedTabs
		tab.Close()
	Next tab
End Sub

''' <summary>
''' /// <summary>
''' Occurs when Close Right To This Menu item is clicked.
''' </summary>
Private Sub OnCloseTabsToRightMenuClicked(ByVal sender As Object, ByVal e As EventArgs)
	Dim tabs = tabbedFormControl.Tabs.OfType(Of TabPageAdv)()
	Dim removedTabs = New ObservableCollection(Of TabPageAdv)()
	For Each tab In tabs
		If clickedTab IsNot Nothing AndAlso tab.TabIndex > clickedTab.TabIndex Then
			removedTabs.Add(tab)
		End If
	Next tab

	For Each tab In removedTabs
		tab.Close()
	Next tab
End Sub
#End Region

You can download the sample from following link: Sample