ComponentInfo Class

Namespace:

GemBox.Document

Assembly:

GemBox.Document.dll

Contains static licensing methods and diagnostic information about executing GemBox.Document assembly.

• C#
• VB.NET

public static class ComponentInfo

Public Module ComponentInfo

Inheritance:

System.Object

ComponentInfo

Properties

FullVersion

Gets GemBox.Document assembly full version.

• C#
• VB.NET

public static string FullVersion { get; }

Public Shared ReadOnly Property FullVersion As String

Property Value

System.String

GemBox.Document assembly full version.

Title

Gets GemBox.Document assembly title.

• C#
• VB.NET

public static string Title { get; }

Public Shared ReadOnly Property Title As String

Property Value

System.String

GemBox.Document assembly title.

Methods

SetLicense(String)

Sets the license (serial) key.

• C#
• VB.NET

public static void SetLicense(string serialKey)

Public Shared Sub SetLicense(serialKey As String)

Parameters

serialKey

System.String

The serial key.

Remarks

You should call this method before using any other class from GemBox.Document assembly.

Key can only be set once (if you try another key, it will be ignored).

The best place to call this method is from static constructor of your application's main class.

Valid serial key has multiple groups of alphanumeric characters, separated with dashes.

To use the assembly in free limited mode use FREE-LIMITED-KEY as serialKey.

For more information about GemBox.Document evaluation and licensing, see evaluation and licensing.

Events

FreeLimitReached

Occurs in loading or saving DocumentModel when GemBox.Document assembly is used with FREE-LIMITED-KEY license key and free limit is reached.

• C#
• VB.NET

public static event EventHandler<FreeLimitEventArgs> FreeLimitReached

Public Shared Event FreeLimitReached As EventHandler(Of FreeLimitEventArgs)

Event Type

System.EventHandler<FreeLimitEventArgs>

Remarks

This event is raised when GemBox.Document assembly is used with FREE-LIMITED-KEY license key and maximum number of paragraphs per document is reached (20 paragraphs).

Free mode will read / write first 20 paragraphs normally and, if document has more than 20 paragraph, it will throw FreeLimitReachedException.

You can use this event to continue using the assembly in a trial mode for performance testing (set FreeLimitReachedAction to ContinueAsTrial) or to stop further reading/writing (set FreeLimitReachedAction to Stop).

Trial mode will:

• read all document content but will insert word "TRIAL" on random places in the document.
• write all document content but will insert custom promotional header to all pages that come after 20th paragraph.

For more information about GemBox.Document evaluation and licensing, see evaluation and licensing.