.NET Framework Class Library
LicenseProviderAttribute Class

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

Inheritance Hierarchy
SystemObject
   SystemAttribute
    System.ComponentModelLicenseProviderAttribute

Namespace:   System.ComponentModel
Assembly:  System (in System.dll)
Syntax
<[%$TOPIC/8795y7ty_en-us_VS_110_3_0_0_0_0%]([%$TOPIC/8795y7ty_en-us_VS_110_3_0_0_0_1%].Class, AllowMultiple := False, Inherited := False)> _
Public NotInheritable Class LicenseProviderAttribute _
	Inherits [%$TOPIC/8795y7ty_en-us_VS_110_3_0_0_0_2%]
[[%$TOPIC/8795y7ty_en-us_VS_110_3_0_1_0_0%]([%$TOPIC/8795y7ty_en-us_VS_110_3_0_1_0_1%].Class, AllowMultiple = false, Inherited = false)]
public sealed class LicenseProviderAttribute : [%$TOPIC/8795y7ty_en-us_VS_110_3_0_1_0_2%]
[[%$TOPIC/8795y7ty_en-us_VS_110_3_0_2_0_0%]([%$TOPIC/8795y7ty_en-us_VS_110_3_0_2_0_1%]::Class, AllowMultiple = false, Inherited = false)]
public ref class LicenseProviderAttribute sealed : public [%$TOPIC/8795y7ty_en-us_VS_110_3_0_2_0_2%]
[<[%$TOPIC/8795y7ty_en-us_VS_110_3_0_3_0_0%]>]
[<[%$TOPIC/8795y7ty_en-us_VS_110_3_0_3_0_1%]([%$TOPIC/8795y7ty_en-us_VS_110_3_0_3_0_2%].Class, AllowMultiple = false, Inherited = false)>]
type LicenseProviderAttribute =  
    class 
        inherit [%$TOPIC/8795y7ty_en-us_VS_110_3_0_3_0_3%] 
    end
public final class LicenseProviderAttribute extends [%$TOPIC/8795y7ty_en-us_VS_110_3_0_4_0_0%]

The LicenseProviderAttribute type exposes the following members.

Constructors
  NameDescription
Public method LicenseProviderAttributeInitializes a new instance of the LicenseProviderAttribute class without a license provider.
Public method LicenseProviderAttribute(String)Initializes a new instance of the LicenseProviderAttribute class with the specified type.
Public method LicenseProviderAttribute(Type)Initializes a new instance of the LicenseProviderAttribute class with the specified type of license provider.
Top
Properties
  NameDescription
Public property LicenseProviderGets the license provider that must be used with the associated class.
Public property TypeIdIndicates a unique ID for this attribute type. (Overrides AttributeTypeId.)
Top
Methods
  NameDescription
Public method EqualsIndicates whether this instance and a specified object are equal. (Overrides AttributeEquals(Object).)
Public method GetHashCodeReturns the hash code for this instance. (Overrides AttributeGetHashCode.)
Public method GetTypeGets the Type of the current instance. (Inherited from Object.)
Public method IsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public method MatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Public method ToStringReturns a string that represents the current object. (Inherited from Object.)
Top
Fields
  NameDescription
Public field Static member DefaultSpecifies the default value, which is no provider. This static field is read-only.
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implemetation Private method _AttributeGetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeInvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top
Remarks

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.

NoteNote

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.

Examples

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

<LicenseProvider(GetType(LicFileLicenseProvider))> _
Public Class MyControl
    Inherits Control

    ' Insert code here. 
    Protected Overrides Sub Dispose(ByVal disposing As Boolean)
        ' All components must dispose of the licenses they grant. 
        ' Insert code here to dispose of the license. 
    End Sub         

End Class
[LicenseProvider(typeof(LicFileLicenseProvider))]
 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. */
    }
 }
[LicenseProvider(LicFileLicenseProvider::typeid)]
ref class MyControl: public Control
{
protected:

   // Insert code here.
   ~MyControl()
   {
      /* 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 Shared Function Main() As Integer 
    ' Creates a new component. 
    Dim myNewControl As New MyControl()

    ' Gets the attributes for the component. 
    Dim attributes As AttributeCollection = TypeDescriptor.GetAttributes(myNewControl)

    ' Prints the name of the license provider by retrieving the LicenseProviderAttribute  
    ' from the AttributeCollection.  
    Dim myAttribute As LicenseProviderAttribute = _
        CType(attributes(GetType(LicenseProviderAttribute)), LicenseProviderAttribute)

    Console.WriteLine(("The license provider for this class is: " & _
        myAttribute.LicenseProvider.ToString()))
    Return 0
End Function
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;
 }
int main()
{
   // Creates a new component.
   MyControl^ myNewControl = gcnew 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 = dynamic_cast<LicenseProviderAttribute^>(attributes[ LicenseProviderAttribute::typeid ]);
   Console::WriteLine( "The license provider for this class is: {0}", myAttribute->LicenseProvider );
   return 0;
}
Version Information

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
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.