Class: NameInfo

Spread.Sheets.NameInfo

Table of contents

Constructors

• constructor

Methods

• getColumn
• getComment
• getExpression
• getName
• getRow
• isReadOnly
• set

Constructors

constructor

• new NameInfo(name, expr, row, column, comment?, isReadOnly?)

Represents a custom named expression that can be used by formulas.

Parameters

Methods

getColumn

▸ getColumn(): number

Gets the base column of the custom named expression.

Returns

number

The base column.

getComment

▸ getComment(): string

Gets the comment of the current NameInfo object.

Returns

string

The name of the current NameInfo object.

getExpression

▸ getExpression(): Expression

Gets the expression.

Returns

Expression

The expression.

getName

▸ getName(): string

Gets the name of the current NameInfo object.

Returns

string

The name of the current NameInfo object.

getRow

▸ getRow(): number

Gets the base row of the custom named expression.

Returns

number

The base row.

isReadOnly

▸ isReadOnly(value?): boolean

Gets/Sets the readonly status of the custom named expression.

Parameters

Returns

boolean

The readonly status.

set

▸ set(name?, formula?, baseRow?, baseCol?, comment?): void

Rename the name, the formula, and the comment of the custom name.

Parameters

Returns

void