Class CellSpanInfoBase
This a base class for spanned ranges such as covered cells and cell spanned backgrounds. It contains Top, Left, Bottom and Right row and column index for the spanned range.
Namespace: Syncfusion.UI.Xaml.CellGrid
Assembly: Syncfusion.SfCellGrid.WPF.dll
Syntax
public class CellSpanInfoBase : Object, IComparable<CellSpanInfoBase>, IComparableConstructors
CellSpanInfoBase()
Initializes a new instance of the CellSpanInfoBase class.
Declaration
public CellSpanInfoBase()CellSpanInfoBase(Int32, Int32, Int32, Int32)
Initializes a new instance of the CellSpanInfoBase class.
Declaration
public CellSpanInfoBase(int top, int left, int bottom, int right)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | top | The top row index. |
| System.Int32 | left | The left column index. |
| System.Int32 | bottom | The bottom row index. |
| System.Int32 | right | The right column index. |
Properties
Bottom
Gets the bottom row index.
Declaration
public int Bottom { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 | The bottom. |
Height
Gets the number of rows.
Declaration
public int Height { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 | The height. |
Left
Gets the left column index.
Declaration
public int Left { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 | The left. |
Right
Gets the right column index.
Declaration
public int Right { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 | The right. |
Top
Gets the top row index.
Declaration
public int Top { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 | The top. |
Width
Gets the number of columns.
Declaration
public int Width { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 | The width. |
Methods
CompareTo(CellSpanInfoBase)
Compares the current object with another object of the same type.
Declaration
public int CompareTo(CellSpanInfoBase other)Parameters
| Type | Name | Description |
|---|---|---|
| CellSpanInfoBase | other | An object to compare with this object. |
Returns
| Type | Description |
|---|---|
| System.Int32 | A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has the following meanings: Value Meaning Less than zero This object is less than the |
Contains(RowColumnIndex)
Determines whether the specified cell is inside the span.
Declaration
public bool Contains(RowColumnIndex cellRowColumnIndex)Parameters
| Type | Name | Description |
|---|---|---|
| RowColumnIndex | cellRowColumnIndex | The cell |
Returns
| Type | Description |
|---|---|
| System.Boolean | true if cell is inside the span; false otherwise. |
Contains(Int32, Int32)
Determines whether the specified cell is inside the span.
Declaration
public bool Contains(int rowIndex, int columnIndex)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | rowIndex | Index of the row. |
| System.Int32 | columnIndex | Index of the column. |
Returns
| Type | Description |
|---|---|
| System.Boolean | true if cell is inside the span; false otherwise. |
ContainsColumn(Int32)
Determines whether the specified column is inside the span.
Declaration
public bool ContainsColumn(int columnIndex)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | columnIndex | The column index |
Returns
| Type | Description |
|---|---|
| System.Boolean | true if column is inside the span; false otherwise. |
ContainsRow(Int32)
Determines whether the specified row is inside the span.
Declaration
public bool ContainsRow(int rowIndex)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | rowIndex | The row index |
Returns
| Type | Description |
|---|---|
| System.Boolean | true if row is inside the span; false otherwise. |
Equals(Object)
Determines whether the specified System.Object is equal to the current System.Object.
Declaration
public override bool Equals(object obj)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | obj | The System.Object to compare with the current System.Object. |
Returns
| Type | Description |
|---|---|
| System.Boolean | true if the specified System.Object is equal to the current System.Object; otherwise, false. |
GetHashCode()
Serves as a hash function for a particular type.
Declaration
public override int GetHashCode()Returns
| Type | Description |
|---|---|
| System.Int32 | A hash code for the current System.Object. |
Offset(Int32, Int32)
Offsets the span with the specified row and column count.
Declaration
public void Offset(int rowCount, int columnCount)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | rowCount | The row count. |
| System.Int32 | columnCount | The column count. |
Offset(Int32, Int32, Boolean, Boolean)
Offsets the span with the specified row and column count.
Declaration
public void Offset(int rowCount, int columnCount, bool adjustStartIndex, bool adjustEndIndex)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | rowCount | The row count. |
| System.Int32 | columnCount | The column count. |
| System.Boolean | adjustStartIndex | Determines whether adjust starting row and column |
| System.Boolean | adjustEndIndex | Determines whether adjust end row and column |
ToString()
Returns a string describing the state of the object.
Declaration
public override string ToString()Returns
| Type |
|---|
| System.String |