Represents a named reference defined in the workbook.
Constructors
Section titled "Constructors"NamedReference
new NamedReference(a: number, b: NamedReferenceCollection, c: any): NamedReferenceReturns NamedReference
Properties
Section titled "Properties"$t: TypeAccessors
Section titled "Accessors"comment
Section titled "comment"Inherited from: NamedReferenceBase
Gets or sets the comment associated with the named reference or table. The comment associated with the named reference or table.
get comment(): string
Returns string
set comment(a: string): voidParameters
- a:
string
Returns void
formula
Section titled "formula"Gets the formula which defines the named reference. The formula which defines the named reference.
get formula(): string
Returns string
isSimpleReferenceFormula
Section titled "isSimpleReferenceFormula"Gets the value indicating whether the [[formula]] is a simple formula referring to a single cell, a single region, or multiple regions in the same workbook as the named reference.
get isSimpleReferenceFormula(): boolean
Returns boolean
Inherited from: NamedReferenceBase
Gets or sets the name of the reference.
get name(): string
Returns string
set name(a: string): voidParameters
- a:
string
Returns void
referencedCell
Section titled "referencedCell"Gets the [[WorksheetCell]] referenced by the [[formula]].
get referencedCell(): WorksheetCell
Returns WorksheetCell
referencedRegion
Section titled "referencedRegion"Gets the [[WorksheetRegion]] referenced by the [[formula]].
get referencedRegion(): WorksheetRegion
Returns WorksheetRegion
referencedRegions
Section titled "referencedRegions"Gets the array of [[WorksheetRegion]] instances referenced by the [[formula]].
get referencedRegions(): WorksheetRegion[]
Returns WorksheetRegion[]
scope
Section titled "scope"Inherited from: NamedReferenceBase
Gets the scope of the named reference.
get scope(): any
Returns any
Methods
Section titled "Methods"setFormula
Section titled "setFormula"Sets the formula for a named reference.
setFormula(formula: string): voidParameters
- formula:
stringThe string containing the formula value.
Returns void
toString
Section titled "toString"Gets the string representation of the named reference.
toString(): string