Export (0) Print
Expand All

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

The IServerType type exposes the following members.

  NameDescription
Public propertyAuthenticationInfoCollectionGets a table which contains the authentication labels used to populate the simple view of the connection dialog box.
Public propertyRequestedPropertySizeGets 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.
Public propertyServerGroupNameGets the name of the server group root node for the server type. Used in the Registered Servers user interface.
Public propertyServerInstanceNameGets the instance name of the server.
Public propertyServerTypeGets the GUID for the server type that is exposed to the user in the Server type combo box.
Public propertyServerTypeNameGets the string that is exposed to the user in the Server type combo box.
Top

  NameDescription
Public methodGenerateImageReturns a newly-instantiated icon that is displayed in the Registered Servers tree.
Public methodGenerateUserControlReturns a newly-instantiated user control that is displayed on the Connection Properties tab of the advanced view of the connection dialog box.
Public methodGetConnectionObjectReturns a new IDbConnection object (closed) that is based on the passed UIConnectionInfo object.
Public methodLoadPersonalizationInfoLoads 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.
Public methodProceedWithConnectionUsed 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.
Public methodSavePersonalizationInfoSaves 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.
Top
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft