IServerType Interface

 

Represents the core interface that every entry in the connection dialog box must implement. Describes all major characteristics of the server type.

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

public interface IServerType

NameDescription
System_CAPS_pubpropertyAuthenticationInfoCollection

Gets a table which contains the authentication labels used to populate the simple view of the connection dialog box.

System_CAPS_pubpropertyRequestedPropertySize

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.

System_CAPS_pubpropertyServerGroupName

Gets the name of the server group root node for the server type. Used in the Registered Servers user interface.

System_CAPS_pubpropertyServerInstanceName

Gets the instance name of the server.

System_CAPS_pubpropertyServerType

Gets the GUID for the server type that is exposed to the user in the Server type combo box.

System_CAPS_pubpropertyServerTypeName

Gets the string that is exposed to the user in the Server type combo box.

NameDescription
System_CAPS_pubmethodGenerateImage()

Returns a newly-instantiated icon that is displayed in the Registered Servers tree.

System_CAPS_pubmethodGenerateUserControl()

Returns a newly-instantiated user control that is displayed on the Connection Properties tab of the advanced view of the connection dialog box.

System_CAPS_pubmethodGetConnectionObject(UIConnectionInfo)

Returns a new IDbConnection object (closed) that is based on the passed UIConnectionInfo object.

System_CAPS_pubmethodLoadPersonalizationInfo(UIConnectionInfo, Boolean)

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.

System_CAPS_pubmethodProceedWithConnection(UIConnectionInfo)

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.

System_CAPS_pubmethodSavePersonalizationInfo(UIConnectionInfo)

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.

Return to top
Show: