Edit

Share via


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 sealed class LicenseManager
Inheritance
LicenseManager

Examples

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

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;
         }
      }
   }
}

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

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

UsageMode

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

Methods

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.

CreateWithContext(Type, LicenseContext)

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

Equals(Object)

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

(Inherited from Object)
GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
IsLicensed(Type)

Returns whether the given type has a valid 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.

IsValid(Type)

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

LockContext(Object)

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

MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString()

Returns a string that represents the current object.

(Inherited from Object)
UnlockContext(Object)

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

Validate(Type, Object)

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

Validate(Type)

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

Applies to

Product Versions
.NET Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 2.0, 2.1

See also