Share via


DataConnectionProperties.ToDisplayString Method

Retrieves a string representation of the current set of data connection properties that are suitable for on-screen display.

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

Syntax

'Declaration
Public Function ToDisplayString As String
'Usage
Dim instance As DataConnectionProperties 
Dim returnValue As String 

returnValue = instance.ToDisplayString()
public string ToDisplayString()
public:
virtual String^ ToDisplayString() sealed
public final function ToDisplayString() : String

Return Value

Type: System.String
A string representation of the current set of data connection properties that are suitable for on-screen display.

Implements

IVsDataConnectionUIProperties.ToDisplayString()

Remarks

The base implementation of this method uses the OrderedProperties property to get a list of ordered properties, and then, for each property that should be persisted - that is, for which ShouldPersistProperty returns true - it calls GetKeyAsString and GetValueAsString and places them in the output string.

Note that values of sensitive properties - that is, for which IsSensitive returns false - are replaced by asterisks.

.NET Framework Security

See Also

Reference

DataConnectionProperties Class

DataConnectionProperties Members

Microsoft.VisualStudio.Data.Framework Namespace