Window.Caption Property

Definition

Namespace:

EnvDTE

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

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.

Attributes

DispIdAttribute

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  

Remarks

The Caption can be set for tool windows.