Share via


Window2.Caption Property

Gets or sets the title of the window.

Namespace:  EnvDTE80
Assembly:  EnvDTE80 (in EnvDTE80.dll)

Syntax

'Declaration
Default Property Caption As String
string this { get; set; }
property String^ default {
    String^ get ();
    void set (String^ value);
}
abstract Caption : string with get, set
function get Caption () : String 
function set Caption (value : String)

Property Value

Type: System.String
The title of the window.

Remarks

The Caption can be set for tool windows.

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.

For more information about how to run this example as an add-in, see How to: Compile and Run the Automation Object Model Code Examples.

Imports EnvDTE
Imports EnvDTE80
Public Sub OnConnection(ByVal application As Object, _
ByVal connectMode As ext_ConnectMode, ByVal addInInst As Object, _
 ByRef custom As Array) Implements IDTExtensibility2.OnConnection
    _applicationObject = CType(application, DTE2)
    _addInInstance = CType(addInInst, AddIn)
    CaptionExample(_applicationObject)
End Sub
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 OnConnection(object application,
 ext_ConnectMode connectMode, object addInInst, ref Array custom)
{
    _applicationObject = (DTE2)application;
    _addInInstance = (AddIn)addInInst;
    CaptionExample(_applicationObject);
}
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.");
}

.NET Framework Security

See Also

Reference

Window2 Interface

EnvDTE80 Namespace