[]
        
(Showing Draft Content)

GC.Spread.Sheets.NameInfo

Class: NameInfo

Spread.Sheets.NameInfo

Table of contents

Constructors

Methods

Constructors

constructor

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

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

Parameters

Name Type Description
name string The custom expression name.
expr Expression The custom named expression.
row number The base row of the expression.
column number The base column of the expression.
comment? string -
isReadOnly? boolean -

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

Name Type
value? boolean

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

Name Type
name? string
formula? string
baseRow? number
baseCol? number
comment? string

Returns

void