Share via


ToolWindowPane.Caption Property

Gets or sets the caption for the tool window.

Namespace:  Microsoft.VisualStudio.Shell
Assembly:  Microsoft.VisualStudio.Shell.10.0 (in Microsoft.VisualStudio.Shell.10.0.dll)

Syntax

'Declaration
Public Property Caption As String
public string Caption { get; set; }
public:
property String^ Caption {
    String^ get ();
    void set (String^ value);
}
member Caption : string with get, set
function get Caption () : String
function set Caption (value : String)

Property Value

Type: System.String
The caption of the tool window.

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.

.NET Framework Security

See Also

Reference

ToolWindowPane Class

Microsoft.VisualStudio.Shell Namespace