Delen via


IVsDataConnectionDialog.HeaderLabel Property

Gets or sets a summary description that appears in the header of the Add Connection dialog box.

Namespace:  Microsoft.VisualStudio.Data.Services
Assembly:  Microsoft.VisualStudio.Data.Services (in Microsoft.VisualStudio.Data.Services.dll)

Syntax

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

Property Value

Type: System.String
The string literal value of the dialog box header label, or nulla null reference (Nothing in Visual Basic) if no value is set.

Remarks

Often it is useful to indicate to the user what the purpose of a dialog box is—that is, what information it is retrieving and why. This property allows a client to set such header text based on the context in which they are calling the dialog box.

An example value for this property could be "Enter information to connect to a database used to store your application data".

The default is no label.

.NET Framework Security

See Also

Reference

IVsDataConnectionDialog Interface

Microsoft.VisualStudio.Data.Services Namespace