Class ExternalConnection
Represents the external connection
Inherited Members
Namespace: Syncfusion.XlsIO.Implementation
Assembly: Syncfusion.XlsIO.UWP.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 | |
System.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 |
---|
System.Boolean |
ConncetionId
Gets the connection id.
Declaration
public uint ConncetionId { get; set; }
Property Value
Type |
---|
System.UInt32 |
Remarks
This API is deprecated. Please use the the ConnectionId instead.
ConnectionFile
Gets or sets the connection file.
Declaration
public string ConnectionFile { get; set; }
Property Value
Type |
---|
System.String |
ConnectionId
Gets or sets the connection id.
Declaration
public uint ConnectionId { get; set; }
Property Value
Type |
---|
System.UInt32 |
DataBaseType
Gets or sets the Database Type.
Declaration
public ExcelConnectionsType DataBaseType { get; set; }
Property Value
Type |
---|
ExcelConnectionsType |
DBConnectionString
Gets or sets the Database connection string.
Declaration
public string DBConnectionString { get; set; }
Property Value
Type |
---|
System.String |
Deleted
Gets or sets the value indicating whether the connection is deleted.
Declaration
public bool Deleted { get; set; }
Property Value
Type |
---|
System.Boolean |
Description
Gets or sets the connection description.
Declaration
public string Description { get; set; }
Property Value
Type |
---|
System.String |
ExtLstProperty
Gets or sets the Ext_Lst Stream
Declaration
public Stream ExtLstProperty { get; set; }
Property Value
Type |
---|
System.IO.Stream |
IsExist
Gets or sets a value indicating whether the connection for query table exists.
Declaration
public bool IsExist { get; set; }
Property Value
Type |
---|
System.Boolean |
Name
Gets or sets the connection name.
Declaration
public string Name { get; set; }
Property Value
Type |
---|
System.String |
ODBCConnection
Gets or sets the ODBC connection.
Declaration
public ODBCConnection ODBCConnection { get; set; }
Property Value
Type |
---|
ODBCConnection |
OlapProperty
Gets or sets the Olap Stream.
Declaration
public Stream OlapProperty { get; set; }
Property Value
Type |
---|
System.IO.Stream |
OLEDBConnection
Gets or sets the OLEDB Connection.
Declaration
public OLEDBConnection OLEDBConnection { get; set; }
Property Value
Type |
---|
OLEDBConnection |
password
Gets or sets the Password of External connection.
Declaration
public string password { get; set; }
Property Value
Type |
---|
System.String |
Remarks
This API is deprecated. Please use the Password instead.
Password
Declaration
public string Password { get; set; }
Property Value
Type |
---|
System.String |
Range
Gets or sets the connection range.
Declaration
public IRange Range { get; set; }
Property Value
Type |
---|
IRange |
RefershedVersion
Delete the connection
Declaration
public uint RefershedVersion { get; set; }
Property Value
Type |
---|
System.UInt32 |
Remarks
This API is deprecated. Please use the RefreshedVersion instead.
RefreshedVersion
Gets or sets the refreshed version.
Declaration
public uint RefreshedVersion { get; set; }
Property Value
Type |
---|
System.UInt32 |
SourceFile
Gets or sets the source file.
Declaration
public string SourceFile { get; set; }
Property Value
Type |
---|
System.String |
Methods
add_OnConnectionPassword(ConnectionPasswordEventHandler)
Declaration
public void add_OnConnectionPassword(ConnectionPasswordEventHandler value)
Parameters
Type | Name | Description |
---|---|---|
ConnectionPasswordEventHandler | value |
Delete()
Delete the connection from the connection collection.
Declaration
public void Delete()
Disposeall()
Dispose the connection
Declaration
public void Disposeall()
Finalize()
External connection
Declaration
protected override void Finalize()
Overrides
RaiseEvent(Object, ConnectionPassword)
Event
Declaration
public void RaiseEvent(object sender, ConnectionPassword args)
Parameters
Type | Name | Description |
---|---|---|
System.Object | sender | |
ConnectionPassword | args |
remove_OnConnectionPassword(ConnectionPasswordEventHandler)
Declaration
public void remove_OnConnectionPassword(ConnectionPasswordEventHandler value)
Parameters
Type | Name | Description |
---|---|---|
ConnectionPasswordEventHandler | value |
Events
OnConnectionPassword
connection password events
Declaration
public event ConnectionPasswordEventHandler OnConnectionPassword
Event Type
Type |
---|
ConnectionPasswordEventHandler |