MenuItem.MdiList 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 a value indicating whether the menu item will be populated with a list of the Multiple Document Interface (MDI) child windows that are displayed within the associated form.

public:
 property bool MdiList { bool get(); void set(bool value); };

public bool MdiList { get; set; }

member this.MdiList : bool with get, set

Public Property MdiList As Boolean

Property Value

Boolean

true if a list of the MDI child windows is displayed in this menu item; otherwise, false. The default is false.

Examples

The following code example creates a MenuItem that is used to display the list of currently open MDI child forms in an MDI form.

public:
   void SetMDIList()
   {
      // Create the MenuItem to be used to display an MDI list.
      MenuItem^ menuItem1 = gcnew MenuItem;
      // Set this menu item to be used as an MDI list.
      menuItem1->MdiList = true;
   }

public void SetMDIList()
{
   // Create the MenuItem to be used to display an MDI list.
   MenuItem menuItem1 = new MenuItem();
   // Set this menu item to be used as an MDI list.
   menuItem1.MdiList = true;
}

Public Sub SetMDIList()
    ' Create the MenuItem to be used to display an MDI list.
    Dim menuItem1 As New MenuItem()
    ' Set this menu item to be used as an MDI list.
    menuItem1.MdiList = True
End Sub

Remarks

When a menu item is selected to display an MDI child window list, the list is displayed as a submenu of the menu item. Only forms that are defined as MDI child forms are displayed in the window list. Only nine child windows can be displayed at a time. If there are more than nine child windows displayed, a "More Windows..." menu item is displayed at the end of the window list. Clicking this menu item displays a dialog box with a complete list of the child windows that are currently active.

Applies to

Jaa