Static Public Member Functions
static bool	FreeOk ()
	Checks whether the current license has permission to use 'free' features. More...

static bool	ToolsOk ()
	Checks whether the current license has permission to use 'tools' features. More...

static bool	ProfessionalOk ()
	Checks whether the current license has permission to use 'conversion' features. More...

static bool	ProfessionalOcrOk ()
	Checks whether the current license has permission to use 'conversion' and OCR features. More...

static bool	DistributionOk ()
	Checks whether the current license has permission to be distributed. More...

static bool	Allows (SolidFramework.Plumbing.LicensePermissions permissions)
	Checks if the current license has the required SolidFramework.Plumbing.LicensePermissions. More...

static void	Import (string name, string email, string organization, string code)
	Imports license More...

static void	Import (string name, string email, string organization, string code, string applicationCode)
	Imports license More...

static void	Import (System.IO.StreamReader stream)
	Imports license from the specified stream More...

static void	Import (string xml)
	Imports license from the specified XML More...

static SolidFramework.Plumbing.LicenseState	Validate (string xml, ref string newXml)
	Validates license from the specified XML and uses web service to generate new license if appropriate More...

static string	WebValidate (string xml)
	Validates the license and uses the web service to generate a new license if required. More...

static string	WebValidate (string name, string email, string organization, string code)
	Validates the license and uses the web service to generate a new license if required. More...

static void	CloudImport (string xml)
	Loads a seed license from an XML file and uses the web service to import a license that will work in cloud environments More...

static void	CloudImport (string name, string email, string organization, string code)
	Uses the web service to import a license that will work in cloud environments More...

static void	CloudImport (string name, string email, string organization, string code, string applicationCode)
	Uses the web service to import a license that will work in cloud environments More...

static string	GetTemporaryLicense ()
	Gets a temporary machine specific copy of the current license. More...

static void	LoadTemporaryLicense (string license)
	Loads a temporary machine specific license that was created by GetTemporaryLicense. More...

static void	Clear ()
	Clears the current license and loads the default free license (if available)

static string	GetUniqueMachineID ()
	Gets the unique machine ID for this machine. More...

static bool	RequiresCloudImport ()
	Gets whether this machine needs to use CloudImport. More...

Properties
static SolidFramework.Plumbing.LicenseType	Type `[get]`

static SolidFramework.Plumbing.LicensePermissions	Permissions `[get]`

Member Function Documentation

◆ Allows()

static bool SolidFramework.License.Allows ( SolidFramework.Plumbing.LicensePermissions permissions )

static

Checks if the current license has the required SolidFramework.Plumbing.LicensePermissions.

Parameters

permissions The SolidFramework.Plumbing.LicensePermissions to check.

Returns: true if the current license has the required SolidFramework.Plumbing.LicensePermissions; otherwise, false.

◆ CloudImport() [1/3]

static void SolidFramework.License.CloudImport	(	string	name,
		string	email,
		string	organization,
		string	code
	)

static

Uses the web service to import a license that will work in cloud environments

Parameters

name	The name.
email	The email.
organization	The organization.
code	The code.

◆ CloudImport() [2/3]

static void SolidFramework.License.CloudImport	(	string	name,
		string	email,
		string	organization,
		string	code,
		string	applicationCode
	)

static

Uses the web service to import a license that will work in cloud environments

Parameters

name	The name.
email	The email.
organization	The organization.
code	The code.
applicationCode	The application code.

◆ CloudImport() [3/3]

static void SolidFramework.License.CloudImport ( string xml )

static

Loads a seed license from an XML file and uses the web service to import a license that will work in cloud environments

Parameters

xml	Either XML content or the path to an XML file.

◆ DistributionOk()

static bool SolidFramework.License.DistributionOk ( )

static

Checks whether the current license has permission to be distributed.

Returns: true if the current license is distributable; otherwise, false.

◆ FreeOk()

static bool SolidFramework.License.FreeOk ( )

static

Checks whether the current license has permission to use 'free' features.

Returns: true if the current license allows 'free' features; otherwise, false.

◆ GetTemporaryLicense()

static string SolidFramework.License.GetTemporaryLicense ( )

static

Gets a temporary machine specific copy of the current license.

Returns: A temporary machine specific copy of the current license.

◆ GetUniqueMachineID()

static string SolidFramework.License.GetUniqueMachineID ( )

static

Gets the unique machine ID for this machine.

Returns: The unique machine ID for this machine.

◆ Import() [1/4]

static void SolidFramework.License.Import	(	string	name,
		string	email,
		string	organization,
		string	code
	)

static

Imports license

Parameters

name	The name.
email	The email.
organization	The organization.
code	The code.

◆ Import() [2/4]

static void SolidFramework.License.Import	(	string	name,
		string	email,
		string	organization,
		string	code,
		string	applicationCode
	)

static

Imports license

Parameters

name	The name.
email	The email.
organization	The organization.
code	The code.
applicationCode	The application code.

◆ Import() [3/4]

static void SolidFramework.License.Import ( string xml )

static

Imports license from the specified XML

Parameters

xml	Either XML content or the path to an XML file.

◆ Import() [4/4]

static void SolidFramework.License.Import ( System.IO.StreamReader stream )

static

Imports license from the specified stream

Parameters

stream The stream containing the license XML

◆ LoadTemporaryLicense()

static void SolidFramework.License.LoadTemporaryLicense ( string license )

static

Loads a temporary machine specific license that was created by GetTemporaryLicense.

Parameters

license A temporary machine specific license created by GetTemporaryLicense.

◆ ProfessionalOcrOk()

static bool SolidFramework.License.ProfessionalOcrOk ( )

static

Checks whether the current license has permission to use 'conversion' and OCR features.

Returns: true if the current license allows 'conversion' and OCR features; otherwise, false.

◆ ProfessionalOk()

static bool SolidFramework.License.ProfessionalOk ( )

static

Checks whether the current license has permission to use 'conversion' features.

Returns: true if the current license allows 'conversion' features; otherwise, false.

◆ RequiresCloudImport()

static bool SolidFramework.License.RequiresCloudImport ( )

static

Gets whether this machine needs to use CloudImport.

Returns: Whether this machine needs to use CloudImport.

◆ ToolsOk()

static bool SolidFramework.License.ToolsOk ( )

static

Checks whether the current license has permission to use 'tools' features.

Returns: true if the current license allows 'tools' features; otherwise, false.

◆ Validate()

static SolidFramework.Plumbing.LicenseState SolidFramework.License.Validate	(	string	xml,
		ref string	newXml
	)

static

Validates license from the specified XML and uses web service to generate new license if appropriate

Parameters

xml	The XML.
newXml	The new XML.

◆ WebValidate() [1/2]

static string SolidFramework.License.WebValidate	(	string	name,
		string	email,
		string	organization,
		string	code
	)

static

Validates the license and uses the web service to generate a new license if required.

Returns: An empty string if the current license is valid, otherwise returns the XML for the updated license

◆ WebValidate() [2/2]

static string SolidFramework.License.WebValidate ( string xml )

static

Validates the license and uses the web service to generate a new license if required.

Returns: An empty string if the current license is valid, otherwise returns the XML for the updated license

Static Public Member Functions

Properties

Member Function Documentation

◆ Allows()

◆ CloudImport() [1/3]

◆ CloudImport() [2/3]

◆ CloudImport() [3/3]

◆ DistributionOk()

◆ FreeOk()

◆ GetTemporaryLicense()

◆ GetUniqueMachineID()

◆ Import() [1/4]

◆ Import() [2/4]

◆ Import() [3/4]

◆ Import() [4/4]

◆ LoadTemporaryLicense()

◆ ProfessionalOcrOk()

◆ ProfessionalOk()

◆ RequiresCloudImport()

◆ ToolsOk()

◆ Validate()

◆ WebValidate() [1/2]

◆ WebValidate() [2/2]