How to dynamically add ActiveX controls that require run-time licenses in Visual Basic .NET or in Visual Basic 2005
This article was previously published under Q326651
For a Microsoft Visual C# .NET version of this article, see 326652.
For a Microsoft Visual Basic 6.0 version of this article, see 190670.
IN THIS TASK
This step-by-step article describes how to manually add a run-time license to an ActiveX control that is dynamically created in Visual Basic .NET or in Visual Basic 2005. In Visual Basic version 6, you can manually add licenses to the license collection by using the Licenses.Add() method. For more information about what License.Add() does in Visual Basic 6, see the "References" section of this article.
In Visual Basic .NET or in Visual Basic 2005, the licenses collection no longer exists. You must embed the license information in the control.
This article assumes that the control that requires the run-time license is in MyProject.OCX and is named MyLicensedControl. MyProject.OCX is located in C:\Windows\System32.
back to the top
Create a New Visual Basic .NET or Visual Basic 2005 Project
- Click Start, point to All Programs, point to Microsoft Visual Studio .NET or Microsoft Visual Studio 2005, and then click Microsoft Visual Studio .NET or Microsoft Visual Studio 2005.
- On the File menu, point to New, and then click Project.
- In the New Project dialog box, click Visual Basic Projects under Project Types, click Windows Application under Templates, and then click OK.
Note In Visual Studio 2005, click Visual Basic under Project Types.
Create ActiveX Interop Assemblies
- Click Start, point to All Programs, point to Microsoft Visual Studio .NET or Microsoft Visual Studio 2005, point to Visual Studio .NET Tools or Visual Studio 2005 Tools, and then click Visual Studio .NET Command Prompt or Visual Studio 2005 Command Prompt.
- To create the two interop assemblies that you must have, type the following command: aximp /out:C:\temp\AxMyProject.dll "C:\Windows\System32\MyProject.ocx"AxMyProject.dll is for AxHost Interop. MyProject.dll is for COM Interop.
Dynamically Create the Control
- On the Project menu, click Add Reference.
- Click Browse, and then select the ActiveX Control Interop assemblies that you just created (they should be in C:\Temp).
- Add both AxMyProject.dll and MyProject.dll; adding these files copies them locally.
- Add a Button control to the form.
- Double-click the button to find the code for the Button Click Event method.
- In the Button Click Event method, paste the following code: This creates a new instance of the control through AxHost.
Dim myControl As New AxMyProject.AxMyLicensedControl()
NOTE: Do not create a new instance of the control through COM (New MyProject.MyLicensedControl), because this will not work on the form, and you cannot easily add the license.
Add the License to the Control
- Determine and note the run-time license key for the control. For MyLicensedControl, the license key is "gnvlslnjskvlmlgnnimh".
- In the Button Click Event method, paste the following code below Dim myControl As New AxMyProject.AxMyLicensedControl():This code inserts the run-time license into the control. It creates an instance of FieldInfo, which is part of the property bag OCXState. This property bag is full of specific ActiveX control information. In this case, you are obtaining the field licenseKey and setting it for myControl. You must do this for each instance of any ActiveX control that requires a run-time license.
Dim f As System.Reflection.FieldInfo f = GetType(AxHost).GetField("licenseKey", _ Reflection.BindingFlags.NonPublic _ Or Reflection.BindingFlags.Instance) f.SetValue(myControl, "gnvlslnjskvlmlgnnimh")
Add the Control to the Form
- Add the control to the form's Controls collection, and then show the control. To do this, you can use the following code: Paste this code in the Button Click Event method, after "f.SetValue(myControl, "gnvlslnjskvlmlgnnimh")", and before the "End Sub" line.
NOTE: If the license is not added to the control and the license is required, Controls.Add will fail. Controls.Add runs the code that contains that license validation. When you try and run Controls.Add, you see the following error in debug mode:An unhandled exception of type 'System.ComponentModel.LicenseException' occurred in system.windows.forms.dll Additional information: You do not have a license to use this ActiveX control.Or, at run time, you may see the following similar error message:An unhandled exception has occurred in your application. You do not have a license to use this ActiveX control.
- Press F5 to run the project.
- Click the button to add your ActiveX Control to the form.
TroubleshootingIMPORTANT: Note the following about this operation:
- You must add the license to every instance of every ActiveX control that requires a run-time license. For example, if you create a second instance of MyLicensedControl, you have to add the license to that instance also.
- Make sure that you have the correct license key for your control. Determining the correct license key is specific to the control: For additional information about determining the key, click the article number below to view the article in the Microsoft Knowledge Base: 151771 LICREQST.EXE Requesting a License Key from an ObjectAlternatively, you can use Licenses.Add for the control in Visual Basic 6 on a computer that has the license in the registry. Licenses.Add returns the run-time license that it added as a string; you can then use Debug.Print to obtain the license key.
For additional information, click the article numbers below to view the articles in the Microsoft Knowledge Base:
241126 INFO:Dynamically Add UserControls That Require Run-Time Licenses
188577 HOWTO: What is the Licenses Collection Used For?
190670 HOWTO: Dynamically Add Controls to a Form with Visual Basic 6.0back to the top
Article ID: 326651 - Last Review: 12/06/2006 23:18:59 - Revision: 3.3
Microsoft Visual Basic 2005, Microsoft Visual Basic .NET 2003 Standard Edition, Microsoft Visual Basic .NET 2002 Standard Edition
- kbvs2005swept kbvs2005applies kbhowtomaster KB326651