Window.Caption Property

Gets or sets the title of the window.

Namespace:  EnvDTE
Assembly:  EnvDTE (in EnvDTE.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

Sub CaptionExample()
   Dim Frame As Window
   Dim w1 As Window = _
   DTE.Windows.Item(Constants.vsWindowKindSolutionExplorer)
   Dim w2 As Window = DTE.Windows.Item(Constants.vsWindowKindOutput)

   ' Create a linked window frame and dock Solution Explorer 
   ' and the Ouput window together inside it.
   Frame = DTE.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: " & Frame.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

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

Window Interface

EnvDTE Namespace