ig.excel.WorksheetHyperlink

Represents a hyperlink for a cell or region.

Dependencies

jquery-1.4.4.js
infragistics.util.js
infragistics.ext_core.js
infragistics.ext_collections.js
infragistics.ext_collectionsExtended.js
infragistics.ext_io.js
infragistics.ext_text.js
infragistics.documents.core_core.js
infragistics.ext_ui.js
The current widget has no options.
The current widget has no events.
  • ig.excel.WorksheetHyperlink
    Constructor

    new $.ig.excel.WorksheetHyperlink( sourceAddress:string, target:object, [displayText:string], [toolTip:string] );

    Creates a new WorksheetHyperlink instance.

    • sourceAddress
    • Type:string
    • The address of the cell or region on which the hyperlink should reside.
    • target
    • Type:object
    • The target of the hyperlink, which can be a string, WorksheetCell, WorksheetRegion, or NamedReference instance. For bookmarks in an external document, separate the sub-address with a #, such as "File.xlsx#Sheet1!C3". For email addresses, use a target string with the format "mailto:joe@company.com" or "mailto:joe@company.com?subject=Email%20Subject".
    • displayText
    • Type:string
    • Optional
    • The text to display in the cell when the hyperlink is added to a worksheet, or null to use the target text.
    • toolTip
    • Type:string
    • Optional
    • The text to use in a tool tip when hovering over the source cell or region, or null to use the default tool tip.

    Exceptions

    Exception Description
    ig.ArgumentNullException Occurs when sourceAddress is null.
    ig.ArgumentException Occurs when target is not a string, WorksheetCell, WorksheetRegion, or NamedReference instance.
    ig.ArgumentException Occurs when target is a string longer than 256 characters.
  • ig.excel.WorksheetHyperlink
    Constructor

    new $.ig.excel.WorksheetHyperlink( sourceCell:ig.excel.WorksheetCell, target:object, [displayText:string], [toolTip:string] );

    Creates a new WorksheetHyperlink instance.

    • sourceCell
    • Type:ig.excel.WorksheetCell
    • The cell on which the hyperlink should reside.
    • target
    • Type:object
    • The target of the hyperlink, which can be a string, WorksheetCell, WorksheetRegion, or NamedReference instance. For bookmarks in an external document, separate the sub-address with a #, such as "File.xlsx#Sheet1!C3". For email addresses, use a target string with the format "mailto:joe@company.com" or "mailto:joe@company.com?subject=Email%20Subject".
    • displayText
    • Type:string
    • Optional
    • The text to display in the cell when the hyperlink is added to a worksheet, or null to use the target text.
    • toolTip
    • Type:string
    • Optional
    • The text to use in a tool tip when hovering over the source cell or region, or null to use the default tool tip.

    Exceptions

    Exception Description
    ig.ArgumentNullException Occurs when sourceCell is null.
    ig.ArgumentException Occurs when target is not a string, WorksheetCell, WorksheetRegion, or NamedReference instance.
    ig.ArgumentException Occurs when target is a string longer than 256 characters.
    ig.ArgumentException Occurs when target is a cell, region, or named reference which is not from the same workbook as sourceCell.
  • ig.excel.WorksheetHyperlink
    Constructor

    new $.ig.excel.WorksheetHyperlink( sourceRegion:ig.excel.WorksheetRegion, target:object, [displayText:string], [toolTip:string] );

    Creates a new WorksheetHyperlink instance.

    • sourceRegion
    • Type:ig.excel.WorksheetRegion
    • The region on which the hyperlink should reside.
    • target
    • Type:object
    • The target of the hyperlink, which can be a string, WorksheetCell, WorksheetRegion, or NamedReference instance. For bookmarks in an external document, separate the sub-address with a #, such as "File.xlsx#Sheet1!C3". For email addresses, use a target string with the format "mailto:joe@company.com" or "mailto:joe@company.com?subject=Email%20Subject".
    • displayText
    • Type:string
    • Optional
    • The text to display in the cell when the hyperlink is added to a worksheet, or null to use the target text.
    • toolTip
    • Type:string
    • Optional
    • The text to use in a tool tip when hovering over the source cell or region, or null to use the default tool tip.

    Exceptions

    Exception Description
    ig.ArgumentNullException Occurs when sourceRegion is null.
    ig.ArgumentException Occurs when target is not a string, WorksheetCell, WorksheetRegion, or NamedReference instance.
    ig.ArgumentException Occurs when target is a string longer than 256 characters.
    ig.ArgumentException Occurs when target is a cell, region, or named reference which is not from the same workbook as sourceRegion.
  • displayText

    .displayText( );

    Gets the text to display in the cell when the hyperlink is added to a worksheet, or null to use the target text.

    Exceptions

    Exception Description
    ig.InvalidOperationException Occurs when WorksheetHyperlink.isSealed is True.
    ig.ArgumentException Occurs when the specified value is longer than 2084 characters.

    Remarks

    Note: the display text will only get applied if the target cell has no value or a string value.

  • displayText

    .displayText( value:string );

    Sets the text to display in the cell when the hyperlink is added to a worksheet, or null to use the target text.

    • value
    • Type:string

    Exceptions

    Exception Description
    ig.InvalidOperationException Occurs when WorksheetHyperlink.isSealed is True.
    ig.ArgumentException Occurs when the specified value is longer than 2084 characters.

    Remarks

    Note: the display text will only get applied if the target cell has no value or a string value.

  • isSealed

    .isSealed( );

    Gets the value indicating whether the hyperlink is sealed and cannot be modified.

  • sourceAddress

    .sourceAddress( );

    Gets the address of the cell or region on which the hyperlink resides.

    Exceptions

    Exception Description
    ig.InvalidOperationException Occurs when WorksheetHyperlink.isSealed is True.
    ig.ArgumentNullException Occurs when the value assigned is null.
    ig.ArgumentException Occurs when the value assigned cannot be parsed as a cell or region address in the owning workbook's current cell reference mode.
  • sourceAddress

    .sourceAddress( value:string );

    Sets the address of the cell or region on which the hyperlink resides.

    • value
    • Type:string

    Exceptions

    Exception Description
    ig.InvalidOperationException Occurs when WorksheetHyperlink.isSealed is True.
    ig.ArgumentNullException Occurs when the value assigned is null.
    ig.ArgumentException Occurs when the value assigned cannot be parsed as a cell or region address in the owning workbook's current cell reference mode.
  • sourceCell

    .sourceCell( );
    Return Type:
    ig.excel.WorksheetCell
    Return Type Description:
    Returns a WorksheetCell.

    Gets the cell on which the hyperlink resides.

    Exceptions

    Exception Description
    ig.InvalidOperationException Occurs when WorksheetHyperlink.isSealed is True.
    ig.ArgumentNullException Occurs when the value assigned is null.
    ig.ArgumentException Occurs when the value assigned is not on the same worksheet as the hyperlink.
  • sourceCell

    .sourceCell( value:ig.excel.WorksheetCell );
    Return Type:
    ig.excel.WorksheetCell
    Return Type Description:
    Returns a WorksheetCell.

    Sets the cell on which the hyperlink resides.

    • value
    • Type:ig.excel.WorksheetCell

    Exceptions

    Exception Description
    ig.InvalidOperationException Occurs when WorksheetHyperlink.isSealed is True.
    ig.ArgumentNullException Occurs when the value assigned is null.
    ig.ArgumentException Occurs when the value assigned is not on the same worksheet as the hyperlink.
  • sourceRegion

    .sourceRegion( );
    Return Type:
    ig.excel.WorksheetRegion
    Return Type Description:
    Returns a WorksheetRegion.

    Gets the region on which the hyperlink resides.

    Exceptions

    Exception Description
    ig.InvalidOperationException Occurs when WorksheetHyperlink.isSealed is True.
    ig.ArgumentNullException Occurs when the value assigned is null.
    ig.ArgumentException Occurs when the value assigned is not on the same worksheet as the hyperlink.
  • sourceRegion

    .sourceRegion( value:ig.excel.WorksheetRegion );
    Return Type:
    ig.excel.WorksheetRegion
    Return Type Description:
    Returns a WorksheetRegion.

    Sets the region on which the hyperlink resides.

    • value
    • Type:ig.excel.WorksheetRegion

    Exceptions

    Exception Description
    ig.InvalidOperationException Occurs when WorksheetHyperlink.isSealed is True.
    ig.ArgumentNullException Occurs when the value assigned is null.
    ig.ArgumentException Occurs when the value assigned is not on the same worksheet as the hyperlink.
  • target

    .target( );

    Gets the target of the hyperlink, which can be a string, WorksheetCell, WorksheetRegion, or NamedReference instance. For bookmarks in an external document, separate the sub-address with a #, such as "File.xlsx#Sheet1!C3". For email addresses, use a target string with the format "mailto:joe@company.com" or "mailto:joe@company.com?subject=Email%20Subject".

    Exceptions

    Exception Description
    ig.InvalidOperationException Occurs when WorksheetHyperlink.isSealed is True.
    ig.ArgumentException Occurs when the value assigned is not a string, WorksheetCell, WorksheetRegion, or NamedReference instance.
    ig.ArgumentException Occurs when the specified value is a string longer than 256 characters.
    ig.ArgumentException Occurs when the value assigned is a cell or region which is not from the same workbook as the owning workbook of the hyperlink.
  • target

    .target( value:object );

    Sets the target of the hyperlink, which can be a string, WorksheetCell, WorksheetRegion, or NamedReference instance. For bookmarks in an external document, separate the sub-address with a #, such as "File.xlsx#Sheet1!C3". For email addresses, use a target string with the format "mailto:joe@company.com" or "mailto:joe@company.com?subject=Email%20Subject".

    • value
    • Type:object

    Exceptions

    Exception Description
    ig.InvalidOperationException Occurs when WorksheetHyperlink.isSealed is True.
    ig.ArgumentException Occurs when the value assigned is not a string, WorksheetCell, WorksheetRegion, or NamedReference instance.
    ig.ArgumentException Occurs when the specified value is a string longer than 256 characters.
    ig.ArgumentException Occurs when the value assigned is a cell or region which is not from the same workbook as the owning workbook of the hyperlink.
  • targetAddress

    .targetAddress( );

    Gets the target address of the hyperlink. For bookmarks in an external document, separate the sub-address with a #, such as "File.xlsx#Sheet1!C3". For email addresses, use a target string with the format "mailto:joe@company.com" or "mailto:joe@company.com?subject=Email%20Subject".

    Exceptions

    Exception Description
    ig.InvalidOperationException Occurs when WorksheetHyperlink.isSealed is True.
    ig.ArgumentException Occurs when the specified value is longer than 256 characters.
  • targetAddress

    .targetAddress( value:string );

    Sets the target address of the hyperlink. For bookmarks in an external document, separate the sub-address with a #, such as "File.xlsx#Sheet1!C3". For email addresses, use a target string with the format "mailto:joe@company.com" or "mailto:joe@company.com?subject=Email%20Subject".

    • value
    • Type:string

    Exceptions

    Exception Description
    ig.InvalidOperationException Occurs when WorksheetHyperlink.isSealed is True.
    ig.ArgumentException Occurs when the specified value is longer than 256 characters.
  • targetCell

    .targetCell( );
    Return Type:
    ig.excel.WorksheetCell
    Return Type Description:
    Returns a WorksheetCell.

    Gets the target cell of the hyperlink.

    Exceptions

    Exception Description
    ig.InvalidOperationException Occurs when WorksheetHyperlink.isSealed is True.
    ig.ArgumentException Occurs when the value assigned is a cell which is not from the same workbook as the owning workbook of the hyperlink.
  • targetCell

    .targetCell( value:ig.excel.WorksheetCell );
    Return Type:
    ig.excel.WorksheetCell
    Return Type Description:
    Returns a WorksheetCell.

    Sets the target cell of the hyperlink.

    • value
    • Type:ig.excel.WorksheetCell

    Exceptions

    Exception Description
    ig.InvalidOperationException Occurs when WorksheetHyperlink.isSealed is True.
    ig.ArgumentException Occurs when the value assigned is a cell which is not from the same workbook as the owning workbook of the hyperlink.
  • targetNamedReference

    .targetNamedReference( );
    Return Type:
    ig.excel.NamedReference
    Return Type Description:
    Returns a NamedReference.

    Gets the target named reference of the hyperlink.

    Exceptions

    Exception Description
    ig.InvalidOperationException Occurs when WorksheetHyperlink.isSealed is True.
    ig.ArgumentException Occurs when the value assigned is a named reference which is not from the same workbook as the owning workbook of the hyperlink.
  • targetNamedReference

    .targetNamedReference( value:ig.excel.NamedReference );
    Return Type:
    ig.excel.NamedReference
    Return Type Description:
    Returns a NamedReference.

    Sets the target named reference of the hyperlink.

    • value
    • Type:ig.excel.NamedReference

    Exceptions

    Exception Description
    ig.InvalidOperationException Occurs when WorksheetHyperlink.isSealed is True.
    ig.ArgumentException Occurs when the value assigned is a named reference which is not from the same workbook as the owning workbook of the hyperlink.
  • targetRegion

    .targetRegion( );
    Return Type:
    ig.excel.WorksheetRegion
    Return Type Description:
    Returns a WorksheetRegion.

    Gets the target region of the hyperlink.

    Exceptions

    Exception Description
    ig.InvalidOperationException Occurs when WorksheetHyperlink.isSealed is True.
    ig.ArgumentException Occurs when the value assigned is a region which is not from the same workbook as the owning workbook of the hyperlink.
  • targetRegion

    .targetRegion( value:ig.excel.WorksheetRegion );
    Return Type:
    ig.excel.WorksheetRegion
    Return Type Description:
    Returns a WorksheetRegion.

    Sets the target region of the hyperlink.

    • value
    • Type:ig.excel.WorksheetRegion

    Exceptions

    Exception Description
    ig.InvalidOperationException Occurs when WorksheetHyperlink.isSealed is True.
    ig.ArgumentException Occurs when the value assigned is a region which is not from the same workbook as the owning workbook of the hyperlink.
  • toolTip

    .toolTip( );

    Gets the text to use in a tool tip when hovering over the source cell or region, or null to use the default tool tip.

    Exceptions

    Exception Description
    ig.InvalidOperationException Occurs when WorksheetHyperlink.isSealed is True.
    ig.ArgumentException Occurs when the specified value is longer than 256 characters.
  • toolTip

    .toolTip( value:string );

    Sets the text to use in a tool tip when hovering over the source cell or region, or null to use the default tool tip.

    • value
    • Type:string

    Exceptions

    Exception Description
    ig.InvalidOperationException Occurs when WorksheetHyperlink.isSealed is True.
    ig.ArgumentException Occurs when the specified value is longer than 256 characters.
  • toString

    .toString( );
    Return Type:
    string
    Return Type Description:
    The string representation of the hyperlink.

    Gets the string representation of the hyperlink.

  • worksheet

    .worksheet( );
    Return Type:
    ig.excel.Worksheet
    Return Type Description:
    Returns a Worksheet.

    Gets the worksheet to which the hyperlink belongs.

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