ig.excel.NamedReferenceBase

Abstract base class for a named reference defined in the workbook.

Dependencies

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

  • comment

    .comment( );
    Return Type:
    string
    Return Type Description:
    The comment associated with the named reference or table.

    Gets the comment associated with the named reference or table.

    Exceptions

    Exception Description
    ig.ArgumentException The value assigned is greater than 255 characters in length.

  • comment

    .comment( value:string );
    Return Type:
    string
    Return Type Description:
    The comment associated with the named reference or table.

    Sets the comment associated with the named reference or table.

    • value
    • Type:string

    Exceptions

    Exception Description
    ig.ArgumentException The value assigned is greater than 255 characters in length.

  • name

    .name( );
    Return Type:
    string
    Return Type Description:
    The name of the reference.

    Gets the name of the reference.

    Exceptions

    Exception Description
    ig.ArgumentNullException The value assigned is null or empty.
    ig.ArgumentException The value assigned is longer than 255 characters.
    ig.ArgumentException The value assigned is not a valid named reference. The name must begin with a letter, underscore (_), or a backslash (\). All other characters in the name must be letters, numbers, periods, underscores (_), or backslashes (\). The name cannot be a an A1 cell reference (1 to 3 letters followed by 1 to 6 numbers). In addition, the name cannot be 'r', 'R', 'c', or 'C' or start with a row or column reference in R1C1 cell reference mode ('R' followed by 1 to 6 numbers or 'C' followed by 1 to 6 numbers).
    ig.InvalidOperationException The value assigned is the name of another named reference with the same Scope. Names are compared case-insensitively.

    Remarks

    See the overview on NamedReferenceBase.scope for details on how to access a named reference by name in formulas.

  • name

    .name( value:string );
    Return Type:
    string
    Return Type Description:
    The name of the reference.

    Sets the name of the reference.

    • value
    • Type:string

    Exceptions

    Exception Description
    ig.ArgumentNullException The value assigned is null or empty.
    ig.ArgumentException The value assigned is longer than 255 characters.
    ig.ArgumentException The value assigned is not a valid named reference. The name must begin with a letter, underscore (_), or a backslash (\). All other characters in the name must be letters, numbers, periods, underscores (_), or backslashes (\). The name cannot be a an A1 cell reference (1 to 3 letters followed by 1 to 6 numbers). In addition, the name cannot be 'r', 'R', 'c', or 'C' or start with a row or column reference in R1C1 cell reference mode ('R' followed by 1 to 6 numbers or 'C' followed by 1 to 6 numbers).
    ig.InvalidOperationException The value assigned is the name of another named reference with the same Scope. Names are compared case-insensitively.

    Remarks

    See the overview on NamedReferenceBase.scope for details on how to access a named reference by name in formulas.

  • scope

    .scope( );
    Return Type:
    object
    Return Type Description:
    The scope of the named reference.

    Gets the scope of the named reference.

    Remarks

    This can either be the workbook which the named reference belongs to or one of the worksheets in the workbook.

    The scope determines how formulas need to preface a name in order to use the named reference.

    If the scope is the workbook, formulas in any cell in the workbook can reference the named reference by specifying just the name or the workbook's file name, an exclamation point, and the name: =MyWorkbookName ='C:\MyWorkbook.xls'!MyWorkbookName When cells in other workbook's want to reference the named reference, they must use the second format by first specifying the file name when the workbook-scoped named reference exists.

    If the scope is a worksheet, formulas in cells of the worksheet can reference the named reference by specifying just the name. In addition, they can fully qualify the named reference with the worksheet name and, optionally, the workbook file name: =MyWorksheetName =Sheet1!MyWorksheetName ='C:\[MyWorkbook.xls]Sheet1'!MyWorksheetName Formulas in cells of other worksheets in the same workbook can use the named reference as well, but they must specify the worksheet name and, optionally, the workbook file name: =Sheet2!OtherWorksheetName ='C:\[MyWorkbook.xls]Sheet2'!OtherWorksheetName Formulas in cells of other workbooks can also used the named reference, but they must specify the workbook file name, worksheet name, and named reference name.

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