CustomTypeIdentifiers Class

Spotfire 14.2 API Reference
Base class for custom type identifier definitions.
Inheritance Hierarchy

SystemObject
  Spotfire.Dxp.Framework.DocumentModelTypeIdentifiers
    Spotfire.Dxp.Application.ExtensionCustomTypeIdentifiers

Namespace:  Spotfire.Dxp.Application.Extension
Assembly:  Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 64.0.19329.3263 (64.0.19329.3263)
Syntax

C#
public abstract class CustomTypeIdentifiers : TypeIdentifiers

The CustomTypeIdentifiers type exposes the following members.

Constructors

  NameDescription
Protected methodCustomTypeIdentifiers
Initializes a new instance of the CustomTypeIdentifiers class.
Top
Methods

  NameDescription
Protected methodStatic memberCreateTypeIdentifier
Creates a new custom type identifier. The identifier must have a unique name on the form "MyCompany.MyComponent". Furthermore, it should have a displayName that is a localized human readable name of the type. The description should describe what the type is for, and how to get it when it is missing.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Examples

The following example shows how to declare two custom type identifiers.
C#
public abstract class MyTypeIdentifiers : CustomTypeIdentifiers
{
    public static readonly CustomTypeIdentifier MyComponent = CreateTypeIdentifier(
      "MyCompany.MyComponent", "My Component",
      "The 'My Component' is a [description of MyComponent]. It is a part of the 'My Components' add-in that can be downloaded from http://www.mycomponents.com.");

    public static readonly CustomTypeIdentifier MyOtherComponent = CreateTypeIdentifier(
      "MyCompany.MyOtherComponent", "My Other Component",
      "The 'My Other Component' is a [description of MyOtherComponent]. It is a part of the 'My Components' add-in that can be downloaded from http://www.mycomponents.com.");
}
Version Information

Supported in: 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8, 11.7, 11.6, 11.5, 11.4
See Also

Reference