Range Class

Range Class

Represents a range of cells, rows, columns, or an entire table.

Inheritance Hierarchy

SystemObject
Stingray.GridRange

Namespace: Stingray.Grid
Assembly: Stingray.GridUtils (in Stingray.GridUtils.dll) Version: 14.0.0.0

Syntax

C++

Copy

[TypeConverterAttribute(typeof(RangeConverter))]
public class Range : ICloneable, ISerializable

<TypeConverterAttribute(GetType(RangeConverter))>
Public Class Range
	Implements ICloneable, ISerializable

[TypeConverterAttribute(typeof(RangeConverter))]
public ref class Range : ICloneable, ISerializable

The Range type exposes the following members.

Constructors

	Name	Description
	Range	Initializes a new empty Range object.
	Range(SerializationInfo, StreamingContext)	Internal.

Top

Methods

	Name	Description
	Cell	Creates a range referencing one cell.
	Cells	Creates a range referencing an arbitrary range of cells.
	Clone	Creates a copy of this Range.
	Col	Creates a range consisting of one column.
	Cols	Creates a range of the specified columns.
	Equals	Determines whether this range is equal to another range. (Overrides ObjectEquals(Object).)
	ExpandRange	Sets the range based on the top, left corner of the range, and the number of rows and columns in the range.
	FromLTRB	Creates a range from the left, top, right, and bottom row and column indexes.
	GetFirstCell	Gets the first cell.
	GetHashCode	Calculates a hash code for this Range. (Overrides ObjectGetHashCode.)
	GetNextCell(UInt32, UInt32)	Gets the next cell, in row order.
	GetNextCell(UInt32, UInt32, Boolean)	Gets the next cell, in either row or column order.
	InsertCols	Inserts columns at a specified starting location.
	InsertRows	Inserts rows at a specified location.
	IntersectRange(Range)	Tests if this range intersects with a specified range.
	IntersectRange(Range, Range)	Tests if tho ranges intersect.
	InvalidRange	Creates an invalid range.
	IsCellInRange	Determines whether a specified cell is within this range.
	Row	Creates a range consisting of one row.
	Rows	Creates a range of the specified rows.
	Table	Creates a range that references an entire table.
	UnionRange(Range)	Calculates the union of this range with another range.
	UnionRange(Range, Range)	Calculates the union of two ranges.

Top

Fields

	Name	Description
	bottom	The bottom bound of the range.
	bValid	Indicates if the range is valid.
	left	The left bound of the range.
	rangeType	The type of range.
	right	The right bound of the range.
	top	The top bound of the range.

Top

Properties

	Name	Description
	Bottom	Gets the bottom row in the range.
	Height	Gets the height, in rows, of this range.
	IsCells	Determines whether this is an arbitrary range of cells.
	IsCols	Determines whether this is a range of columns.
	IsRows	Determines whether this is a range of rows.
	IsTable	Determines whether this range references an entire table.
	IsValid	Determines whether the range is valid..
	Left	Gets the leftmost column in the range.
	RangeType	Gets the type of this range.
	Right	Gets the rightmost column in the range.
	Top	Gets the topmost row in the range.
	Width	Gets the width, in columns, of this range.

Top

Remarks

Ranges that reference an arbitrary range of cells can become invalid if the size of the table changes such that the range references non-existent cells. Ranges that represent ranges of rows or columns are invalidated if any of the referenced rows or columns are removed. However, ranges of rows are not affected by changes to the number of columns.

Similarly, ranges of columns are not affected by changes to the number of rows. A range that references the entire table is not affected by a change to the size of the table. It references the entire table regardless of its size.

Range objects are used in methods that manipulate more than one grid cell in one operation, such as GridControl.SetStyleRange, GridControl.RedrawRowCol, GridControl.CopyCells, and many others.

Reference

Stingray.Grid Namespace