SqlServerType Class

Implements the connection dialog interfaces for Database Engine server type connections.

This API is not CLS-compliant. 

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.UI.ConnectionDlg.SqlServerType

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

Syntax

'Declaration
<RegisterServerHelpKeyWordAttribute("sql11.swb.registerserver.general.sqlserver.f1")> _
<AdvancedViewHelpKeyWordAttribute("sql11.swb.connecttosqlserver.login.f1")> _
<CLSCompliantAttribute(False)> _
<HelpKeyWordAttribute("sql11.swb.connection.login.sqlserver.f1")> _
Public Class SqlServerType _
    Implements IServerType, IConnectionValidator
'Usage
Dim instance As SqlServerType
[RegisterServerHelpKeyWordAttribute("sql11.swb.registerserver.general.sqlserver.f1")]
[AdvancedViewHelpKeyWordAttribute("sql11.swb.connecttosqlserver.login.f1")]
[CLSCompliantAttribute(false)]
[HelpKeyWordAttribute("sql11.swb.connection.login.sqlserver.f1")]
public class SqlServerType : IServerType, 
    IConnectionValidator
[RegisterServerHelpKeyWordAttribute(L"sql11.swb.registerserver.general.sqlserver.f1")]
[AdvancedViewHelpKeyWordAttribute(L"sql11.swb.connecttosqlserver.login.f1")]
[CLSCompliantAttribute(false)]
[HelpKeyWordAttribute(L"sql11.swb.connection.login.sqlserver.f1")]
public ref class SqlServerType : IServerType, 
    IConnectionValidator
[<RegisterServerHelpKeyWordAttribute("sql11.swb.registerserver.general.sqlserver.f1")>]
[<AdvancedViewHelpKeyWordAttribute("sql11.swb.connecttosqlserver.login.f1")>]
[<CLSCompliantAttribute(false)>]
[<HelpKeyWordAttribute("sql11.swb.connection.login.sqlserver.f1")>]
type SqlServerType =  
    class 
        interface IServerType 
        interface IConnectionValidator 
    end
public class SqlServerType implements IServerType, IConnectionValidator

The SqlServerType type exposes the following members.

Constructors

  Name Description
Public method SqlServerType() Initializes a new instance of the SqlServerType class with the default property values.
Public method SqlServerType(Decimal) Initializes a new instance of the SqlServerType class with the specified default execution time-out value.
Public method SqlServerType(array<Int32[]) Initializes a new instance of the SqlServerType class with specified supported authentication types.
Public method SqlServerType(array<Int32[], Decimal) Initializes a new instance of the SqlServerType class with specified supported authentication types and default execution time-out value.

Top

Methods

  Name Description
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method ToString (Inherited from Object.)

Top

Fields

  Name Description
Protected field authCollection Specifies the authentication information collection for the server.
Public fieldStatic member ConnectionTimeout A String constant with the CONNECTION_TIMEOUT value.
Public fieldStatic member CustomConnectionColor A String constant with the CUSTOM_CONNECTION_COLOR value.
Public fieldStatic member Database A String constant with the DATABASE value.
Public fieldStatic member EncryptConnection A String constant with the ENCRYPT_CONNECTION value.
Public fieldStatic member ExecutionTimeout A String constant with the EXEC_TIMEOUT value.
Public fieldStatic member ExecutionTimeoutDisable A String constant with the EXEC_TIMEOUT_DISABLE value.
Public fieldStatic member NetworkProtocol A String constant with the PROTOCOL value.
Public fieldStatic member PacketSize A String constant with the PACKET_SIZE value.
Protected fieldStatic member reqSize Specifies the requested property size for the server.
Protected field serverInstanceName Specifies the instance name for the server.
Protected field serverName Specifies a string that represents the name of the server.
Protected field serverRootName Specifies a string that represents the root name of the server.
Public fieldStatic member ServerType The GUID for the server type.
Public fieldStatic member SqlAuthenticationType A constant of type Int, with a value of 1.
Public fieldStatic member SqlExpressEditionNumber A constant of type Int, with a value of 4.
Public fieldStatic member TrustedAuthenticationType A constant of type Int, with a value of 0.
Public fieldStatic member UseCustomConnectionColor A String constant with the USE_CUSTOM_CONNECTION_COLOR value.

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IConnectionValidator.CheckConnection Checks if successfully opened connection should be returned to the calling application Throws NotSupportedException exception if it should be bounced with error message as the exception text.
Explicit interface implemetationPrivate property IServerType.AuthenticationInfoCollection Gets a table that contains the authentication labels that are used to populate the simple view of the connection dialog box.
Explicit interface implemetationPrivate method IServerType.GenerateImage Retrieves newly-instantiated icon that is displayed in the Registered Servers tree.
Explicit interface implemetationPrivate method IServerType.GenerateUserControl Retrieves a newly-instantiated user control that is displayed on the Connection Properties tab of the advanced view of the connection dialog box.
Explicit interface implemetationPrivate method IServerType.GetConnectionObject Retrieves a new IDbConnection object (closed) that is based on the passed UIConnectionInfo object.
Explicit interface implemetationPrivate method IServerType.LoadPersonalizationInfo Loads any personalization information that is saved upon successful connection by using SavePersonalizationInfo.
Explicit interface implemetationPrivate method IServerType.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.
Explicit interface implemetationPrivate property IServerType.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.
Explicit interface implemetationPrivate method IServerType.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.
Explicit interface implemetationPrivate property IServerType.ServerGroupName Gets the name of the server group root node for the server type.
Explicit interface implemetationPrivate property IServerType.ServerInstanceName Gets the instance name of the server.
Explicit interface implemetationPrivate property IServerType.ServerType Gets the server type for the instance of SQL Server.
Explicit interface implemetationPrivate property IServerType.ServerTypeName Gets the string that is exposed to the user in the Server Type combo box.

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.SqlServer.Management.UI.ConnectionDlg Namespace