# GC.Spread.Sheets.NameInfo

## Content

# Class: NameInfo

[Spread](../modules/GC.Spread).[Sheets](../modules/GC.Spread.Sheets).NameInfo

## Table of contents

### Constructors

- [constructor](GC.Spread.Sheets.NameInfo#constructor)

### Methods

- [getColumn](GC.Spread.Sheets.NameInfo#getcolumn)
- [getComment](GC.Spread.Sheets.NameInfo#getcomment)
- [getExpression](GC.Spread.Sheets.NameInfo#getexpression)
- [getName](GC.Spread.Sheets.NameInfo#getname)
- [getRow](GC.Spread.Sheets.NameInfo#getrow)
- [isReadOnly](GC.Spread.Sheets.NameInfo#isreadonly)

## Constructors

### <a id="constructor" name="constructor"></a> 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`](GC.Spread.CalcEngine.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

### <a id="getcolumn" name="getcolumn"></a> getColumn

▸ **getColumn**(): `number`

Gets the base column of the custom named expression.

#### Returns

`number`

The base column.

___

### <a id="getcomment" name="getcomment"></a> getComment

▸ **getComment**(): `string`

Gets the comment of the current NameInfo object.

#### Returns

`string`

The name of the current NameInfo object.

___

### <a id="getexpression" name="getexpression"></a> getExpression

▸ **getExpression**(): [`Expression`](GC.Spread.CalcEngine.Expression)

Gets the expression.

#### Returns

[`Expression`](GC.Spread.CalcEngine.Expression)

The expression.

___

### <a id="getname" name="getname"></a> getName

▸ **getName**(): `string`

Gets the name of the current NameInfo object.

#### Returns

`string`

The name of the current NameInfo object.

___

### <a id="getrow" name="getrow"></a> getRow

▸ **getRow**(): `number`

Gets the base row of the custom named expression.

#### Returns

`number`

The base row.

___

### <a id="isreadonly" name="isreadonly"></a> isReadOnly

▸ **isReadOnly**(`value?`): `boolean`

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

#### Parameters

| Name | Type |
| :------ | :------ |
| `value?` | `boolean` |

#### Returns

`boolean`

The readonly status.