Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

IContainerControl.ActivateControl Method

Activates a specified control.

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

'Declaration
Function ActivateControl ( _
	active As Control _
) As Boolean

Parameters

active
Type: System.Windows.Forms.Control

The Control being activated.

Return Value

Type: System.Boolean
true if the control is successfully activated; otherwise, false.

Notes to Implementers

When implemented in a class, this method activates the specified Control. The control must be a child of the container control.

The following 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  

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Show:
© 2015 Microsoft