An instance of this class can be retrieved from a Spotfire.Dxp.Data.DataColumn using the Spotfire.Dxp.Data.DataColumn.As method when the column type of the Spotfire.Dxp.Data.DataColumn is Tags. This class is used for modifying the tags column.

2.0

Hierarchy (view full)

Methods

  • 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

  • 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.

  • Serves as the default hash function.

    Returns number

    A hash code for the current object.

  • Returns a string that represents the current object.

    Returns string

    A string that represents the current object.

  • 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

  • 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

  • get TagValues(): System.Collections.Generic.IList<string>
  • Gets or sets a readonly list of the current tag values defined. The order of the tag values defines the sort order of the tags column. If the empty string is not part of the collection of tag values it will be automatically be added to the end of the list. A string in the tag values collection cannot be longer than 150 characters.

    Returns System.Collections.Generic.IList<string>

    2.0

  • set TagValues(value): void
  • Parameters

    Returns void

  • Renames a tag value in the list of TagValues. The old tag value has to be part of the Spotfire.Dxp.Data.TagsColumn.TagValues list and may not be the empty string. The new tag values must not be part of the Spotfire.Dxp.Data.TagsColumn.TagValues list and may not be the empty string. The new tag value cannot be longer than 150 characters.

    Parameters

    • oldValue: string | String

      The old tag value.

    • newValue: string | String

      The new tag value.

    Returns void

    2.0