Class CoveredCellInfo
ToDo
Inheritance
Namespace: Syncfusion.Maui.DataGrid
Assembly: Syncfusion.Maui.DataGrid.dll
Syntax
public class CoveredCellInfo : Object, IComparable<CoveredCellInfo>, IComparableConstructors
CoveredCellInfo(Int32, Int32, Int32, Int32)
Initializes a new instance of the CoveredCellInfo class with the specified cell boundaries.
Declaration
public CoveredCellInfo(int left, int right, int top, int bottom)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | left | The left column index of the covered cell. |
| System.Int32 | right | The right column index of the covered cell. |
| System.Int32 | top | The top row index of the covered cell. |
| System.Int32 | bottom | The bottom row index of the covered cell. |
CoveredCellInfo(Int32, Int32, Int32, Int32, Int32)
Initializes a new instance of the CoveredCellInfo class with the specified row index and cell boundary coordinates. The boundaries are normalized to ensure that the minimum and maximum values are assigned correctly.
Declaration
public CoveredCellInfo(int rowIndex, int left, int right, int top, int bottom)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | rowIndex | The row index to which the covered cell belongs. |
| System.Int32 | left | The left column index of the covered cell. |
| System.Int32 | right | The right column index of the covered cell. |
| System.Int32 | top | The top row index of the covered cell. |
| System.Int32 | bottom | The bottom row index of the covered cell. |
CoveredCellInfo(String, Int32, Int32, Int32, Int32)
Initializes a new instance of the CoveredCellInfo class using the specified name identifier and cell boundary coordinates.
Declaration
public CoveredCellInfo(string name, int left, int right, int top, int bottom)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The name associated with the covered cell. |
| System.Int32 | left | The left column index of the covered cell. |
| System.Int32 | right | The right column index of the covered cell. |
| System.Int32 | top | The top row index of the covered cell. |
| System.Int32 | bottom | The bottom row index of the covered cell. |
Properties
Bottom
Gets a value that determines the bottom row index of the covered cell.
Declaration
public int Bottom { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 | A value that determines the bottom row index of the covered cell. |
Height
Gets the height of the region, measured as the number of units from the top to the bottom edge, inclusive.
Declaration
public int Height { get; }Property Value
| Type |
|---|
| System.Int32 |
Left
Gets the left column index of the covered cell.
Declaration
public int Left { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 | A value that determines the left column index of the covered cell. |
Name
Gets the name of the column for the corresponding covered cell.
Declaration
public string Name { get; }Property Value
| Type | Description |
|---|---|
| System.String | The name of the column for the corresponding covered cell. |
Right
Gets a value that determines the right column index of the covered cell.
Declaration
public int Right { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 | A value that determines the right column index of the covered cell. |
RowIndex
Gets the row index for the covered cell.
Declaration
public int RowIndex { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 | A value that determines the row index of the covered cell. |
Top
Gets a value that determines the top row index of the covered cell.
Declaration
public int Top { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 | A value that determines the top row index of the covered cell. |
Width
Gets the width of the covered cell.
Declaration
public int Width { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 | A value that determines the width of the covered cell. |
Methods
CompareTo(CoveredCellInfo)
Compares the values in the given CoveredCellInfo object with the current instance, returning an integer that indicates the relationship. An implementation of this method must return a value less than zero if this is less than the given CoveredCellInfo, zero if this is equal to the given CoveredCellInfo, or a value greater than zero if this is greater than the given CoveredCellInfo.
Declaration
public int CompareTo(CoveredCellInfo other)Parameters
| Type | Name | Description |
|---|---|---|
| CoveredCellInfo | other | A CoveredCellInfo object which is to be compared with the current instance. |
Returns
| Type | Description |
|---|---|
| System.Int32 | An integer that indicates the relationship between the current instance and the given CoveredCellInfo object. |
CompareTo(Object)
Compares the given object to another object, returning an integer that indicates the relationship. An implementation of this method must return a value less than zero if this is less than the given object, zero if this is equal to the given object, or a value greater than zero if this is greater than the given object.
Declaration
public int CompareTo(object obj)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | obj | An object to be compared with the current object. |
Returns
| Type | Description |
|---|---|
| System.Int32 | An integer that indicates the relationship between the current object and the given object. |
Contains(Int32, Int32)
Determines the specified cell is inside span.
Declaration
public bool Contains(int rowIndex, int columnIndex)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | rowIndex | |
| System.Int32 | columnIndex |
Returns
| Type |
|---|
| System.Boolean |
ContainsColumn(Int32)
Determines the specified column is inside range.
Declaration
public bool ContainsColumn(int columnIndex)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | columnIndex |
Returns
| Type |
|---|
| System.Boolean |
ContainsRow(Int32)
Determines the specified row is inside span.
Declaration
public bool ContainsRow(int rowIndex)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | rowIndex |
Returns
| Type |
|---|
| System.Boolean |
Equals(Object)
Returns a boolean value indicating if the passed object is Equal to the current object. Equality is defined as object equality for reference types and bitwise equality for value types using a loader trick to replace Equals with EqualsValue for value types.
Declaration
public override bool Equals(object obj)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | obj | An object to be compared with the current object. |
Returns
| Type | Description |
|---|---|
| System.Boolean | Returns a boolean value indicating whether the passed object is equal to the current object. |
GetHashCode()
GetHashCode is intended to serve as a hash function for this object. Based on the contents of the object, the hash function will return a suitable value with a relatively random distribution over the various inputs.
The default implementation returns the [....] block index for this instance. Calling it on the same object multiple times will return the same value, so it will technically meet the needs of a hash function, but it's less than ideal. Objects (especially value classes) should override this method.
Declaration
public override int GetHashCode()Returns
| Type | Description |
|---|---|
| System.Int32 | Return a suitable value with a relatively random distribution over the various inputs based on the contents of the object. |
ToString()
Returns a String which represents the object instance. The default for an object is to return the fully qualified name of the class.
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| System.String | The fully qualified name of the class. |