Skip to main content
All docs
V24.1

MsSqlConnectionParameters.Encrypt Property

Specifies whether all communication between the server and the client is encrypted.

Namespace: DevExpress.DataAccess.ConnectionParameters

Assembly: DevExpress.DataAccess.v24.1.dll

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

Declaration

public DefaultBoolean Encrypt { get; set; }

Property Value

Type Description
DefaultBoolean

A DefaultBoolean enumeration value that specifies whether communication between the server and the client is encrypted.

Available values:

Name Description Return Value
True

The value is true.

0

False

The value is false.

1

Default

The value is specified by a global option or a higher-level object.

2

Remarks

This property corresponds to the “Encrypt” key within the connection string. When you set the Encrypt property to true, TLS encryption is required for all data sent between the client and server.

If the property value is Default, the connection uses the option set by the provider (Microsoft.Data.SqlClient or System.Data.SqlClient).

The following code snippet shows how to configure connection parameters to establish connection to Microsoft SQL Server:

using DevExpress.DataAccess.ConnectionParameters;
using DevExpress.DataAccess.Sql;
// ...
MsSqlConnectionParameters connectionParameters = new MsSqlConnectionParameters(){
    ServerName = "localhost",
    DatabaseName = "Northwind",
    AuthorizationType = MsSqlAuthorizationType.Windows,
    TrustServerCertificate = DevExpress.Utils.DefaultBoolean.True,
    Encrypt = DevExpress.Utils.DefaultBoolean.True
};
SqlDataSource ds = new SqlDataSource();
ds.ConnectionName = "nwindConnection";
ds.ConnectionParameters = connectionParameters;

The resulting connection string looks as follow:

"XpoProvider=MSSqlServer;data source=localhost;integrated security=SSPI;initial catalog=Northwind;Encrypt=true;TrustServerCertificate=true"

See Also