A collection of [[NamedReference]] instances in a workbook.

Constructors

Section titled "Constructors"

NamedReferenceCollection

new NamedReferenceCollection(a: Workbook): NamedReferenceCollection

Returns NamedReferenceCollection

Properties

Section titled "Properties"

$t

Section titled "$t" 
$t: Type

Accessors

Section titled "Accessors"

count

Section titled "count"

Gets the number of named references in the collection. The number of named references in the collection.

get count(): number

Returns number

workbook

Section titled "workbook"

Gets the workbook associated with this collection. The workbook associated with this collection.

get workbook(): Workbook

Returns Workbook

Methods

Section titled "Methods"

add

Section titled "add"

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

add(name: string, formula: string): NamedReference

Parameters

  • name: string

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

    The formula to give the named reference.

Returns NamedReference

clear

Section titled "clear"

Clears all named references from the collection.

clear(): void

Returns void

contains

Section titled "contains"

Determines whether a named reference is in the collection.

contains(namedReference: NamedReference): boolean

Parameters

  • namedReference: NamedReference

    The named reference to locate in the collection.

Returns boolean

find

Section titled "find"

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

find(name: string): NamedReference

Parameters

  • name: string

    The name of the named reference to find.

Returns NamedReference

findAll

Section titled "findAll"

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

findAll(name: string): NamedReference[]

Parameters

  • name: string

    The name of the named references to find.

Returns NamedReference[]

item

Section titled "item"

Gets the named reference at the specified index. The named reference at the specified index.

item(a: number): NamedReference

Parameters

  • a: number

Returns NamedReference

remove_1

Section titled "remove_1"

Removes the specified named reference from the collection.

remove_1(namedReference: NamedReference): boolean

Parameters

  • namedReference: NamedReference

    The named reference to remove fro the collection.

Returns boolean

removeAt

Section titled "removeAt"

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

removeAt(index: number): void

Parameters

  • index: number

    The zero-based index of the named reference in the collection.

Returns void

staticInit

Section titled "staticInit" 
staticInit(): void

Returns void