Share via


IServerTypeConnection Interface

Represents the extra interface that provides the functionality for creating a closed connection object.

Namespace:  Microsoft.SqlServer.Management.UI.ConnectionDlg
Assembly:  ConnectionDlg (in ConnectionDlg.dll)

Syntax

'Declaration
Public Interface IServerTypeConnection _
    Inherits IServerType
'Usage
Dim instance As IServerTypeConnection
public interface IServerTypeConnection : IServerType
public interface class IServerTypeConnection : IServerType
type IServerTypeConnection =  
    interface
        interface IServerType
    end
public interface IServerTypeConnection extends IServerType

The IServerTypeConnection type exposes the following members.

Properties

  Name Description
Public property AuthenticationInfoCollection Gets a table which contains the authentication labels used to populate the simple view of the connection dialog box. (Inherited from IServerType.)
Public property RequestedPropertySize Gets the size that the custom user control needs to render correctly. This is used by both the advanced view of the connection dialog box and the New Server Registration dialog box to ensure that they expose enough screen space for the whole control to be visible. (Inherited from IServerType.)
Public property ServerGroupName Gets the name of the server group root node for the server type. Used in the Registered Servers user interface. (Inherited from IServerType.)
Public property ServerInstanceName Gets the instance name of the server. (Inherited from IServerType.)
Public property ServerType Gets the GUID for the server type that is exposed to the user in the Server type combo box. (Inherited from IServerType.)
Public property ServerTypeName Gets the string that is exposed to the user in the Server type combo box. (Inherited from IServerType.)

Top

Methods

  Name Description
Public method CreateClosedConnectionObject Creates a closed connection object based on a given UIConnectionInfo.
Public method GenerateImage Returns a newly-instantiated icon that is displayed in the Registered Servers tree. (Inherited from IServerType.)
Public method GenerateUserControl Returns a newly-instantiated user control that is displayed on the Connection Properties tab of the advanced view of the connection dialog box. (Inherited from IServerType.)
Public method GetConnectionObject Returns a new IDbConnection object (closed) that is based on the passed UIConnectionInfo object. (Inherited from IServerType.)
Public method LoadPersonalizationInfo Loads any personalization information that was saved upon successful connection by using [M:Microsoft.SqlServer.Management.UI.ConnectionDlg.IServerType.SavePersonalizationInfo(Microsoft.SqlServer.Management.Smo.RegSvrEnum.UIConnectionInfo]. The personalization information is uniquely identified by a combination of server type, server name, authentication type, and user name. (Inherited from IServerType.)
Public method ProceedWithConnection Used when a server type needs to perform additional processing steps. Indicates whether the connection can continue, or whether the connection dialog box should remain on the screen. (Inherited from IServerType.)
Public method SavePersonalizationInfo Saves personalization information that may be needed for subsequent uses of the connection dialog box, such as the server type, server name, authentication type, and user name. (Inherited from IServerType.)

Top