XlsRangesCollection Class |
Namespace: Spire.Xls.Core.Spreadsheet.Collections
The XlsRangesCollection type exposes the following members.
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.
|
![]() |
Capacity |
Gets or sets the number of elements that the System.Collections.CollectionBase can contain.
(Inherited from
CollectionBase
T
.)
|
![]() |
CellList |
Returns a Range object that represents the cells in the specified range.
For big number of ranges can be very slow operation. Read-only.
|
![]() |
Cells |
Obsolete.
Returns a Range object that represents the cells in the specified range.
For big number of ranges can be very slow operation. Read-only.
|
![]() |
CellsCount |
Number of cells in the 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.
|
![]() |
ConditionalFormats |
Collection of conditional formats.
|
![]() |
Count |
Gets the number of elements contained in the System.Collections.CollectionBase instance.
(Inherited from
CollectionBase
T
.)
|
![]() |
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 |
Gets the evaluated value. Currently, this property always returns null.
|
![]() |
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 array-entered formula in R1C1-style notation and in
the language of the macro. Read/write Variant.
|
![]() |
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 |
Returns the calculated value of the formula as a Number.
|
![]() |
FormulaR1C1 |
Returns or sets the object's formula in R1C1-style notation and in
the language of the macro. Read/write Variant.
|
![]() |
FormulaStringValue |
|
![]() |
HasBoolean |
Indicates whether range contains bool 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 |
Determines whether the object has a formula that evaluates to a numeric value.
|
![]() |
HasFormulaStringValue |
Determines whether the object has a formula 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 |
Returns hyperlinks for this ranges collection.
|
![]() |
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.
|
![]() |
InnerList |
Gets the list of elements in the instance.
(Inherited from
CollectionBase
T
.)
|
![]() |
IsBlank |
Indicates whether the range is blank. Read-only.
|
![]() |
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.
|
![]() |
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.
|
![]() |
IsReadOnly |
Gets a value indicating whether the collection is read-only.
(Inherited from
CollectionBase
T
.)
|
![]() |
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 Int32 |
Returns item by index from the collection.
|
![]() |
Item String |
Get cell range.
|
![]() |
Item Int32, Int32 |
Gets / sets cell by row and index.
|
![]() |
Item String, Boolean |
Gets cell range. Read-only.
|
![]() |
Item Int32, Int32, Int32, Int32 |
Get cell range.
|
![]() |
LastColumn |
Returns last column of the range. Read-only.
|
![]() |
LastRow |
Returns last row of the range. Read-only.
|
![]() |
List |
Gets the list of elements in the instance.
(Inherited from
CollectionBase
T
.)
|
![]() |
MergeArea |
Returns a Range object that represents the merged range containing
the specified cell. If the specified cell not part of a merged range,
this property returns NULL. Read-only.
|
![]() |
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 |
Read-oonly. The parent object for the specified object.
(Inherited from
CollectionExtended
T
.)
|
![]() |
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 the range reference in the language of the macro.
Read-only String.
|
![]() |
RangeGlobalAddress2007 |
Gets address global in the format required by Excel 2007.
|
![]() |
RangeR1C1Address |
Returns the range reference in the language of the macro using R1C1-style reference.
Read-only String.
|
![]() |
RangeR1C1AddressLocal |
Returns the range reference for the specified range in the language
of the user using R1C1 style reference . Read-only String.
|
![]() |
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.
|
![]() |
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 |
Returns or sets the value of the specified range.
Read/write Variant.
|
![]() |
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.
|
![]() |
VerticalAlignment |
Returns or sets the vertical alignment of the specified object.
Read/write VerticalAlignType.
|
![]() |
Worksheet |
Returns a Worksheet object that represents the worksheet
containing the specified range. Read-only.
|
![]() |
WorksheetName |
Gets name of the parent worksheet.
|
Name | Description | |
---|---|---|
![]() |
Activate |
Activages a single cell, scroll to it and activates the respective sheet
To select a range of cells, use the Select method.
|
![]() |
Add |
Adds new range to the collection.
|
![]() |
AddComment |
Adds comment to the range.
|
![]() |
AddRange |
Adds range to the collection.
|
![]() |
AutoFitColumns |
Autofits all columns.
|
![]() |
AutoFitRows |
Autofits all rows.
|
![]() |
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.
|
![]() |
Clear |
Removes all objects from the System.Collections.CollectionBase instance.
(Inherited from
CollectionBase
T
.)
|
![]() |
ClearConditionalFormats |
Clears conditional formats.
|
![]() |
Clone(Object) |
Creates copy of the collection.
(Inherited from
CollectionExtended
T
.)
|
![]() |
Clone(Object, Dictionary String, String , XlsWorkbook) |
Clones current IXLSRange.
|
![]() |
CollapseGroup |
Collapses current group.
|
![]() |
Contains |
Determines whether the collection contains a specific item.
(Inherited from
CollectionBase
T
.)
|
![]() |
CopyTo |
Copies the elements of the collection to an array, starting at a particular array index.
(Inherited from
CollectionBase
T
.)
|
![]() |
EnsureCapacity |
Enlarges internal storage if necessary.
(Inherited from
CollectionExtended
T
.)
|
![]() |
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 |
Obsolete.
Exports data to a DataTable based on the provided ExportTableOptions.
|
![]() |
Finalize |
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from
Object
.)
|
![]() |
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) |
Method used to find parent within a specific type.
(Inherited from
CollectionExtended
T
.)
|
![]() |
FindParent(Type, Boolean) |
Method used to find parent within a specific type.
(Inherited from
CollectionExtended
T
.)
|
![]() |
FreezePanes |
Freezes pane at the current range.
|
![]() |
GetColumnRows |
Retrieves an array of CellRange objects representing either columns or rows based on the provided flag.
|
![]() |
GetEnumerator |
Returns an enumerator that iterates through the collection.
|
![]() |
GetHashCode |
Serves as the default hash function.
(Inherited from
Object
.)
|
![]() |
GetNewRangeLocation |
Gets new address of range.
|
![]() |
GetRectangles |
Returns array that contains information about range.
|
![]() |
GetRectanglesCount |
Returns number of rectangles returned by GetRectangles method.
|
![]() |
GetType |
Gets the
Type
of the current instance.
(Inherited from
Object
.)
|
![]() |
IndexOf |
Returns the zero-based index of the first occurrence of a specified item within the collection.
(Inherited from
CollectionBase
T
.)
|
![]() |
Insert |
Inserts an element into the list at the specified index.
(Inherited from
CollectionBase
T
.)
|
![]() |
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.
|
![]() |
MoveTo |
Moves the current object to the specified destination range.
|
![]() |
OnClear |
OnClear is invoked before Clear behavior.
(Inherited from
CollectionExtended
T
.)
|
![]() |
OnClearComplete |
OnClear is invoked after Clear behavior.
(Inherited from
CollectionExtended
T
.)
|
![]() |
OnInsert |
Performs additional processes before inserting
a new element into the collection.
(Inherited from
CollectionExtended
T
.)
|
![]() |
OnInsertComplete |
Performs additional processes after inserting
a new element into the collection.
(Inherited from
CollectionExtended
T
.)
|
![]() |
OnRemove |
Performs additional processes before removing
an element from the collection.
(Inherited from
CollectionExtended
T
.)
|
![]() |
OnRemoveComplete |
Performs additional processes after removing
an element from the collection.
(Inherited from
CollectionExtended
T
.)
|
![]() |
OnSet |
Performs additional processes before setting
a value in the collection.
(Inherited from
CollectionExtended
T
.)
|
![]() |
OnSetComplete |
Performs additional processes after setting a value in the collection.
(Inherited from
CollectionExtended
T
.)
|
![]() |
Remove |
Removes range from the collection.
|
![]() |
RemoveAt |
Removes the element at the specified index of this instance.
(Inherited from
CollectionBase
T
.)
|
![]() |
SetParent |
Sets parent object for class.
(Inherited from
CollectionExtended
T
.)
|
![]() |
ToString |
Returns a string that represents the current object.
(Inherited from
Object
.)
|
![]() |
UnMerge |
Separates a merged area into individual cells.
|
Name | Description | |
---|---|---|
![]() |
Changed |
Change in the collection.
(Inherited from
CollectionExtended
T
.)
|