This documentation is archived and is not being maintained.

LicenseProviderAttribute Class

Specifies the LicenseProvider to use with a class. This class cannot be inherited.


Namespace:  System.ComponentModel
Assembly:  System (in System.dll)

[AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple = false, Inherited = false)]
public sealed class LicenseProviderAttribute : Attribute

The LicenseProviderAttribute type exposes the following members.

Public methodLicenseProviderAttribute()Initializes a new instance of the LicenseProviderAttribute class without a license provider.
Public methodLicenseProviderAttribute(String)Initializes a new instance of the LicenseProviderAttribute class with the specified type.
Public methodLicenseProviderAttribute(Type)Initializes a new instance of the LicenseProviderAttribute class with the specified type of license provider.

Public propertyLicenseProviderGets the license provider that must be used with the associated class.
Public propertyTypeIdIndicates a unique ID for this attribute type. (Overrides Attribute.TypeId.)

Public methodEqualsIndicates whether this instance and a specified object are equal. (Overrides Attribute.Equals(Object).)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeReturns the hash code for this instance. (Overrides Attribute.GetHashCode().)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public methodMatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

Public fieldStatic memberDefaultSpecifies the default value, which is no provider. This static field is read-only.

Explicit interface implemetationPrivate method_Attribute.GetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.InvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)

When you create a component that you want to license, you must specify the LicenseProvider by marking the component with a LicenseProviderAttribute.

Use the LicenseProvider property to get the Type of the LicenseProvider.

For more information about attributes, see Extending Metadata Using Attributes. For more information about licensing, see How to: License Components and Controls.


The HostProtectionAttribute attribute applied to this class has the following Resources property value: SharedState. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

The following code example uses the LicFileLicenseProvider as the license provider for MyControl.

 public class MyControl : Control {

    // Insert code here.

    protected override void Dispose(bool disposing) {
       /* All components must dispose of the licenses they grant. 
        * Insert code here to dispose of the license. */

The next code example creates an instance of the MyControl class. Then, it gets the attributes for the class, and prints the name of the license provider used by myNewControl.

public static int Main() {
    // Creates a new component.
    MyControl myNewControl = new MyControl();

    // Gets the attributes for the component.
    AttributeCollection attributes = TypeDescriptor.GetAttributes(myNewControl);

    /* Prints the name of the license provider by retrieving the LicenseProviderAttribute 
     * from the AttributeCollection. */
    LicenseProviderAttribute myAttribute = (LicenseProviderAttribute)attributes[typeof(LicenseProviderAttribute)];
    Console.WriteLine("The license provider for this class is: " + myAttribute.LicenseProvider.ToString());

    return 0;

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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