Class WorksheetHyperlinkCollection

A collection of WorksheetHyperlink instances in a Worksheet.

See

Worksheet.hyperlinks

Hierarchy

Hierarchy

  • Base
    • WorksheetHyperlinkCollection

Implements

Constructors

Properties

$type: Type
$t: Type
nextHashCode: number

Accessors

  • get count(): number
  • Gets the number of hyperlinks on the Worksheet.

    Returns number

Methods

  • 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

  • Clears all hyperlinks from the collection.

    Returns void

  • Determines whether a hyperlink is in the collection.

    Returns

    True if the hyperlink is found; False otherwise.

    Parameters

    Returns boolean

  • Parameters

    • other: any

    Returns boolean

  • Returns number

  • 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

  • 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

  • Removes the specified hyperlink from the collection.

    Returns

    True if the hyperlink was successfully removed from the collection; False if the hyperlink did not exist in the collection.

    Parameters

    Returns boolean

  • 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

  • Parameters

    • item1: any
    • item2: any

    Returns number

  • Parameters

    • item1: any
    • item2: any

    Returns number

  • Parameters

    • item1: any
    • item2: any

    Returns boolean

  • Parameters

    • a: any
    • b: any

    Returns boolean

  • Parameters

    • obj: any

    Returns any[]

  • Parameters

    • obj: any

    Returns any[]

  • Parameters

    • obj: any

    Returns number

  • Parameters

    • a: any
    • b: any

    Returns boolean

  • Returns void