ExtensionHandle Class

  • Article

Base class for generic version for ExtensionHandle. The handle that contains the extension type, the named configuration for this extension type.

This API is not CLS-compliant. 

Inheritance Hierarchy

System..::..Object
  Microsoft.Data.Tools.Schema.Extensibility..::..ExtensionHandle
    Microsoft.Data.Tools.Schema.Extensibility..::..ExtensionHandle< (Of < ( <'TInterfaceType> ) > ) >

Namespace:  Microsoft.Data.Tools.Schema.Extensibility
Assembly:  Microsoft.Data.Tools.Schema.Sql (in Microsoft.Data.Tools.Schema.Sql.dll)

Syntax

'Declaration
<CLSCompliantAttribute(False)> _
Public Class ExtensionHandle _
    Implements IEquatable(Of ExtensionHandle), IXmlSerializable
'Usage
Dim instance As ExtensionHandle

[CLSCompliantAttribute(false)]
public class ExtensionHandle : IEquatable<ExtensionHandle>, 
    IXmlSerializable

[CLSCompliantAttribute(false)]
public ref class ExtensionHandle : IEquatable<ExtensionHandle^>, 
    IXmlSerializable

[<CLSCompliantAttribute(false)>]
type ExtensionHandle =  
    class
        interface IEquatable<ExtensionHandle>
        interface IXmlSerializable
    end

public class ExtensionHandle implements IEquatable<ExtensionHandle>, IXmlSerializable

The ExtensionHandle type exposes the following members.

Constructors

  Name Description
Protected method ExtensionHandle Default constructor used for deserialization.

Top

Properties

  Name Description
Public property Description Description of this extension.
Public property ExtensionType Returns type represented by the ExtensionHandle
Public property ExtensionTypeFriendlyName The friendly name of the extension type. It will read from ExtensionDescriptionAttribute that placed on the extension. If no attribute is found, extension type's short name will be used as ExtensionType friendly name.
Public property FriendlyName The friendly name of this ExtensionHandle. The friendly name is composed with ExtensionType's friendly defined in ExtensionDescriptionAttribute, plus the ConfigurationName. If there is no configuration for this extension, it will just be the friendly name of this extension.
Public property Publisher Publisher of this extension.

Top

Methods

  Name Description
Public method Equals(Object) (Overrides Object..::..Equals(Object).)
Public method Equals(ExtensionHandle) Compare two ExtensionHandle. If the ExtensionType and the ConfigurationName is the same, we say they are equal.
Protected method Finalize (Inherited from Object.)
Public method GetHashCode Get the HashCode for ExtensionHandle based on ExtensionType and the ConfigurationName. (Overrides Object..::..GetHashCode() () () ().)
Public method GetSchema Get the schema for xml serailization of this extension.
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method ReadXml This method is used to help deserialize an extension. During deserialization, it will read the Assembly name, type name and configuration name from XmlReader. And try to find the extensions in already loaded extensions that matches all these information, if nothing found, the type will be set to null.
Public method ToString (Inherited from Object.)
Public method WriteXml Serialize out this extension. It will write assembly full name, type fullname and configuration name to XmlWriter.

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.Data.Tools.Schema.Extensibility Namespace