ig.excel.WorksheetHyperlinkCollection

A collection of WorksheetHyperlink instances in a Worksheet.

Dependencies

jquery-1.4.4.js
infragistics.util.js
The current widget has no options.
The current widget has no events.

  • add

    .add( hyperlink:ig.excel.WorksheetHyperlink );

    Adds the specified hyperlink to the collection.

    • hyperlink
    • Type:ig.excel.WorksheetHyperlink
    • The hyperlink to add to the collection.

    Exceptions

    Exception Description
    ig.ArgumentNullException Occurs when the hyperlink is null.
    ig.ArgumentException Occurs when the hyperlink already belongs to a Worksheet.hyperlinks collection.
    ig.ArgumentException Occurs when the hyperlink has a source cell or region from a different worksheet than the owner of the collection.
    ig.ArgumentException Occurs when the hyperlink was created with a string address which cannot be parsed in the cell reference mode of the owning workbook.

  • clear

    .clear( );

    Clears all hyperlinks from the collection.

  • contains

    .contains( hyperlink:ig.excel.WorksheetHyperlink );
    Return Type:
    boolean
    Return Type Description:
    True if the hyperlink is found; False otherwise.

    Determines whether a hyperlink is in the collection.

    • hyperlink
    • Type:ig.excel.WorksheetHyperlink
    • The hyperlink to locate in the collection.

  • count

    .count( );

    Gets the number of hyperlinks on the Worksheet.

  • getEnumerator

    .getEnumerator( );

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

  • insert

    .insert( index:number, hyperlink:ig.excel.WorksheetHyperlink );

    Inserts the specified hyperlink in the collection.

    • index
    • Type:number
    • The 0-based index in the collection where the hyperlink should be inserted.
    • hyperlink
    • Type:ig.excel.WorksheetHyperlink
    • The hyperlink to insert in the collection.

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException index is less than zero or index is greater than WorksheetHyperlinkCollection.count.
    ig.ArgumentNullException Occurs when the hyperlink is null.
    ig.ArgumentException Occurs when the hyperlink already belongs to a Worksheet.hyperlinks collection.
    ig.ArgumentException Occurs when the hyperlink has a source cell or region from a different worksheet than the owner of the collection.
    ig.ArgumentException Occurs when the hyperlink was created with a string address which cannot be parsed in the cell reference mode of the owning workbook.

  • item

    .item( index:number );
    Return Type:
    ig.excel.WorksheetHyperlink
    Return Type Description:
    The hyperlink at the specified index.

    Gets the hyperlink at the specified index in the collection.

    • index
    • Type:number
    • The zero-based index of the hyperlink to get.

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException index is less than zero or index is greater than or equal to WorksheetHyperlinkCollection.count.

  • remove

    .remove( hyperlink:ig.excel.WorksheetHyperlink );
    Return Type:
    boolean
    Return Type Description:
    True if the hyperlink was successfully removed from the collection; False if the hyperlink did not exist in the collection.

    Removes the specified hyperlink from the collection.

    • hyperlink
    • Type:ig.excel.WorksheetHyperlink
    • The hyperlink to remove from the collection.

  • removeAt

    .removeAt( index:number );

    Removes the hyperlink at the specified index from the collection.

    • index
    • Type:number
    • The index of the hyperlink to remove from the collection.

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException index is less than zero or index is greater than or equal to WorksheetHyperlinkCollection.count.

Copyright © 1996 - 2024 Infragistics, Inc. All rights reserved.