Class ExternalConnection
Represents the external connection
Inherited Members
Namespace: Syncfusion.XlsIO.Implementation
Assembly: Syncfusion.XlsIO.NET.dll
Syntax
public class ExternalConnection : CommonObject, IDisposable, IConnection, IParentApplication
Constructors
ExternalConnection(IApplication, object)
External connection
Declaration
public ExternalConnection(IApplication application, object parent)
Parameters
| Type | Name | Description |
|---|---|---|
| IApplication | application | |
| object | parent |
Properties
BackgroundQuery
Gets or sets the value indicating whether the Query is asynchronus with DB.
Declaration
public bool BackgroundQuery { get; set; }
Property Value
| Type |
|---|
| bool |
ConnectionFile
Gets or sets the connection file.
Declaration
public string ConnectionFile { get; set; }
Property Value
| Type |
|---|
| string |
ConnectionId
Gets or sets the connection id.
Declaration
public uint ConnectionId { get; set; }
Property Value
| Type |
|---|
| uint |
DBConnectionString
Gets or sets the Database connection string.
Declaration
public string DBConnectionString { get; set; }
Property Value
| Type |
|---|
| string |
DataBaseType
Gets or sets the Database Type.
Declaration
public ExcelConnectionsType DataBaseType { get; set; }
Property Value
| Type |
|---|
| ExcelConnectionsType |
Deleted
Gets or sets the value indicating whether the connection is deleted.
Declaration
public bool Deleted { get; set; }
Property Value
| Type |
|---|
| bool |
Description
Gets or sets the connection description.
Declaration
public string Description { get; set; }
Property Value
| Type |
|---|
| string |
ExtLstProperty
Gets or sets the Ext_Lst Stream
Declaration
public Stream ExtLstProperty { get; set; }
Property Value
| Type |
|---|
| Stream |
IsExist
Gets or sets a value indicating whether the connection for query table exists.
Declaration
public bool IsExist { get; set; }
Property Value
| Type |
|---|
| bool |
Name
Gets or sets the connection name.
Declaration
public string Name { get; set; }
Property Value
| Type |
|---|
| string |
ODBCConnection
Gets or sets the ODBC connection.
Declaration
public ODBCConnection ODBCConnection { get; set; }
Property Value
| Type |
|---|
| ODBCConnection |
OLEDBConnection
Gets or sets the OLEDB Connection.
Declaration
public OLEDBConnection OLEDBConnection { get; set; }
Property Value
| Type |
|---|
| OLEDBConnection |
OlapProperty
Gets or sets the Olap Stream.
Declaration
public Stream OlapProperty { get; set; }
Property Value
| Type |
|---|
| Stream |
Password
Gets or sets the Password of External connection.
Declaration
public string Password { get; set; }
Property Value
| Type |
|---|
| string |
Range
Gets or sets the connection range.
Declaration
public IRange Range { get; set; }
Property Value
| Type |
|---|
| IRange |
RefreshedVersion
Gets or sets the refreshed version.
Declaration
public uint RefreshedVersion { get; set; }
Property Value
| Type |
|---|
| uint |
SourceFile
Gets or sets the source file.
Declaration
public string SourceFile { get; set; }
Property Value
| Type |
|---|
| string |
Methods
Delete()
Delete the connection from the connection collection.
Declaration
public void Delete()
Disposeall()
Dispose the connection
Declaration
public void Disposeall()
~ExternalConnection()
External connection
Declaration
protected ~ExternalConnection()
RaiseEvent(object, ConnectionPassword)
Event
Declaration
public void RaiseEvent(object sender, ConnectionPassword args)
Parameters
| Type | Name | Description |
|---|---|---|
| object | sender | |
| ConnectionPassword | args |
Events
OnConnectionPassword
connection password events
Declaration
public event ConnectionPasswordEventHandler OnConnectionPassword
Event Type
| Type |
|---|
| ConnectionPasswordEventHandler |