Xceed Docking Windows for WinForms v2.3 Documentation
Xceed.DockingWindows Namespace / ToolWindow Class / Key Property


In This Topic
    Key Property
    In This Topic
    Gets or sets the ToolWindow's unique key.
    Syntax
    'Declaration
     
    <DescriptionAttribute("The ToolWindow's unique key.")>
    <CategoryAttribute("Data")>
    Public Property Key As String
    'Usage
     
    Dim instance As ToolWindow
    Dim value As String
     
    instance.Key = value
     
    value = instance.Key
    [Description("The ToolWindow's unique key.")]
    [Category("Data")]
    public string Key {get; set;}

    Property Value

    A string representing the ToolWindow's unique key. Cannot be a null reference (Nothing in Visual Basic) or System.String.Empty
    Remarks

    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.

    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