Class DataConnection
Represents a base class for data connections.
Inheritance
Inherited Members
Namespace: DRIT.Spreadsheet.Data
Assembly: DRIT.Spreadsheet.dll
Syntax
public abstract class DataConnection
Constructors
DataConnection()
Initializes a new instance of the DataConnection class.
Declaration
public DataConnection()
Properties
Background
Gets or sets whether to refresh in the background.
Declaration
public bool Background { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
Credentials
Specifies the credentials method for the connection.
Declaration
public CredentialsMethod Credentials { get; set; }
Property Value
| Type | Description |
|---|---|
| CredentialsMethod |
Description
Specifies the description of the connection.
Declaration
public string Description { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Interval
Specifies the refresh interval in seconds.
Declaration
public int Interval { get; set; }
Property Value
| Type | Description |
|---|---|
| int |
IsDeleted
Gets or sets whether the connection is deleted.
Declaration
public bool IsDeleted { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
IsNew
Gets or sets whether this is a new connection.
Declaration
public bool IsNew { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
KeepAlive
Gets or sets whether to keep the connection alive.
Declaration
public bool KeepAlive { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
MinRefreshableVersion
Specifies the minimum refreshable version number.
Declaration
public int MinRefreshableVersion { get; set; }
Property Value
| Type | Description |
|---|---|
| int |
Name
Specifies the name of the connection.
Declaration
public string Name { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
OdcFile
Specifies the full path to external connection file from which this was created.
Declaration
public string OdcFile { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
OnlyUseConnectionFile
Gets or sets whether to only use the connection file.
Declaration
public bool OnlyUseConnectionFile { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
Parameters
Specifies the connection parameters.
Declaration
public List<ConnectionParameter> Parameters { get; set; }
Property Value
| Type | Description |
|---|---|
| List<ConnectionParameter> |
ReconnectionMethod
Specifies the reconnection method.
Declaration
public int ReconnectionMethod { get; set; }
Property Value
| Type | Description |
|---|---|
| int |
RefreshOnLoad
Gets or sets whether to refresh on load.
Declaration
public bool RefreshOnLoad { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
RefreshedVersion
Specifies the refreshed version number.
Declaration
public int RefreshedVersion { get; set; }
Property Value
| Type | Description |
|---|---|
| int |
SaveData
Gets or sets whether to save data with the workbook.
Declaration
public bool SaveData { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
SavePassword
Gets or sets whether to save the password.
Declaration
public bool SavePassword { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
SingleSignOnId
Specifies the single sign-on identifier.
Declaration
public string SingleSignOnId { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
SourceFile
Used when the external data source is file-based. When a connection to such a data source fails, the spreadsheet application attempts to connect directly to this file. May be expressed in URI or system-specific file path notation.
Declaration
public string SourceFile { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Type
Specifies the type of the data connection.
Declaration
public DataConnectionType Type { get; set; }
Property Value
| Type | Description |
|---|---|
| DataConnectionType |