LicenseProviderAttribute Class
.NET Framework Class Library
LicenseProviderAttribute Class

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

Namespace:  System.ComponentModel
Assembly:  System (in System.dll)
Visual Basic (Declaration)
<AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple := False, Inherited := False)> _
Public NotInheritable Class LicenseProviderAttribute _
    Inherits Attribute
Visual Basic (Usage)
Dim instance As LicenseProviderAttribute
C#
[AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple = false, Inherited = false)]
public sealed class LicenseProviderAttribute : Attribute
Visual C++
[AttributeUsageAttribute(AttributeTargets::Class, AllowMultiple = false, Inherited = false)]
public ref class LicenseProviderAttribute sealed : public Attribute
JScript
public final class LicenseProviderAttribute extends 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 Attributes Overview and 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.

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

Visual Basic
<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
C#
[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. */
    }
 }
Visual C++
[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. */
   }
};
JScript
public LicenseProvider(LicFileLicenseProvider)
class MyControl extends Control{

    // Insert code here.
    function Dispose(){
        // All components must dispose of the licenses they grant.
        // Insert code here to dispose of the license.
    } //Dispose 
} //MyControl

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.

Visual Basic
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
C#
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;
 }
Visual C++
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;
}
JScript
// Creates a new component.
var myNewControl : MyControl = new MyControl()

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

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

System..::.Object
  System..::.Attribute
    System.ComponentModel..::.LicenseProviderAttribute
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0
Tags What's this?: Add a tag
Community Content   What is Community Content?
Add new content RSS  Annotations
Processing
Page view tracker