Window2.ObjectKind Property

Definition

Namespace:

EnvDTE80

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.11.40262

Gets the type of the Object object, which is a GUID string representing the tool contained in the window.

public:
 property System::String ^ ObjectKind { System::String ^ get(); };

public:
 property Platform::String ^ ObjectKind { Platform::String ^ get(); };

[System.Runtime.InteropServices.DispId(122)]
public string ObjectKind { [System.Runtime.InteropServices.DispId(122)] get; }

[<System.Runtime.InteropServices.DispId(122)>]
[<get: System.Runtime.InteropServices.DispId(122)>]
member this.ObjectKind : string

Public ReadOnly Property ObjectKind As String

Property Value

String

A string containing a GUID representing the tool contained in the window.

Implements

ObjectKind

Attributes

DispIdAttribute

Examples

This example creates a linked window frame, adds the Output Window and Solution Explorer to the linked frame as docked windows, displays the Window2.ObjectKind and other properties, resizes the linked window frame, and then undocks the windows from the frame.

Imports EnvDTE  
Imports EnvDTE80  
Sub ObjectKindExample(ByVal dte As DTE2)  
    Dim Frame As Window2  
    Dim w1 As Window2 = _  
 CType(_applicationObject.Windows.Item _  
(Constants.vsWindowKindSolutionExplorer), Window2)  
    Dim w2 As Window2 = _  
 CType(_applicationObject.Windows.Item _  
(Constants.vsWindowKindOutput), Window2)  
    ' Create a linked window frame and dock Solution Explorer   
    ' and the Ouput window together inside it.  
    Frame = CType(_applicationObject.Windows.CreateLinkedWindowFrame _  
(w1, w2, vsLinkedWindowType.vsLinkedWindowTypeDocked), Window2)  
    MsgBox("Total number of windows in the linked window frame: " _  
    & Frame.LinkedWindows.Count)  
    ' View some window properties.  
    MsgBox("Window ObjectKind property value: " & Frame.ObjectKind)  
    Frame.Width = 500  
    Frame.Height = 600  
    Frame.Left = 100  
    MsgBox("Frame height and width changed.")  
    MsgBox("Undocking the windows.")  
    Frame.LinkedWindows.Remove(w1)  
    Frame.LinkedWindows.Remove(w2)  
End Sub  

using EnvDTE;  
using EnvDTE80;  
using System.Windows.Forms;  
public void ObjectKindExample(DTE2 dte)  
{  
    Window2 Frame;  
    Window2 w1 = (Window2)_applicationObject.Windows.Item  
(Constants.vsWindowKindSolutionExplorer);  
    Window2 w2 = (Window2)_applicationObject.Windows.Item  
(Constants.vsWindowKindOutput);  
    // Create a linked window frame and dock Solution Explorer   
   // and the Ouput window together inside it.  
Frame = (Window2)_applicationObject.Windows.CreateLinkedWindowFrame  
(w1, w2, vsLinkedWindowType.vsLinkedWindowTypeDocked);  
    MessageBox.Show("Total number of windows in the linked   
window frame: " + Frame.LinkedWindows.Count);  
    // View some window properties.  
    MessageBox.Show("Window ObjectKind property value: "   
+ Frame.ObjectKind);  
    Frame.Width = 500;  
    Frame.Height = 600;  
    Frame.Left = 100;  
    MessageBox.Show("Frame height and width changed.");  
    MessageBox.Show("Undocking the windows.");  
    Frame.LinkedWindows.Remove(w1);  
    Frame.LinkedWindows.Remove(w2);  
}  

Remarks

The GUID can be used as an index to Window.Item.