Gets or sets a value indicating whether the form is a container for multiple-document interface (MDI) child forms.
(in System.Windows.Forms.dll)
Visual Basic (Declaration)
Public Property IsMdiContainer As Boolean
Dim instance As Form
Dim value As Boolean
value = instance.IsMdiContainer
instance.IsMdiContainer = value
public bool IsMdiContainer { get; set; }
public:
property bool IsMdiContainer {
bool get ();
void set (bool value);
}
public function get IsMdiContainer () : boolean
public function set IsMdiContainer (value : boolean)
Property Value
Type:
System..::.Boolean
true if the form is a container for MDI child forms; otherwise, false. The default is false.
This property changes the display and behavior of the form to an MDI parent form. When this property is set to true, the form displays a sunken client area with a raised border. All MDI child forms assigned to the parent form are displayed within its client area.
When an MDI parent form is closed, the Closing events of all MDI child forms are raised before the MDI parent form's Closing event is raised. In addition, the Closed events of all MDI child forms are raised before the Closed event of the MDI parent form is raised.
.gif) Note: |
|---|
If there are two MenuStrip controls on an MDI child form, setting IsMdiContainer to true for the parent form merges the contents of only one of the MenuStrip controls. Use Merge to merge the contents of additional child MenuStrip controls on the MDI parent form. |
The following code example demonstrates using the IsMdiContainer property as well as changing the BackColor property of an MDI Form. To run this example, paste the following code in a new form.
' Create a new form.
Dim mdiChildForm As New Form
Private Sub Form1_Load(ByVal sender As Object, _
ByVal e As System.EventArgs) Handles MyBase.Load
' Set the IsMdiContainer property to true.
IsMdiContainer = True
' Set the child form's MdiParent property to
' the current form.
mdiChildForm.MdiParent = Me
'Call the method that changes the background color.
SetBackGroundColorOfMDIForm()
End Sub
Private Sub SetBackGroundColorOfMDIForm()
Dim ctl As Control
' Loop through controls,
' looking for controls of MdiClient type.
For Each ctl In Me.Controls
If TypeOf (ctl) Is MdiClient Then
' If the control is the correct type,
' change the color.
ctl.BackColor = System.Drawing.Color.PaleGreen
End If
Next
End Sub
// Create a new form.
Form mdiChildForm = new Form();
private void Form1_Load(object sender, System.EventArgs e)
{
// Set the IsMdiContainer property to true.
IsMdiContainer = true;
// Set the child form's MdiParent property to
// the current form.
mdiChildForm.MdiParent = this;
// Call the method that changes the background color.
SetBackGroundColorOfMDIForm();
}
private void SetBackGroundColorOfMDIForm()
{
foreach ( Control ctl in this.Controls )
{
if ((ctl) is MdiClient)
// If the control is the correct type,
// change the color.
{
ctl.BackColor = System.Drawing.Color.PaleGreen;
}
}
}
To run this example paste the following code in a new form.
Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98
The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
.NET Framework
Supported in: 3.5, 3.0, 2.0, 1.1, 1.0
Reference
Other Resources