Licensing and Subscription

Sometimes, in order to study the system better, you want to dive into the code as fast as possible. To make this easier, GroupDocs.Editor provides different plans for purchase or offers a Free Trial and a 30-day Temporary License for evaluation.

Note
Note that there are a number of general policies and practices that guide you on how to evaluate, properly license, and purchase our products. You can find them in the “Purchase Policies and FAQ” section.

Free Trial or Temporary License

You can try GroupDocs.Editor without buying a license.

Free Trial

The evaluation version is the same as the purchased one – the evaluation version simply becomes licensed when you set the license. You can set the license in a number of ways that described in the next sections of this article.

The evaluation version comes with the limitations:

  • Only first 2 pages are processed.
  • Trial badges are placed in the document on the top of each page.

Temporary License

If you wish to test GroupDocs.Editor without the limitations of the trial version, you can also request a 30-day Temporary License. For more details, see the “Get a Temporary License” page.

How to set a license

The license file contains details such as the product name, number of developers it is licensed to, subscription expiry date and so on. It contains the digital signature, so don’t modify the file. Even inadvertent addition of an extra line break into the file will invalidate it. You need to set a license before utilizing GroupDocs.Editor API if you want to avoid its evaluation limitations. The license can be loaded from a file or stream object. The easiest way to set a license is to put the license file in the same folder as the GroupDocs.Editor.dll file and specify the file name, without a path, as shown in the examples below.

Setting License from File

The code below will explain how to set product license.

// For complete examples and data files, please go to https://github.com/groupdocs-editor/GroupDocs.Editor-for-.NET
// Setup license.
License license = new License();
license.SetLicense(licensePath);

Setting License from Stream

The following example shows how to load a license from a stream.

// For complete examples and data files, please go to https://github.com/groupdocs-editor/GroupDocs.Editor-for-.NET
using (FileStream fileStream = File.OpenRead("GroupDocs.Editor.lic"))
{
    License license = new License();
    license.SetLicense(fileStream);
}
Note
Calling License.SetLicense multiple times is not harmful but simply wastes processor time. If you are developing a Windows Forms or console application, call License.SetLicense in your startup code, before using GroupDocs.Editor classes.
When developing an ASP.NET application, you can call License.SetLicense from the Global.asax.cs (Global.asax.vb) file in the Application_Start protected method. It is called once when the application starts.
Do not call License.SetLicense from within Page_Load methods since it means the license will be loaded every time a web page is loaded.

Setting Metered License

Note
You can also set Metered license as an alternative to license file. It is a new licensing mechanism that will be used along with existing licensing method. It is useful for the customers who want to be billed based on the usage of the API features. For more details, please refer to Metered Licensing FAQ section.
Here are the simple steps to use the Metered class.

  1. Create an instance of Metered class.
  2. Pass public & private keys to SetMeteredKey method.
  3. Do processing (perform task).
  4. call method GetConsumptionQuantity of the Metered class.
  5. It will return the amount/quantity of API requests that you have consumed so far.
  6. call method GetConsumptionCredit of the Metered class.
  7. It will return the credit that you have consumed so far.

Following is the sample code demonstrating how to use Metered class.

// For complete examples and data files, please go to https://github.com/groupdocs-editor/GroupDocs.Editor-for-.NET
string publicKey = ""; // Your public license key
string privateKey = ""; // Your private license key

Metered metered = new Metered();
metered.SetMeteredKey(publicKey, privateKey);

// Get amount (MB) consumed
decimal amountConsumed = GroupDocs.Editor.Metered.GetConsumptionQuantity();
Console.WriteLine("Amount (MB) consumed: " + amountConsumed);

// Get count of credits consumed
decimal creditsConsumed = GroupDocs.Editor.Metered.GetConsumptionCredit();
Console.WriteLine("Credits consumed: " + creditsConsumed);