Ignite UI for Angular

All
  • Public
  • Public/Protected
  • All

Class DisplayValueCollection

A collection of display text values.

See

Hierarchy

Hierarchy

  • Base
    • DisplayValueCollection

Implements

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

$type

$type: Type

Static $t

$t: Type

Static nextHashCode

nextHashCode: number

Accessors

count

  • get count(): number

  • Gets the number of display text values in the collection.

    Returns number

Methods

[iterator]

add

  • Adds a display text value to the collection.

    Throws

    ArgumentNullException 'item' is null or empty.

    Throws

    ArgumentException 'item' matches another value in the collection. Values are compared case-insensitively.

    Parameters

    • item: string

      The display text value to add to the collection.

    Returns void

clear

  • Clears the collection.

    Throws

    InvalidOperationException The collection is owned by a FixedValuesFilter which only allowed the values in the collection. Clearing the collection would prevent the filter from including any values, which is not allowed for a FixedValuesFilter.

    Returns void

contains

  • Determines whether the specified value is in the collection.

    Display text values are compared case-insensitively.

    Returns

    Parameters

    • item: string

      The display text value to find in the collection.

    Returns boolean

equals

  • Parameters

    • other: any

    Returns boolean

getHashCode

  • Returns number

indexOf

  • Gets the index of the specified display text value in the collection.

    Returns

    The 0-based index of the specified display text value in the collection or -1 if the item is not in the collection.

    Parameters

    • item: string

      The display text value to find in the collection.

    Returns number

insert

  • Inserts a display text value into the collection.

    Throws

    ArgumentNullException 'item' is null or empty.

    Throws

    ArgumentException 'item' matches another value in the collection. Values are compared case-insensitively.

    Throws

    ArgumentOutOfRangeException 'index' is less than 0 or greater than count.

    Parameters

    • index: number

      The 0-based index where the value should be inserted.

    • item: string

      The display text value to insert into the collection.

    Returns void

item

  • Gets or sets the display text value at the specified index.

    Throws

    ArgumentOutOfRangeException 'index' is less than 0 or greater than or equal to count.

    Throws

    ArgumentNullException The value assigned is null.

    Throws

    ArgumentException The value assigned matches another value in the collection. Values are compared case-insensitively.

    Parameters

    • a: number
    • Optional b: string

    Returns string

memberwiseClone

remove

  • Removes a display text value from the collection.

    Display text values are compared case-insensitively.

    Returns

    True if the value was found and removed; False otherwise.

    Parameters

    • item: string

      The display text value to remove from the collection.

    Returns boolean

removeAt

  • Removes the display text value at the specified index.

    Throws

    ArgumentOutOfRangeException 'index' is less than 0 or greater than or equal to count.

    Throws

    InvalidOperationException This operation removes the last item in the collection and it is owned by a FixedValuesFilter which only allowed the values in the collection. Clearing the collection would prevent the filter from including any values, which is not allowed for a FixedValuesFilter.

    Parameters

    • index: number

      The 0-based index of the value to remove.

    Returns void

Static compare

  • Parameters

    • item1: any
    • item2: any

    Returns number

Static compareSimple

  • Parameters

    • item1: any
    • item2: any

    Returns number

Static equalsSimple

  • Parameters

    • item1: any
    • item2: any

    Returns boolean

Static equalsStatic

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static getArrayOfProperties

  • Parameters

    • obj: any

    Returns any[]

Static getArrayOfValues

  • Parameters

    • obj: any

    Returns any[]

Static getHashCodeStatic

  • Parameters

    • obj: any

    Returns number

Static referenceEquals

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static staticInit

  • Returns void