Click or drag to resize

DBConnection Class

Represents a database connection that extends the functionality of an external connection.
Inheritance Hierarchy
System Object
Spire.Xls ExternalConnection
Spire.Xls DBConnection

Namespace: Spire.Xls
Assembly: Spire.XLS (in Spire.XLS.dll) Version: 15.4.0.0 (15.4.0.5046)
Syntax
public class DBConnection : ExternalConnection

The DBConnection type exposes the following members.

Constructors
Name Description
Public method DBConnection
Initializes a new instance of the DBConnection class.
Top
Properties
Name Description
Public property BackgroundRefresh
Gets or sets a value indicating whether background refresh is enabled. When the value is set, it also marks the connection converter as changed.
(Overrides ExternalConnection BackgroundRefresh .)
Public property Command
Gets or sets the command associated with the connection converter. When the value is set, it updates the internal command and marks the converter as changed.
Public property CommandType
Gets or sets the command type for the OLEDB command.
Public property Connection
Gets or sets the database connection string. When setting the value, it also marks the connection as changed.
Public property ConnType
Gets the connection data source type based on the value of connConvert.conntype.
(Overrides ExternalConnection ConnType .)
Public property ID
Gets the ID of the connection.
(Overrides ExternalConnection ID .)
Public property KeepAlive
Gets or sets a value indicating whether to keep the connection alive. When set, it updates the corresponding property in the connConvert object and marks it as changed.
(Overrides ExternalConnection KeepAlive .)
Public property Name
Gets or sets the name of the connection. When setting the name, it also marks the connection as changed.
(Overrides ExternalConnection Name .)
Public property OdcFile
Gets or sets the ODC file path associated with the connection. Setting this value marks the connection as changed.
(Overrides ExternalConnection OdcFile .)
Public property OnlyUseConnectionFile
Gets or sets a value indicating whether to use the connection file only. When the value is set, it also marks the connection converter as changed.
(Overrides ExternalConnection OnlyUseConnectionFile .)
Public property RefreshedVersion
Gets or sets the refreshed version of the connection. When setting the value, it also marks the connection as changed.
(Overrides ExternalConnection RefreshedVersion .)
Public property SaveData
Gets or sets the save data flag. When setting the value, it also sets the ischanged flag to true.
(Overrides ExternalConnection SaveData .)
Top
Methods
Name Description
Public method Equals
Determines whether the specified object is equal to the current object.
(Inherited from Object .)
Protected method Finalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object .)
Public method GetHashCode
Serves as the default hash function.
(Inherited from Object .)
Public method GetType
Gets the Type of the current instance.
(Inherited from Object .)
Protected method MemberwiseClone
Creates a shallow copy of the current Object .
(Inherited from Object .)
Public method ToString
Returns a string that represents the current object.
(Inherited from Object .)
Top
See Also