LicenseManager LicenseManager LicenseManager LicenseManager Class

Definition

Provides properties and methods to add a license to a component and to manage a LicenseProvider. This class cannot be inherited.

public ref class LicenseManager sealed
public sealed class LicenseManager
type LicenseManager = class
Public NotInheritable Class LicenseManager
Inheritance
LicenseManagerLicenseManagerLicenseManagerLicenseManager

Examples

The following code example creates a licensed control using the Validate method. It uses a LicenseProvider that is implemented by the LicFileLicenseProvider class.

// Adds the LicenseProviderAttribute to the control.

[LicenseProvider(LicFileLicenseProvider::typeid)]
public ref class MyControl: public Control
{
   // Creates a new, null license.
private:
   License^ license;

public:
   MyControl()
   {
      
      // Adds Validate to the control's constructor.
      license = LicenseManager::Validate( MyControl::typeid, this );

      // Insert code to perform other instance creation tasks here.
   }

public:
   ~MyControl()
   {
      if ( license != nullptr )
      {
         delete license;
         license = nullptr;
      }
   }
};
using System;
using System.ComponentModel;
using System.Windows.Forms;


// Adds the LicenseProviderAttribute to the control.
[LicenseProvider(typeof(LicFileLicenseProvider))]
public class MyControl : Control 
{
 
   // Creates a new, null license.
   private License license = null;
 
   public MyControl () 
   {
 
      // Adds Validate to the control's constructor.
      license = LicenseManager.Validate(typeof(MyControl), this);
 
      // Insert code to perform other instance creation tasks here.
   }
 
   protected override void Dispose(bool disposing) 
   {
      if(disposing)
      {
         if (license != null) 
         {
            license.Dispose();
            license = null;
         }
      }
   }
 
}
Imports System
Imports System.ComponentModel
Imports System.Windows.Forms

' Adds the LicenseProviderAttribute to the control.
<LicenseProvider(GetType(LicFileLicenseProvider))> _
Public Class MyControl
    Inherits Control
    
    ' Creates a new, null license.
    Private license As License = Nothing    
    
    Public Sub New()        
    
        ' Adds Validate to the control's constructor.
        license = LicenseManager.Validate(GetType(MyControl), Me)

        ' Insert code to perform other instance creation tasks here.
        
    End Sub
    
    Protected Overrides Sub Dispose(ByVal disposing As Boolean)

        If disposing Then
            If (license IsNot Nothing) Then
                license.Dispose()
                license = Nothing
            End If
        End If

    End Sub    
    
End Class

Remarks

The LicenseManager class provides the following static properties: CurrentContext and UsageMode. The class also provides the following static methods: CreateWithContext, IsValid, and Validate.

When you create a component that you want to license, you must do the following:

  1. Specify the LicenseProvider by marking the component with a LicenseProviderAttribute.

  2. Call Validate or IsValid in the constructor of the component. Validate throws a LicenseException when it tries to create an instance without a valid license. IsValid does not throw an exception.

  3. Call Dispose on any license that is granted when the component is disposed or finalized.

For more information on licensing, see How to: License Components and Controls.

Properties

CurrentContext CurrentContext CurrentContext CurrentContext

Gets or sets the current LicenseContext, which specifies when you can use the licensed object.

UsageMode UsageMode UsageMode UsageMode

Gets the LicenseUsageMode which specifies when you can use the licensed object for the CurrentContext.

Methods

CreateWithContext(Type, LicenseContext) CreateWithContext(Type, LicenseContext) CreateWithContext(Type, LicenseContext) CreateWithContext(Type, LicenseContext)

Creates an instance of the specified type, given a context in which you can use the licensed instance.

CreateWithContext(Type, LicenseContext, Object[]) CreateWithContext(Type, LicenseContext, Object[]) CreateWithContext(Type, LicenseContext, Object[]) CreateWithContext(Type, LicenseContext, Object[])

Creates an instance of the specified type with the specified arguments, given a context in which you can use the licensed instance.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

Gets the Type of the current instance.

(Inherited from Object)
IsLicensed(Type) IsLicensed(Type) IsLicensed(Type) IsLicensed(Type)

Returns whether the given type has a valid license.

IsValid(Type) IsValid(Type) IsValid(Type) IsValid(Type)

Determines whether a valid license can be granted for the specified type.

IsValid(Type, Object, License) IsValid(Type, Object, License) IsValid(Type, Object, License) IsValid(Type, Object, License)

Determines whether a valid license can be granted for the specified instance of the type. This method creates a valid License.

LockContext(Object) LockContext(Object) LockContext(Object) LockContext(Object)

Prevents changes being made to the current LicenseContext of the given object.

MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Returns a string that represents the current object.

(Inherited from Object)
UnlockContext(Object) UnlockContext(Object) UnlockContext(Object) UnlockContext(Object)

Allows changes to be made to the current LicenseContext of the given object.

Validate(Type) Validate(Type) Validate(Type) Validate(Type)

Determines whether a license can be granted for the specified type.

Validate(Type, Object) Validate(Type, Object) Validate(Type, Object) Validate(Type, Object)

Determines whether a license can be granted for the instance of the specified type.

Applies to

See Also