How to: Determine the Active MDI Child

On occasion, you will want to provide a command that operates on the control that has focus on the currently active child form. For example, suppose you want to copy selected text from the child form's text box to the Clipboard. You would create a procedure that copies selected text to the Clipboard using the Click event of the Copy menu item on the standard Edit menu.

Because an MDI application can have many instances of the same child form, the procedure needs to know which form to use. To specify the correct form, use the ActiveMdiChild property, which returns the child form that has the focus or that was most recently active.

When you have several controls on a form, you also need to specify which control is active. Like the ActiveMdiChild property, the ActiveControl property returns the control with the focus on the active child form. The procedure below illustrates a copy procedure that can be called from a child form menu, a menu on the MDI form, or a toolbar button.

To determine the active MDI child (to copy its text to the Clipboard)

• Within a method, copy the text of the active control of the active child form to the Clipboard.

  Note

  This example assumes there is an MDI parent form (Form1) that has one or more MDI child windows containing a RichTextBox control. For more information, see How to: Create MDI Parent Forms.

  Public Sub mniCopy_Click(ByVal sender As Object, _
     ByVal e As System.EventArgs) Handles mniCopy.Click
  
     ' Determine the active child form.
     Dim activeChild As Form = Me.ActiveMDIChild
  
     ' If there is an active child form, find the active control, which
     ' in this example should be a RichTextBox.
     If (Not activeChild Is Nothing) Then
        Dim theBox As RichTextBox = _
          TryCast(activeChild.ActiveControl, RichTextBox)
  
        If (Not theBox Is Nothing) Then
           'Put selected text on Clipboard.
           Clipboard.SetDataObject(theBox.SelectedText)
        Else
           MessageBox.Show("You need to select a RichTextBox.")
        End If
     End If
  End Sub
  

  protected void mniCopy_Click (object sender, System.EventArgs e)
  {
     // Determine the active child form.
     Form activeChild = this.ActiveMdiChild;
  
     // If there is an active child form, find the active control, which
     // in this example should be a RichTextBox.
     if (activeChild != null)
     {
        RichTextBox theBox = activeChild.ActiveControl as RichTextBox;
        if (theBox != null)
        {
           // Put the selected text on the Clipboard.
           Clipboard.SetDataObject(theBox.SelectedText);
  
        }
        else
        {
           MessageBox.Show("You need to select a RichTextBox.");
        }
     }
  }
  

See Also

Tasks

How to: Create MDI Parent Forms

How to: Create MDI Child Forms

How to: Send Data to the Active MDI Child

How to: Arrange MDI Child Forms

Other Resources

Multiple-Document Interface (MDI) Applications

Change History

Date	History	Reason
July 2009	Changed example to eliminate checking for an exception.	Customer feedback.