Export (0) Print
Expand All

ContainerControl.ActiveControl Property

Gets or sets the active control on the container control.

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in system.windows.forms.dll)

'Declaration
Public Property ActiveControl As Control
'Usage
Dim instance As ContainerControl
Dim value As Control

value = instance.ActiveControl

instance.ActiveControl = value
/** @property */
public final Control get_ActiveControl ()

/** @property */
public final void set_ActiveControl (Control value)

public final function get ActiveControl () : Control

public final function set ActiveControl (value : Control)

Not applicable.

Property Value

The Control that is currently active on the ContainerControl.

Exception typeCondition

ArgumentException

The Control assigned could not be activated.

The ActiveControl property activates or retrieves the active control on the container control.

In order to receive a valid value from this property, the object that calls it must either contain or be contained in the control it is calling. If one form tries to call another form's ActiveControl properties, it will receive an undefined value. In this case, you need to define your own communication mechanism between the forms to pass this data.

The following code example inherits from the ScrollableControl class and implements the IContainerControl interface. Implementation is added to the ActiveControl property and the ActivateControl method.

Imports System
Imports System.Windows.Forms
Imports System.Drawing

   Public Class MyContainerControl
      Inherits ScrollableControl
      Implements IContainerControl 

      Private myActiveControl As Control
      
      Public Sub New()
         ' Make the container control Blue so it can be distinguished on the form.
         Me.BackColor = Color.Blue
         
         ' Make the container scrollable.
         Me.AutoScroll = True
      End Sub 
      
      ' Add implementation to the IContainerControl.ActiveControl property.
      Public Property ActiveControl() As Control Implements IContainerControl.ActiveControl
         Get
            Return Me.myActiveControl
         End Get
         
         Set
            ' Make sure the control is a member of the ControlCollection.
            If Me.Controls.Contains(value) Then
               Me.myActiveControl = value
            End If
         End Set
      End Property
      
      ' Add implementation to the IContainerControl.ActivateControl(Control) method.
      public Function ActivateControl(active As Control) As Boolean Implements IContainerControl.ActivateControl
         If Me.Controls.Contains(active) Then
            ' Select the control and scroll the control into view if needed.
            active.Select()
            Me.ScrollControlIntoView(active)
            Me.myActiveControl = active
            Return True
         End If
         Return False
      End Function 

   End Class  

import System.*;
import System.Windows.Forms.*;
import System.Drawing.*;

public class MyContainer extends ScrollableControl implements IContainerControl
{
    private Control activeControl;

    public MyContainer()
    {
        // Make the container control Blue so it can be 
        // distinguished on the form.
        this.set_BackColor(Color.get_Blue());

        // Make the container scrollable.
        this.set_AutoScroll(true);
    } //MyContainer

    // Add implementation to the IContainerControl.ActiveControl property.
    /** @property 
     */
    public Control get_ActiveControl()
    {
        return activeControl;
    } //get_ActiveControl

    /** @property 
     */
    public void set_ActiveControl(Control value)
    {
        // Make sure the control is a member of the ControlCollection.
        if (this.get_Controls().Contains(value)) {
            activeControl = value;
        }
    } //set_ActiveControl

    // Add implementations to the IContainerControl.
    // ActivateControl(Control) method.
    public boolean ActivateControl(Control active)
    {
        if (this.get_Controls().Contains(active)) {
            // Select the control and scroll the control into view if needed.
            active.Select();
            this.ScrollControlIntoView(active);
            this.activeControl = active;
            return true;
        }

        return false;
    } //ActivateControl
} //MyContainer

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft