ContextMenuStrip.SourceControl Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets the last control that caused this ContextMenuStrip to be displayed.

Namespace:   System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

[BrowsableAttribute(false)]
public Control SourceControl {
	[UIPermissionAttribute(SecurityAction.Demand, Window = UIPermissionWindow.AllWindows)]
	get;
}

Property Value

Type: System.Windows.Forms.Control

The control that caused this ContextMenuStrip to be displayed.

Common uses of the SourceControl property include the following:

  • Adding, removing, enabling, or disabling a menu item during the Opening event.

  • Deciding on modifications of a chosen command based on the control that last displayed the ContextMenuStrip.

The following code example demonstrates dynamic SourceControl determination with reuse, and handling of the Opening event. This example is part of a larger example provided for the ContextMenuStrip class.

// This event handler is invoked when the ContextMenuStrip
// control's Opening event is raised. It demonstrates
// dynamic item addition and dynamic SourceControl 
// determination with reuse.
void cms_Opening(object sender, System.ComponentModel.CancelEventArgs e)
{
    // Acquire references to the owning control and item.
    Control c = fruitContextMenuStrip.SourceControl as Control;
    ToolStripDropDownItem tsi = fruitContextMenuStrip.OwnerItem as ToolStripDropDownItem;

    // Clear the ContextMenuStrip control's Items collection.
    fruitContextMenuStrip.Items.Clear();

    // Check the source control first.
    if (c != null)
    {
        // Add custom item (Form)
        fruitContextMenuStrip.Items.Add("Source: " + c.GetType().ToString());
    }
    else if (tsi != null)
    {
        // Add custom item (ToolStripDropDownButton or ToolStripMenuItem)
        fruitContextMenuStrip.Items.Add("Source: " + tsi.GetType().ToString());
    }

    // Populate the ContextMenuStrip control with its default items.
    fruitContextMenuStrip.Items.Add("-");
    fruitContextMenuStrip.Items.Add("Apples");
    fruitContextMenuStrip.Items.Add("Oranges");
    fruitContextMenuStrip.Items.Add("Pears");

    // Set Cancel to false. 
    // It is optimized to true based on empty entry.
    e.Cancel = false;
}

UIPermission

for all windows to set this property value. Associated enumeration: UIPermissionWindow.AllWindows

.NET Framework
Available since 2.0
Return to top
Show: