Export (0) Print
Expand All
0 out of 1 rated this helpful - Rate this topic

ContainerControl Class

Provides focus management functionality for controls that can function as a container for other controls.

For a list of all members of this type, see ContainerControl Members.

System.Object
   System.MarshalByRefObject
      System.ComponentModel.Component
         System.Windows.Forms.Control
            System.Windows.Forms.ScrollableControl
               System.Windows.Forms.ContainerControl
                  System.Windows.Forms.Form
                  System.Windows.Forms.PropertyGrid
                  System.Windows.Forms.UpDownBase
                  System.Windows.Forms.UserControl

[Visual Basic]
Public Class ContainerControl
   Inherits ScrollableControl
   Implements IContainerControl
[C#]
public class ContainerControl : ScrollableControl,
   IContainerControl
[C++]
public __gc class ContainerControl : public ScrollableControl,
   IContainerControl
[JScript]
public class ContainerControl extends ScrollableControl implements
   IContainerControl

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Remarks

A ContainerControl represents a control that can function as a container for other controls and provides focus management. Controls that inherit from this class can track the active control they contain, even when the focus moves somewhere within a different container.

ContainerControl objects provide a logical boundary for contained controls. The container control can capture the TAB key press and move focus to the next control in the collection.

Note   The container control does not receive focus; the focus is always set to the first child control in the collection of contained controls.

You do not typically inherit directly from this class. Form, UserControl, and UpDownBase classes inherit from ContainerControl.

Example

[Visual Basic, C#, C++] The following example inherits from the ScrollableControl class and implements the IContainerControl interface. Implementation is added to the ActiveControl property and the ActivateControl method.

[Visual Basic] 
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  

[C#] 
using System;
using System.Windows.Forms;
using System.Drawing;

    public class MyContainer : ScrollableControl, IContainerControl
    {
        private Control activeControl;
        public MyContainer() 
        {
            // Make the container control Blue so it can be distinguished on the form.
            this.BackColor = Color.Blue;
            
            // Make the container scrollable.
            this.AutoScroll = true;
        }

        // Add implementation to the IContainerControl.ActiveControl property.
        public Control ActiveControl
        {
            get
            {
                return activeControl;
            }

            set
            {
                // Make sure the control is a member of the ControlCollection.
                if(this.Controls.Contains(value))
                {
                    activeControl = value;
                }
            }
        }

        // Add implementations to the IContainerControl.ActivateControl(Control) method.
        public bool ActivateControl(Control active)
        {
            if(this.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;
        }
    }

[C++] 

using namespace System;
using namespace System::Windows::Forms;
using namespace System::Drawing;

    public __gc class MyContainer : public ScrollableControl, public IContainerControl {
    private:
        Control*  activeControl;

    public:
        MyContainer() {
            // Make the container control Blue so it can be distinguished on the form.
            this->BackColor = Color::Blue;

            // Make the container scrollable.
            this->AutoScroll = true;
        }

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

        __property void set_ActiveControl(Control* value) {
            // Make sure the control is a member of the ControlCollection.
            if (this->Controls->Contains(value)) {
                activeControl = value;
            }    
        }

        // Add implementations to the IContainerControl.ActivateControl(Control) method.
        bool ActivateControl(Control* active) {
            if (this->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;
        }
    };

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Namespace: System.Windows.Forms

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, .NET Compact Framework

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

See Also

ContainerControl Members | System.Windows.Forms Namespace | Form | UserControl | UpDownBase | IContainerControl | ScrollableControl

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.