Interface ILinked

A control that can be linked to a cell. A linked control's state is the cell's: it reads the cell, and setting its state writes the cell.

interface ILinked {
    getLinkedCell(): string | null;
    getLinkedRange(): ICellRange | null;
    setLinkedCell(
        address: string | null,
        options?: ITransaction.OperationOptions,
    ): this;
}

Hierarchy (View Summary)

ILinked

Index

Methods

getLinkedCell getLinkedRange setLinkedCell

Methods

getLinkedCell

getLinkedCell(): string | null

Returns the address of the cell the control's state lives in, or null if it has none.

Returns string | null

Remarks
It follows the cell through inserts, deletes and moves, and reads #REF! once the cell is deleted. A cell on the control's own sheet has no sheet name ($A$1); one on another sheet has its sheet's (Data!$A$1).

getLinkedRange

getLinkedRange(): ICellRange | null

Returns the cell the control's state lives in, or null if it has none or it no longer exists.

Returns ICellRange | null

setLinkedCell

setLinkedCell(
address: string | null,
options?: ITransaction.OperationOptions,
): this
Sets the cell the control writes its state to.
Parameters
- address: string | null
  The address, or null for none.
- Optionaloptions: ITransaction.OperationOptions
Returns this