Window2.Caption Property

Definition

Namespace:

EnvDTE80

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.11.40262

Gets or sets the title of the window.

public:
 property System::String ^ default { System::String ^ get(); void set(System::String ^ value); };

public:
 property Platform::String ^ default { Platform::String ^ get(); void set(Platform::String ^ value); };

[System.Runtime.InteropServices.DispId(0)]
public string this { [System.Runtime.InteropServices.DispId(0)] get; [System.Runtime.InteropServices.DispId(0)] set; }

[<System.Runtime.InteropServices.DispId(0)>]
[<get: System.Runtime.InteropServices.DispId(0)>]
[<set: System.Runtime.InteropServices.DispId(0)>]
member this.Caption : string with get, set

Default Public Property Caption As String

Property Value

String

The title of the window.

Implements

Caption

Attributes

DispIdAttribute

Examples

This example links together the Output Window, the Command Window, and Solution Explorer. It then manipulates the width and height of these linked windows, and it displays some of their properties, including the Caption.

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

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

Remarks

The Caption can be set for tool windows.