ToolWindowPane.Caption Property

Definition

Namespace:

Microsoft.VisualStudio.Shell

Assembly:

Microsoft.VisualStudio.Shell.15.0.dll

Package:

Microsoft.VisualStudio.Shell.15.0 v17.11.40262

Get or Set the text on the title bar of the ToolWindow

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

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

public string Caption { get; set; }

member this.Caption : string with get, set

Public Property Caption As String

Property Value

String

Remarks

This property can be used to get or set the caption of the tool window. If the tool window has not been sited by Visual Studio, setting this caption property just stores the caption in the ToolWindowPane object. If the tool window has been sited by Visual Studio, setting the caption accesses the window frame and updates the caption. The value of this property is used by Package during its CreateToolWindow call. If the caption is set to null, a default empty string is used.