DataConnectionBase.StoreConnectionNameOnly Property

Specifies whether to serialize any connection settings except for the data connection name.

Namespace: DevExpress.DataAccess

Assembly: DevExpress.DataAccess.v24.1.dll

NuGet Packages: DevExpress.DataAccess, DevExpress.Win.PivotGrid, DevExpress.Win.TreeMap

Declaration

C#

[Browsable(false)]
public bool StoreConnectionNameOnly { get; set; }

VB.NET

<Browsable(False)>
Public Property StoreConnectionNameOnly As Boolean

Property Value

Type	Description
Boolean	true, to store only the name of a data connection; otherwise, false.

Remarks

When this option is enabled, the connection parameters are restored from the application configuration file by using the deserialized connection name.

Enable the DataConnectionBase.StoreConnectionNameOnly property when you implement the IConnectionStorageService interface to serialize database connection names only. This behavior does not expose database credentials in report layout definitions.

When this property is disabled, the behavior depends on the SqlWizardSettings.DatabaseCredentialsSavingBehavior and IConnectionStorageService.CanSaveConnection property values.

SensitiveInfoSavingBehavior	Behavior
SensitiveInfoSavingBehavior.Prompt	IConnectionStorageService.CanSaveConnection is set to true After users select a connection or specify a new one, the Data Source Wizard displays the following page. IConnectionStorageService.CanSaveConnection is set to false After users select a connection or specify a new one, the Data Source Wizard displays the following page.
SensitiveInfoSavingBehavior.Always or SensitiveInfoSavingBehavior.Never	Users cannot specify whether or not to store database credentials with serialized layouts. After they select a connection or specify a new one, the Data Source Wizard displays the following page. IConnectionStorageService.CanSaveConnection is set to true IConnectionStorageService.CanSaveConnection is set to false The Wizard skips the page that allows users to specify how to save connections ving options is skipped and displays the next page.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the StoreConnectionNameOnly property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

reporting-winforms-designer-connection-save-safe/CS/ReportingEUDSaveReportWithoutConnectionParams/CustomConnectionProviderService.cs#L41

   new CustomStringConnectionParameters(node["ConnectionString"].InnerText));
connection.StoreConnectionNameOnly = true;
result.Add(connection);

VB.NET

reporting-winforms-designer-connection-save-safe/VB/ReportingEUDSaveReportWithoutConnectionParams/CustomConnectionProviderService.vb#L42

Dim connection As New CustomSqlDataConnection(connectionName, New CustomStringConnectionParameters(node("ConnectionString").InnerText))
connection.StoreConnectionNameOnly = True
result.Add(connection)