ToolStripItem.MergeIndex Property

Reference

Definition

Namespace:: System.Windows.Forms

Assembly:: System.Windows.Forms.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets the position of a merged item within the current ToolStrip.

public:
 property int MergeIndex { int get(); void set(int value); };

public int MergeIndex { get; set; }

member this.MergeIndex : int with get, set

Public Property MergeIndex As Integer

Property Value

Int32

An integer representing the index of the merged item, if a match is found, or -1 if a match is not found.

Examples

The following example uses the MergeIndex property to insert a merged ToolStripMenuItem in a specific location. This example is part of a larger example available in the ToolStripManager class overview.

public void ShowInsertInSameLocationSample()
{
    // Notice how the items are in backward order.  
    // This is because "merge-one" gets applied, then a search occurs for the new second position 
    // for "merge-two", and so on.
    foreach (ToolStripItem item in cmsItemsToMerge.Items)
    {
        item.MergeAction = MergeAction.Insert;
        item.MergeIndex = 2;
    }
}

Public Sub ShowInsertInSameLocationSample()
   ' Notice how the items are in backward order.  
   ' This is because "merge-one" gets applied, then a search occurs for the new second position 
   ' for "merge-two", and so on.
   Dim item As ToolStripItem
   For Each item In  cmsItemsToMerge.Items
      item.MergeAction = MergeAction.Insert
      item.MergeIndex = 2
   Next item
End Sub

Remarks

Use the MergeIndex property to get or set the index of a ToolStripMenuItem so that you can access it for menu-merging operations.

Applies to

Dela via