Share via


DataConnectionDialog.HeaderLabel Property

Retrieves or sets a summary description that appears at the head of the Data Connection dialog box.

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

Syntax

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

Property Value

Type: System.String
Returns the string literal value of the dialog box header label, or returns 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 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.

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

DataConnectionDialog Class

Microsoft.VisualStudio.Data Namespace