Class LicensedFunction

Instances of this class define parts of a license that can be enabled or disabled by administrators. The licensed function consists of an identifier, a name, and a description. The Spotfire.Dxp.Framework.License.LicensedFunction.Id of the function is required be unique within the Spotfire.Dxp.Framework.License.License to which it is being added. The Spotfire.Dxp.Framework.License.LicensedFunction.Name and Spotfire.Dxp.Framework.License.LicensedFunction.Description together constitute a user-friendly representation of the feature. Therefore, it is recommended that these strings are localized.

Licensed functions are typically created as static members of a concrete Spotfire.Dxp.Framework.License.License implementation.

Since

2.0

Hierarchy (view full)

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

Description Id Name

Methods

Cast

  • Cast<T1, T2>(this, type): T1

  • Casts this object to the specified type. Throws error on failure.

    Type Parameters

    • T1

      The target type of the cast.

    • T2

      The type of the object to cast.

    Parameters

    Returns T1

Equals

  • Equals(obj): boolean

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

    Parameters

    • obj: any

      The object to compare with the current object.

    Returns boolean

    true if the specified object is equal to the current object; otherwise, false.

GetHashCode

  • GetHashCode(): number

  • Serves as the default hash function.

    Returns number

    A hash code for the current object.

ToString

  • ToString(): string

  • Returns a string that represents the current object.

    Returns string

    A string that represents the current object.

TryCast

  • TryCast<T1, T2>(this, type): null | T1

  • Casts this object to the specified type. Returns null on failure.

    Type Parameters

    • T1

      The target type of the cast.

    • T2

      The type of the object to cast.

    Parameters

    Returns null | T1

StaticEquals

  • Equals(objA, objB): boolean

  • Determines whether the specified object instances are considered equal.

    Parameters

    • objA: any

      The first object to compare.

    • objB: any

      The second object to compare.

    Returns boolean

    true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

Default capability

Description

  • get Description(): string

  • Gets the localized description.

    Returns string

    Since

    2.0

Id

  • get Id(): string

  • Gets the id of this license function. This id is unique within the license.

    Returns string

    Since

    2.0

Name

  • get Name(): string

  • Gets the localized name of the license.

    Returns string

    Since

    2.0

Settings

Member Visibility

On This Page

Methods
Default capability