ig.excel.NamedReferenceCollection

A collection of NamedReference instances in a workbook.

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.
  • add

    .add( name:string, formula:string );
    Return Type:
    ig.excel.NamedReference
    Return Type Description:
    The named reference which was added to the collection.

    Adds a named reference with a scope of the collection's associated NamedReferenceCollection.workbook to the collection.

    • name
    • Type:string
    • The name to give the named reference.
    • formula
    • Type:string
    • The formula to give the named reference.

    Exceptions

    Exception Description
    ig.ArgumentNullException name is null or empty.
    ig.ArgumentNullException formula is null or empty.
    ig.ArgumentException name is longer than 255 characters.
    ig.ArgumentException name is invalid. 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.ArgumentException formula is not a valid formula. The inner exception will contain the FormulaParseException describing the reason the formula was not valid.
    ig.InvalidOperationException name is used by another named reference which also has a scope of the workbook. Named reference names are compared case-insensitively.

    Remarks

    The CellReferenceMode of the owning NamedReferenceCollection.workbook will be used to parse the formula.

  • add

    .add( name:string, formula:string, cellReferenceMode:ig.excel.CellReferenceMode );
    Return Type:
    ig.excel.NamedReference
    Return Type Description:
    The named reference which was added to the collection.

    Adds a named reference with a scope of the collection's associated NamedReferenceCollection.workbook to the collection.

    • name
    • Type:string
    • The name to give the named reference.
    • formula
    • Type:string
    • The formula to give the named reference.
    • cellReferenceMode
    • Type:ig.excel.CellReferenceMode
    • The mode used to interpret cell references in the formula.

    Exceptions

    Exception Description
    ig.ArgumentNullException name is null or empty.
    ig.ArgumentNullException formula is null or empty.
    ig.ArgumentException name is longer than 255 characters.
    ig.ArgumentException name is invalid. 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.ArgumentException formula is not a valid formula. The inner exception will contain the FormulaParseException describing the reason the formula was not valid.
    ig.InvalidOperationException name is used by another named reference which also has a scope of the workbook. Named reference names are compared case-insensitively.
    ig.excel.InvalidEnumArgumentException cellReferenceMode is not defined in the CellReferenceMode enumeration.
  • add

    .add( name:string, formula:string, cellReferenceMode:ig.excel.CellReferenceMode, worksheet:ig.excel.Worksheet );
    Return Type:
    ig.excel.NamedReference
    Return Type Description:
    The named reference which was added to the collection.

    Adds a named reference with a scope of a worksheet to the collection.

    • name
    • Type:string
    • The name to give the named reference.
    • formula
    • Type:string
    • The formula to give the named reference.
    • cellReferenceMode
    • Type:ig.excel.CellReferenceMode
    • The mode used to interpret cell references in the formula.
    • worksheet
    • Type:ig.excel.Worksheet
    • The scope of the named reference.

    Exceptions

    Exception Description
    ig.ArgumentNullException name is null or empty.
    ig.ArgumentNullException formula is null or empty.
    ig.ArgumentNullException worksheet is null.
    ig.ArgumentException name is longer than 255 characters.
    ig.ArgumentException name is invalid. 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.ArgumentException formula is not a valid formula. The inner exception will contain the FormulaParseException describing the reason the formula was not valid.
    ig.ArgumentException worksheet does not belong to the workbook owning this collection.
    ig.InvalidOperationException name is used by another named reference which also has a scope of the specified worksheet. Named reference names are compared case-insensitively.
    ig.excel.InvalidEnumArgumentException cellReferenceMode is not defined in the CellReferenceMode enumeration.
  • add

    .add( name:string, formula:string, worksheet:ig.excel.Worksheet );
    Return Type:
    ig.excel.NamedReference
    Return Type Description:
    The named reference which was added to the collection.

    Adds a named reference with a scope of a worksheet to the collection.

    • name
    • Type:string
    • The name to give the named reference.
    • formula
    • Type:string
    • The formula to give the named reference.
    • worksheet
    • Type:ig.excel.Worksheet
    • The scope of the named reference.

    Exceptions

    Exception Description
    ig.ArgumentNullException name is null or empty.
    ig.ArgumentNullException formula is null or empty.
    ig.ArgumentNullException worksheet is null.
    ig.ArgumentException name is longer than 255 characters.
    ig.ArgumentException name is invalid. 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.ArgumentException formula is not a valid formula. The inner exception will contain the FormulaParseException describing the reason the formula was not valid.
    ig.ArgumentException worksheet does not belong to the workbook owning this collection.
    ig.InvalidOperationException name is used by another named reference which also has a scope of the specified worksheet. Named reference names are compared case-insensitively.

    Remarks

    The CellReferenceMode of the owning NamedReferenceCollection.workbook will be used to parse the formula.

  • clear

    .clear( );

    Clears all named references from the collection.

  • contains

    .contains( namedReference:ig.excel.NamedReference );
    Return Type:
    boolean
    Return Type Description:
    True if the named reference is found; False otherwise.

    Determines whether a named reference is in the collection.

    • namedReference
    • Type:ig.excel.NamedReference
    • The named reference to locate in the collection.
  • count

    .count( );
    Return Type:
    number
    Return Type Description:
    The number of named references in the collection.

    Gets the number of named references in the collection.

  • find

    .find( name:string );
    Return Type:
    ig.excel.NamedReference
    Return Type Description:
    The named reference with the specified name or null if the named reference was not found.

    Finds a named reference in the collection with a scope of the collection's associated Workbook.

    • name
    • Type:string
    • The name of the named reference to find.

    Exceptions

    Exception Description
    ig.ArgumentNullException name is null or empty.

    Remarks

    Named reference names are compared case-insensitively.

  • find

    .find( name:string, worksheetScope:ig.excel.Worksheet );
    Return Type:
    ig.excel.NamedReference
    Return Type Description:
    The named reference with the specified name or null if the named reference was not found.

    Finds a named reference in the collection with a scope of the specified worksheet.

    • name
    • Type:string
    • The name of the named reference to find.
    • worksheetScope
    • Type:ig.excel.Worksheet
    • The worksheet that the named reference found must have a scope of.

    Exceptions

    Exception Description
    ig.ArgumentNullException name is null or empty.
    ig.ArgumentNullException worksheetScope is null.

    Remarks

    Named reference names are compared case-insensitively.

  • findAll

    .findAll( name:string );
    Return Type:
    ig.excel.NamedReference[]
    Return Type Description:
    An array of NamedReference instances with the specified name.

    Finds all named references in the collection with the specified name.

    • name
    • Type:string
    • The name of the named references to find.

    Exceptions

    Exception Description
    ig.ArgumentNullException name is null or empty.

    Remarks

    Named reference names are compared case-insensitively.

  • item

    .item( index:number );
    Return Type:
    ig.excel.NamedReference
    Return Type Description:
    The named reference at the specified index.

    Gets the named reference at the specified index.

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

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException index is less than zero or index is greater than or equal to NamedReferenceCollection.count.
  • remove

    .remove( namedReference:ig.excel.NamedReference );
    Return Type:
    boolean
    Return Type Description:
    True if the named reference existed in the collection and was removed; False otherwise.

    Removes the specified named reference from the collection.

    • namedReference
    • Type:ig.excel.NamedReference
    • The named reference to remove fro the collection.
  • removeAt

    .removeAt( index:number );

    Removes the named reference at the specified index in the collection.

    • index
    • Type:number
    • The zero-based index of the named reference in the collection.

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException index is less than zero or index is greater than or equal to NamedReferenceCollection.count.
  • workbook

    .workbook( );
    Return Type:
    ig.excel.Workbook
    Return Type Description:
    The workbook associated with this collection.

    Gets the workbook associated with this collection.

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