Ignite UI for Web Components

All
  • Public
  • Public/Protected
  • All

Class WorksheetHyperlinkCollection

A collection of [[WorksheetHyperlink]] instances in a [[Worksheet]].

See

[[Worksheet.hyperlinks]]

Hierarchy

Hierarchy

  • Base
    • WorksheetHyperlinkCollection

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 hyperlinks on the [[Worksheet]].

    Returns number

Methods

[iterator]

  • [iterator](): EnumeratorWrapper<WorksheetHyperlink>

  • Returns EnumeratorWrapper<WorksheetHyperlink>

add

  • add(hyperlink): void

  • Adds the specified hyperlink to the collection.

    Throws

    [[ArgumentNullException]] Occurs when the 'hyperlink' is null.

    Throws

    [[ArgumentException]] Occurs when the 'hyperlink' already belongs to a [[Worksheet.hyperlinks]] collection.

    Throws

    [[ArgumentException]] Occurs when the 'hyperlink' has a source cell or region from a different worksheet than the owner of the collection.

    Throws

    [[ArgumentException]] Occurs when the 'hyperlink' was created with a string address which cannot be parsed in the cell reference mode of the owning workbook.

    Parameters

    Returns void

clear

  • clear(): void

  • Clears all hyperlinks from the collection.

    Returns void

contains

  • contains(hyperlink): boolean

  • Determines whether a hyperlink is in the collection.

    Parameters

    Returns boolean

equals

  • equals(other): boolean

  • Parameters

    • other: any

    Returns boolean

getEnumerator

  • getEnumerator(): IEnumerator$1<WorksheetHyperlink>

  • Gets an enumerator which can iterator all hyperlinks in the collection.

    Returns IEnumerator$1<WorksheetHyperlink>

getHashCode

  • getHashCode(): number

  • Returns number

insert

  • insert(index, hyperlink): void

  • Inserts the specified hyperlink in the collection.

    Throws

    [[ArgumentOutOfRangeException]] 'index' is less than zero or 'index' is greater than [[count]].

    Throws

    [[ArgumentNullException]] Occurs when the 'hyperlink' is null.

    Throws

    [[ArgumentException]] Occurs when the 'hyperlink' already belongs to a [[Worksheet.hyperlinks]] collection.

    Throws

    [[ArgumentException]] Occurs when the 'hyperlink' has a source cell or region from a different worksheet than the owner of the collection.

    Throws

    [[ArgumentException]] Occurs when the 'hyperlink' was created with a string address which cannot be parsed in the cell reference mode of the owning workbook.

    Parameters

    • index: number

      The 0-based index in the collection where the hyperlink should be inserted.

    • hyperlink: WorksheetHyperlink

      The hyperlink to insert in the collection.

    Returns void

item

  • item(a): WorksheetHyperlink

  • Gets the hyperlink at the specified index in the collection. The hyperlink at the specified index.

    Throws

    [[ArgumentOutOfRangeException]] 'index' is less than zero or 'index' is greater than or equal to [[count]].

    Parameters

    • a: number

    Returns WorksheetHyperlink

memberwiseClone

  • memberwiseClone(): Base

  • Returns Base

remove

  • remove(hyperlink): boolean

  • Removes the specified hyperlink from the collection.

    Parameters

    Returns boolean

removeAt

  • removeAt(index): void

  • Removes the hyperlink at the specified index from the collection.

    Throws

    [[ArgumentOutOfRangeException]] 'index' is less than zero or 'index' is greater than or equal to [[count]].

    Parameters

    • index: number

      The index of the hyperlink to remove from the collection.

    Returns void

Static compare

  • compare(item1, item2): number

  • Parameters

    • item1: any
    • item2: any

    Returns number

Static compareSimple

  • compareSimple(item1, item2): number

  • Parameters

    • item1: any
    • item2: any

    Returns number

Static equalsSimple

  • equalsSimple(item1, item2): boolean

  • Parameters

    • item1: any
    • item2: any

    Returns boolean

Static equalsStatic

  • equalsStatic(a, b): boolean

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static getArrayOfProperties

  • getArrayOfProperties(obj): any[]

  • Parameters

    • obj: any

    Returns any[]

Static getArrayOfValues

  • getArrayOfValues(obj): any[]

  • Parameters

    • obj: any

    Returns any[]

Static getHashCodeStatic

  • getHashCodeStatic(obj): number

  • Parameters

    • obj: any

    Returns number

Static referenceEquals

  • referenceEquals(a, b): boolean

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static staticInit

  • staticInit(): void

  • Returns void