Xceed Logo
Shop
Xceed Docking Windows for WinForms v2.3 Documentation
Xceed.DockingWindows Namespace / ToolWindow Class
Members


In This Topic
    ToolWindow Class
    In This Topic
    Represents a container control (window) which can be docked, floating, or auto hide.
    Syntax
    'Declaration
 
<ToolboxItemAttribute(False)>
<DesignerAttribute("System.Windows.Forms.Design.UserControlDocumentDesigner, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", System.ComponentModel.Design.IRootDesigner)>
<DesignerCategoryAttribute("UserControl")>
<DefaultEventAttribute("Load")>
<DefaultPropertyAttribute("Text")>
<DesignerSerializerAttribute("System.Windows.Forms.Design.ControlCodeDomSerializer, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", "System.ComponentModel.Design.Serialization.CodeDomSerializer, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")>
<ToolboxItemFilterAttribute("System.Windows.Forms")>
Public Class ToolWindow 
   Inherits System.Windows.Forms.UserControl
    'Usage
 
Dim instance As ToolWindow
    [ToolboxItem(false)]
[Designer("System.Windows.Forms.Design.UserControlDocumentDesigner, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", System.ComponentModel.Design.IRootDesigner)]
[DesignerCategory("UserControl")]
[DefaultEvent("Load")]
[DefaultProperty("Text")]
[DesignerSerializer("System.Windows.Forms.Design.ControlCodeDomSerializer, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", "System.ComponentModel.Design.Serialization.CodeDomSerializer, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")]
[ToolboxItemFilter("System.Windows.Forms")]
public class ToolWindow : System.Windows.Forms.UserControl
    Remarks

    A ToolWindow can be created by creating a control that derives from the ToolWindow class (which in turn derives from UserControl), or create/use a control and create a ToolWindow around it.

    Each ToolWindow must have a unique key which can later be used to access it in its containing collection. When creating a ToolWindow by changing the derivation from UserControl to ToolWindow, the Key property must be set either in the designer or by setting the Key property in the constructor. When creating a ToolWindow from scratch, the base's constructor must be called or the Key property set in the constructor. Once a ToolWindow has been added to its associated DockLayoutManager's ToolWindows collection, its Key property can no longer be set.

    Inheritance Hierarchy

    System.Object
       System.MarshalByRefObject
          System.ComponentModel.Component
             System.Windows.Forms.Control
                System.Windows.Forms.ScrollableControl
                   System.Windows.Forms.ContainerControl
                      System.Windows.Forms.UserControl
                         Xceed.DockingWindows.ToolWindow

    Requirements

    Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also

    Reference

    ToolWindow Members
    Xceed.DockingWindows Namespace

    Send Feedback