XlsName Class |
Represents named range in the excel.
Inheritance Hierarchy
Namespace: Spire.Xls.Core.Spreadsheet
Assembly: Spire.XLS (in Spire.XLS.dll) Version: 15.4.0.0 (15.4.0.5046)
Syntax
The XlsName type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
|
BooleanValue |
Gets / sets boolean value that is contained by this range.
|
|
|
Borders |
Returns aBorders collection that represents the borders of a style
or a range of cells (including a range defined as part of a
conditional format).
|
|
|
BuiltInStyle |
Gets/sets built in style.
|
|
|
CellList |
Returns a Range object that represents the cells in the specified range.
Read-only.
|
|
|
Cells |
Obsolete.
Returns a Range object that represents the cells in the specified range.
Read-only.
|
|
|
CellStyleName |
Returns name of the Style object that represents the style of the specified
range. Read/write String.
|
|
|
Column |
Returns the number of the first column in the first area in the specified
range. Read-only.
|
|
|
ColumnGroupLevel |
Column group level. Read-only.
-1 - Not all columns in the range have same group level.
0 - No grouping,
1 - 7 - Group level.
|
|
|
Columns |
For a Range object, returns an array of Range objects that represent the
columns in the specified range.
|
|
|
ColumnWidth |
Returns or sets the width of all columns in the specified range.
Read/write Double.
|
|
|
Comment |
Comment assigned to the range. Read-only.
|
|
|
CommentValue |
Gets the comment value of the nameManager.
|
|
|
ConditionalFormats |
Collection of conditional formats.
|
|
|
Count |
Returns the number of objects in the collection. Read-only.
|
|
|
DataValidation |
Data validation for the range.
|
|
|
DateTimeValue |
Gets / sets DateTime contained by this cell. Read-write DateTime.
|
|
|
EndCell |
Returns a Range object that represents the cell at the end of the
region that contains the source range.
|
|
|
EntireColumn |
Returns a Range object that represents the entire column (or
columns) that contains the specified range. Read-only.
|
|
|
EntireRow |
Returns a Range object that represents the entire row (or
rows) that contains the specified range. Read-only.
|
|
|
EnvalutedValue |
Returns the calculated value of a formula.
|
|
|
ErrorValue |
Gets / sets error value that is contained by this range.
|
|
|
Formula |
Returns or sets the object's formula in A1-style notation and in
the language of the macro. Read/write Variant.
|
|
|
FormulaArray |
Represents array-entered formula.
Visit http://www.cpearson.com/excel/array.htm for more information.
|
|
|
FormulaArrayR1C1 |
Returns or sets the formula array for the range, using R1C1-style notation.
|
|
|
FormulaBoolValue |
Returns the calculated value of the formula as a boolean.
|
|
|
FormulaDateTime |
Get / set formula DateTime value contained by this cell.
DateTime.MinValue if not all cells of the range have same DateTime value.
|
|
|
FormulaErrorValue |
Returns the calculated value of the formula as a string.
|
|
|
FormulaNumberValue |
Gets / sets number value evaluated by formula.
|
|
|
FormulaR1C1 |
Returns or sets the formula for the range, using R1C1-style notation.
|
|
|
FormulaStringValue |
Gets / sets string value evaluated by formula.
|
|
|
HasBoolean |
Indicates whether range contains boolean value. Read-only.
|
|
|
HasDataValidation |
Indicates whether specified range object has data validation.
If Range is not single cell, then returns true only if all cells have data validation. Read-only.
|
|
|
HasDateTime |
Indicates whether range contains DateTime value. Read-only.
|
|
|
HasError |
Indicates whether range contains error value.
|
|
|
HasExternalFormula |
Indicates is current range has external formula. Read-only.
|
|
|
HasFormula |
True if all cells in the range contain formulas; False if
at least one of the cells in the range doesn't contain a formula.
Read-only Boolean.
|
|
|
HasFormulaArray |
Indicates whether range contains array-entered formula. Read-only.
|
|
|
HasFormulaBoolValue |
Indicates if current range has formula bool value. Read only.
|
|
|
HasFormulaDateTime |
Indicates if current range has formula value formatted as DateTime. Read-only.
|
|
|
HasFormulaErrorValue |
Indicates if current range has formula error value. Read only.
|
|
|
HasFormulaNumberValue |
Gets a value indicating whether the referenced range contains a formula that evaluates to a number.
|
|
|
HasFormulaStringValue |
Gets a value indicating whether the referenced range contains a formula that results in a string value.
|
|
|
HasMerged |
Indicates whether this range is part of merged range. Read-only.
|
|
|
HasNumber |
Indicates whether the range contains number. Read-only.
|
|
|
HasRichText |
Indicates whether cell contains formatted rich text string.
|
|
|
HasString |
Indicates whether the range contains String. Read-only.
|
|
|
HasStyle |
Indicates whether range has default style. False means default style.
Read-only.
|
|
|
HorizontalAlignment |
Returns or sets the horizontal alignment for the specified object.
Read/write HorizontalAlignType.
|
|
|
HtmlString |
Gets and sets the html string which contains data and some formattings in this cell.
|
|
|
Hyperlinks |
Gets the collection of hyperlinks associated with the range referred to by this instance.
|
|
|
IgnoreErrorOptions |
Represents ignore error options. If not single cell returs concatenateed flags.
|
|
|
IndentLevel |
Returns or sets the indent level for the cell or range. Can be an
integer from 0 to 15. Read/write Integer.
|
|
|
Index |
Index of the Name object in the workbook's Names collection.
|
|
|
IsBlank |
Indicates whether the range is blank. Read-only.
|
|
|
IsBuiltIn |
Indicates whether name is buildin or not.
|
|
|
IsExternName |
Obsolete.
Indicates whether the name is extern name.
|
|
|
IsFormulaHidden |
True if the formula will be hidden when the worksheet is protected.
False if at least part of formula in the range is not hidden.
|
|
|
IsFunction |
Indicates whether this is function.
|
|
|
IsGroupedByColumn |
Indicates whether this range is grouped by column. Read-only.
|
|
|
IsGroupedByRow |
Indicates whether this range is grouped by row. Read-only.
|
|
|
IsInitialized |
Indicates whether cell is initialized. Read-only.
|
|
|
IsLocal |
Indicates whether current name is locally defined name. Read-only.
|
|
|
IsStringsPreserved |
Indicates whether all values in the range are preserved as strings.
|
|
|
IsWrapText |
True if Microsoft Excel wraps the text in the object.
Read/write Boolean.
|
|
|
Item String |
Get cell range. Read-only.
|
|
|
Item Int32, Int32 |
Gets / sets cell by row and column index. Row and column indexes are one-based.
|
|
|
Item String, Boolean |
Gets cell range. Read-only.
|
|
|
Item Int32, Int32, Int32, Int32 |
Get cell range. Row and column indexes are one-based. Read-only.
|
|
|
LastColumn |
Returns last column of the range. Read-only.
|
|
|
LastRow |
Returns last row of the range. Read-only.
|
|
|
MergeArea |
Returns a Range object that represents the merged range containing
the specified cell. If the specified cell is not part of a merged range,
this property returns NULL. Read-only.
|
|
|
Name |
Name of the Name object.
|
|
|
NameLocal |
Same as Name.
|
|
|
NumberFormat |
Format of current cell. Analog of Style.NumberFormat property.
|
|
|
NumberText |
Returns cell value after number format application. Read-only.
|
|
|
NumberValue |
Gets / sets double value of the range.
|
|
|
Parent |
Reference to Parent object. Read-only.
(Inherited from
XlsObject
.)
|
|
|
RangeAddress |
Returns the range reference in the language of the macro.
Read-only String.
|
|
|
RangeAddressLocal |
Returns the range reference for the specified range in the language
of the user. Read-only String.
|
|
|
RangeGlobalAddress |
Returns range Address in format "'Sheet1'!$A$1".
|
|
|
RangeGlobalAddress2007 |
Gets the global address for the range in the worksheet, formatted for Excel 2007 and later.
|
|
|
RangeR1C1Address |
Returns the range reference using R1C1 notation.
Read-only String.
|
|
|
RangeR1C1AddressLocal |
Returns the range reference using R1C1 notation.
Read-only String.
|
|
ReferenceCount |
Get quantity of instance references.
(Inherited from
XlsObject
.)
|
|
|
RefersToRange |
Gets / sets Range associated with the Name object.
|
|
|
RichText |
String with rich text formatting. Read-only.
|
|
|
Row |
Returns the number of the first row of the first area in
the range. Read-only Long.
|
|
|
RowGroupLevel |
Row group level. Read-only.
-1 - Not all rows in the range have same group level.
0 - No grouping,
1 - 7 - Group level.
|
|
|
RowHeight |
Returns the height of all the rows in the range specified,
measured in points. Returns Double.MinValue if the rows in the specified range
aren't all the same height. Read / write Double.
|
|
|
Rows |
For a Range object, returns an array of Range objects that represent the
rows in the specified range.
|
|
|
Scope |
Returns string representation of the name's scope. Read-only.
|
|
|
Style |
Returns a Style object that represents the style of the specified
range. Read/write IStyle.
|
|
|
Text |
Gets / sets string value of the range.
|
|
|
TimeSpanValue |
Gets / sets time value of the range.
|
|
|
Value |
For the Name object, a string containing the formula that
the name is defined to refer to.
|
|
|
Value2 |
Returns or sets the cell value. Read/write Variant.
The only difference between this property and the Value property is
that the Value2 property doesn't use the Currency and Date data types.
|
|
|
ValueR1C1 |
Gets named range formula in R1C1 style. Read only.
|
|
|
VerticalAlignment |
Returns or sets the vertical alignment of the specified object.
Read/write VerticalAlignType.
|
|
|
Visible |
Determines whether the object is visible. Read/write Boolean.
|
|
|
Worksheet |
Get worksheet of Name Object.
|
Methods
| Name | Description | |
|---|---|---|
|
Activate |
Activates a single cell, which must be inside the current selection.
To select a range of cells, use the Select method.
|
|
|
Activate(Boolean) |
Activates a single cell, which must be inside the current selection.
To select a range of cells, use the Select method.
|
|
|
AddComment |
Adds comment to the range.
|
|
AddReference |
Increase the quantity of reference. User must use this method when
new wrapper on object is created or reference on object stored.
(Inherited from
XlsObject
.)
|
|
|
AutoFitColumns |
Autofits all columns in the range.
|
|
|
AutoFitRows |
Autofits all rows in the range.
|
|
|
BorderAround |
Sets around border for current range.
|
|
|
BorderAround(LineStyleType) |
Sets around border for current range.
|
|
|
BorderAround(LineStyleType, ExcelColors) |
Sets around border for current range.
|
|
|
BorderAround(LineStyleType, Color) |
Sets around border for current range.
|
|
|
BorderInside |
Sets inside border for current range.
|
|
|
BorderInside(LineStyleType) |
Sets inside border for current range.
|
|
|
BorderInside(LineStyleType, ExcelColors) |
Sets inside border for current range.
|
|
|
BorderInside(LineStyleType, Color) |
Sets inside border for current range.
|
|
|
BorderNone |
Sets none border for current range.
|
|
|
CheckDisposed |
Checks whether object was disposed and throws exception if it was.
(Inherited from
XlsObject
.)
|
|
|
Clear(Boolean) |
Clear the contents of the Range with formatting.
|
|
|
Clear(ExcelClearOptions) |
Clears the Content, formats, comments based on clear option.
|
|
|
ClearContents |
Clear the contents of the Range.
|
|
|
Clone(Object) |
Creates a new object that is a copy of the current instance.
|
|
|
Clone(Object, Dictionary String, String , XlsWorkbook) |
Obsolete.
Creates a clone of the current IXLSRange object.
|
|
|
CollapseGroup |
Collapses current group.
|
|
|
ConvertFullRowColumnName |
Obsolete.
Converts full row or column tokens between versions.
|
|
|
CopyTo |
Copies the range to the specified destination Range (without updating formulas).
|
|
|
Delete |
Removes this Name object from the workbook's Names collection.
|
|
|
Dispose |
Dispose object and free resources.
(Inherited from
XlsObject
.)
|
|
|
Equals |
Determines whether the specified object is equal to the current object.
(Inherited from
Object
.)
|
|
|
ExpandGroup(GroupByType) |
Expands current group.
|
|
|
ExpandGroup(GroupByType, ExpandCollapseFlags) |
Expands current group.
|
|
|
ExportDataTable |
Exports data from a specified range to a DataTable based on the provided export options.
|
|
|
Finalize |
Destructor. Call dispose method of current object.
(Inherited from
XlsObject
.)
|
|
|
FindAll(Boolean) |
This method seraches for the all cells with specified bool value.
|
|
|
FindAll(DateTime) |
This method seraches for the all cells with specified DateTime value.
|
|
|
FindAll(TimeSpan) |
This method seraches for the all cells with specified TimeSpan value.
|
|
|
FindAll(Double, FindType) |
This method seraches for the all cells with specified double value.
|
|
|
FindAll(String, FindType) |
This method seraches for the all cells with specified string value.
|
|
|
FindFirst(Boolean) |
This method seraches for the first cell with specified bool value.
|
|
|
FindFirst(DateTime) |
This method seraches for the first cell with specified DateTime value.
|
|
|
FindFirst(TimeSpan) |
This method seraches for the first cell with specified TimeSpan value.
|
|
|
FindFirst(Double, FindType) |
This method seraches for the first cell with specified double value.
|
|
|
FindFirst(String, FindType) |
This method seraches for the first cell with specified string value.
|
|
|
FindParent(Type) |
This method is used to find parent with specific type.
(Inherited from
XlsObject
.)
|
|
|
FindParent( Type ) |
Find parent of object.
(Inherited from
XlsObject
.)
|
|
|
FindParent(Type, Boolean) |
This method is used to find parent with specific type.
(Inherited from
XlsObject
.)
|
|
|
FindParents |
Finds parent objects.
(Inherited from
XlsObject
.)
|
|
|
FreezePanes |
Freezes pane at the current range.
|
|
|
GetEnumerator |
Returns an enumerator that iterates through the RefersToRange collection.
|
|
|
GetHashCode |
Serves as the default hash function.
(Inherited from
Object
.)
|
|
|
GetType |
Gets the
Type
of the current instance.
(Inherited from
Object
.)
|
|
|
Intersect |
Returns intersection of this range with the specified one.
|
|
|
MemberwiseClone |
Creates a shallow copy of the current
Object
.
(Inherited from
Object
.)
|
|
|
Merge |
Creates a merged cell from the specified Range object.
|
|
|
Merge(Boolean) |
Creates a merged cell from the specified Range object.
|
|
|
Merge(IXLSRange) |
Returns merge of this range with the specified one.
|
|
|
OnDispose |
Method which can be overriden by users to take any specific actions when
object is disposed.
(Inherited from
XlsObject
.)
|
|
|
ReleaseReference |
Decrease quantity of Reference. User must call this method
when freeing resources.
(Inherited from
XlsObject
.)
|
|
|
SetIndex(Int32) |
Obsolete.
Sets index of the named range and raise event.
|
|
|
SetIndex(Int32, Boolean) |
Obsolete.
Sets index of the named range.
|
|
|
SetParent |
Sets parent of the object.
(Inherited from
XlsObject
.)
|
|
|
ToString |
Returns a string that represents the current object.
(Inherited from
Object
.)
|
|
|
UnMerge |
Separates a merged area into individual cells.
|
Fields
| Name | Description | |
|---|---|---|
|
m_bIsDisposed |
Flag which indicates if the object was disposed or not.
(Inherited from
XlsObject
.)
|
See Also
