ClassNameCollection
Manages a collection of defined names within a workbook or worksheet scope, providing add, remove, and lookup operations.
Definition
Namespace:Telerik.Windows.Documents.Spreadsheet.Model
Assembly:Telerik.Windows.Documents.Spreadsheet.dll
Syntax:
public class NameCollection : IEnumerable<ISpreadsheetName>, IEnumerableInheritance: objectNameCollection
Implements:
Properties
this[string]
Gets the ISpreadsheetName matching the specified name, using case-insensitive lookup.
Declaration
public ISpreadsheetName this[string name] { get; }Parameters
name
Property Value
The defined name.
Methods
Add(string, string, CellIndex, string, bool)
Adds a new defined name with the specified formula reference at the given cell index.
Declaration
public ISpreadsheetName Add(string name, string refersTo, CellIndex cellIndex, string comment = null, bool isVisible = true)Parameters
name
The name.
refersTo
The refers to.
cellIndex
Index of the cell.
comment
The comment.
isVisible
The is visible.
Returns
Add(string, string, int, int, string, bool)
Adds a new defined name with the specified formula reference at the given cell location.
Declaration
public ISpreadsheetName Add(string name, string refersTo, int rowIndex, int columnIndex, string comment = null, bool isVisible = true)Parameters
name
The name.
refersTo
The refers to.
rowIndex
Index of the row.
columnIndex
Index of the column.
comment
The comment.
isVisible
The is visible.
Returns
Contains(string)
Checks whether a defined name with the specified identifier exists in the collection.
GetEnumerator()
Returns a strongly typed enumerator that iterates through the defined names in the collection.
Declaration
public IEnumerator<ISpreadsheetName> GetEnumerator()Returns
A IEnumerator<T> that can be used to iterate through the collection.
Implements
Remove(string)
Removes the defined name matching the specified identifier from the collection.
TryGetSpreadsheetName(string, out ISpreadsheetName)
Attempts to retrieve the defined name matching the specified identifier.
Declaration
public bool TryGetSpreadsheetName(string name, out ISpreadsheetName spreadsheetName)Parameters
name
The name.
spreadsheetName
The resulting name.
Returns
The value indicating whether the name was successfully found.