- API Reference
- GC
- GC.Data
- GC.Pivot
- GC.Spread.Pivot
- GC.Spread.Slicers
- GC.Spread.CalcEngine
- GC.Spread.Commands
- GC.Spread.Common
- GC.Spread.Formatter
- GC.Spread.Report
- GC.Spread.Sheets
- GC.Spread.Sheets.AutoMerge
- GC.Spread.Sheets.Barcode
- GC.Spread.Sheets.IO
- GC.Spread.Sheets.Bindings
- GC.Spread.Sheets.CalcEngine
- GC.Spread.Sheets.Search
- GC.Spread.Sheets.CellState
- GC.Spread.Sheets.CellTypes
- GC.Spread.Sheets.Charts
- GC.Spread.Sheets.DataCharts
- GC.Spread.Sheets.Commands
- GC.Spread.Sheets.Comments
- GC.Spread.Sheets.ThreadedComments
- GC.Spread.Sheets.ConditionalFormatting
- GC.Spread.Sheets.ContextMenu
- GC.Spread.Sheets.Collaboration
- GC.Spread.Sheets.DataValidation
- GC.Spread.Sheets.DataRange
- GC.Spread.Sheets.Fill
- GC.Spread.Sheets.Filter
- GC.Spread.Sheets.FloatingObjects
- GC.Spread.Sheets.FormulaTextBox
- GC.Spread.Sheets.Hyperlink
- GC.Spread.Sheets.OutlineColumn
- GC.Spread.Sheets.Outlines
- GC.Spread.Sheets.FormulaPanel
- GC.Spread.Sheets.PDF
- GC.Spread.Sheets.InputMask
- GC.Spread.Sheets.Print
- GC.Spread.Sheets.NameBox
- GC.Spread.Sheets.NamedCellTemplates
- GC.Spread.Sheets.Scenarios
- GC.Spread.Sheets.Shapes
- GC.Spread.Sheets.Slicers
- GC.Spread.Sheets.Sparklines
- GC.Spread.Sheets.StatusBar
- GC.Spread.Sheets.Tables
- GC.Spread.Sheets.TableSheet
- GC.Spread.Sheets.Touch
- GC.Spread.Sheets.Designer
- GC.Spread.Sheets.GanttSheet
- GC.Spread.Sheets.AI
- Collaboration
- GC.Spread.Excel
GC.Spread.Sheets.NameInfo
Class: 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 |
The custom expression comment. |
isReadOnly? |
boolean |
The custom expression could be editable. |
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
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 | Description |
|---|---|---|
value? |
boolean |
Sets the readonly status of the custom named expression. |
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 | Description |
|---|---|---|
name? |
string |
The new name of the custom name, all referenced formulas will be updated. |
formula? |
string |
The new formula of the custom name, all referenced cells will be recalculated. |
baseRow? |
number |
The row index of the new formula. |
baseCol? |
number |
The column index of the new formula. |
comment? |
string |
The new custom comment. |
Returns
void