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

'宣言
Property HeaderLabel As String
'使用
Dim instance As IVsDataConnectionDialog
Dim value As String

value = instance.HeaderLabel

instance.HeaderLabel = value
string HeaderLabel { get; set; }
property String^ HeaderLabel {
    String^ get ();
    void set (String^ value);
}
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 a 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.

Permissions

See Also

Reference

IVsDataConnectionDialog Interface

IVsDataConnectionDialog Members

Microsoft.VisualStudio.Data.Services Namespace