ShinobiControls Xamarin Bindings Documentation

ShinobiGrids : ShinobiGrids Namespace

SGridCoord Class

An object representing the position of a given SGridCell object within the parent ShinobiGrid.

Syntax

[Foundation.Register("SGridCoord", true)]
public class SGridCoord : Foundation.NSObject, IEquatable<SGridCoord>

Remarks

Columns, Rows and Sections are zero-indexed. For example the first (top left) cell of the grid will have a Column of 0, Row of 0 and a section of 0.

Requirements

Namespace: ShinobiGrids
Assembly: ShinobiGrids (in ShinobiGrids.dll)
Assembly Versions: 2.8.0.4

Members

See Also: Inherited members from Foundation.NSObject.

Public Constructors

Documentation for this section has not yet been entered.

Protected Constructors

Constructor to call on derived classes to skip initialization and merely allocate the object.
A constructor used when creating managed representations of unmanaged objects.

Public Properties

[read-only]
override
ClassHandle IntPtr . The handle for this class.
[read-only]
Column nint . The index of the Column that this grid coord object represents.
[read-only]
Row SGridRow . The struct of type Row that represents the index and section of the Row that this grid coord represents.
[read-only]
RowIndex nint . The index of the Row that this grid coord belongs to (note that this does not inform you of the section that the Row belongs to).
[read-only]
Section nint . The index of the section that this grid coord object belongs to.

Public Methods

Equals (SGridCoord) : bool
Returns true if the parameter 'object` is of type SGridCoord and has column and row properties that match the values of this SGridCoord object.
override
Equals (object) : bool
Returns true if the parameter 'object` is of type SGridCoord and has column and row properties that match the values of this SGridCoord object.
override
GetHashCode () : int
Generates a hash code for the current instance.
HasColumn (nint) : bool
Documentation for this section has not yet been entered.
HasColumnAndRow (nint, SGridRow) : bool
Documentation for this section has not yet been entered.
HasColumnOrRow (nint, SGridRow) : bool
Documentation for this section has not yet been entered.
HasRow (SGridRow) : bool
A convenience method to allow for the identification of cells/gridcoords that reside within a particular Row.
HasRowGreaterThanRow (SGridRow) : bool
A convenience method in order to check if this grid coord has a Row that is greater (physically lower in the grid) that the parameter rowToCheck.
HasSection (nint) : bool
Documentation for this section has not yet been entered.
override
ToString () : string
Converts the SGridCoord to a meaningful string

Public Operators

static
Equality (SGridCoord, SGridCoord) Returns true if the two SGridCoord objects have column and row properties that match.
static
Inequality (SGridCoord, SGridCoord) Returns true if the two SGridCoord objects have column and row properties that do not match.

Member Details

SGridCoord Constructor

Constructor to call on derived classes to skip initialization and merely allocate the object.

Syntax

[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)]
protected SGridCoord (Foundation.NSObjectFlag t)

Parameters

t
Unused sentinel value

Remarks

You should not invoke this method directly.

Requirements

Namespace: ShinobiGrids
Assembly: ShinobiGrids (in ShinobiGrids.dll)
Assembly Versions: 2.8.0.4

SGridCoord Constructor

A constructor used when creating managed representations of unmanaged objects.

Syntax

[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)]
protected SGridCoord (IntPtr handle)

Parameters

handle
Handle of the unmanaged object

Remarks

You should not invoke this method directly.

Requirements

Namespace: ShinobiGrids
Assembly: ShinobiGrids (in ShinobiGrids.dll)
Assembly Versions: 2.8.0.4

SGridCoord Constructor

Documentation for this section has not yet been entered.

Syntax

[Foundation.Export("initWithColumn:withRow:")]
public SGridCoord (nint colIndex, SGridRow row)

Parameters

colIndex
Documentation for this section has not yet been entered.
row
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: ShinobiGrids
Assembly: ShinobiGrids (in ShinobiGrids.dll)
Assembly Versions: 2.8.0.4

ClassHandle Property

The handle for this class.

Syntax

public override IntPtr ClassHandle { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Requirements

Namespace: ShinobiGrids
Assembly: ShinobiGrids (in ShinobiGrids.dll)
Assembly Versions: 2.8.0.4

Column Property

The index of the Column that this grid coord object represents.

Syntax

[get: Foundation.Export("column")]
public virtual nint Column { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Requirements

Namespace: ShinobiGrids
Assembly: ShinobiGrids (in ShinobiGrids.dll)
Assembly Versions: 2.8.0.4

Equals Method

Returns true if the parameter 'object` is of type SGridCoord and has column and row properties that match the values of this SGridCoord object.

Syntax

[Foundation.Export("isEqual:")]
public virtual bool Equals (SGridCoord other)

Parameters

other
Documentation for this section has not yet been entered.

Returns

True if `object` is of type SGridCoord and has matching column and row values.

Remarks

Requirements

Namespace: ShinobiGrids
Assembly: ShinobiGrids (in ShinobiGrids.dll)
Assembly Versions: 2.8.0.4

Equals Method

Returns true if the parameter 'object` is of type SGridCoord and has column and row properties that match the values of this SGridCoord object.

Syntax

public override bool Equals (object obj)

Parameters

obj
Documentation for this section has not yet been entered.

Returns

True if `object` is of type SGridCoord and has matching column and row values.

Remarks

Requirements

Namespace: ShinobiGrids
Assembly: ShinobiGrids (in ShinobiGrids.dll)
Assembly Versions: 2.8.0.4

GetHashCode Method

Generates a hash code for the current instance.

Syntax

public override int GetHashCode ()

Returns

An integer hash code for the current instance.

Remarks

Requirements

Namespace: ShinobiGrids
Assembly: ShinobiGrids (in ShinobiGrids.dll)
Assembly Versions: 2.8.0.4

HasColumn Method

Documentation for this section has not yet been entered.

Syntax

[Foundation.Export("hasColumn:")]
public virtual bool HasColumn (nint colToCheck)

Parameters

colToCheck
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: ShinobiGrids
Assembly: ShinobiGrids (in ShinobiGrids.dll)
Assembly Versions: 2.8.0.4

HasColumnAndRow Method

Documentation for this section has not yet been entered.

Syntax

[Foundation.Export("hasColumn:andRow:")]
public virtual bool HasColumnAndRow (nint colToCheck, SGridRow rowToCheck)

Parameters

colToCheck
Documentation for this section has not yet been entered.
rowToCheck
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: ShinobiGrids
Assembly: ShinobiGrids (in ShinobiGrids.dll)
Assembly Versions: 2.8.0.4

HasColumnOrRow Method

Documentation for this section has not yet been entered.

Syntax

[Foundation.Export("hasColumn:orRow:")]
public virtual bool HasColumnOrRow (nint colToCheck, SGridRow rowToCheck)

Parameters

colToCheck
Documentation for this section has not yet been entered.
rowToCheck
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: ShinobiGrids
Assembly: ShinobiGrids (in ShinobiGrids.dll)
Assembly Versions: 2.8.0.4

HasRow Method

A convenience method to allow for the identification of cells/gridcoords that reside within a particular Row.

Syntax

[Foundation.Export("hasRow:")]
public virtual bool HasRow (SGridRow rowToCheck)

Parameters

rowToCheck
The index of the Row to be checked.

Returns

true if RowIndex is equal to this this object's Row property

Remarks

Requirements

Namespace: ShinobiGrids
Assembly: ShinobiGrids (in ShinobiGrids.dll)
Assembly Versions: 2.8.0.4

HasRowGreaterThanRow Method

A convenience method in order to check if this grid coord has a Row that is greater (physically lower in the grid) that the parameter rowToCheck.

Syntax

[Foundation.Export("hasRowGreaterThanRow:")]
public virtual bool HasRowGreaterThanRow (SGridRow rowToCheck)

Parameters

rowToCheck
The Row that this grid coord's Row will be checked against.

Returns

true if RowToCheck is less than (physically higher in the grid) than this grid coords Row property.

Remarks

Requirements

Namespace: ShinobiGrids
Assembly: ShinobiGrids (in ShinobiGrids.dll)
Assembly Versions: 2.8.0.4

HasSection Method

Documentation for this section has not yet been entered.

Syntax

[Foundation.Export("hasSection:")]
public virtual bool HasSection (nint sectionToCheck)

Parameters

sectionToCheck
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: ShinobiGrids
Assembly: ShinobiGrids (in ShinobiGrids.dll)
Assembly Versions: 2.8.0.4

op_Equality Method

Returns true if the two SGridCoord objects have column and row properties that match.

Syntax

public static bool operator== (SGridCoord coord1, SGridCoord coord2)

Parameters

coord1
An SGridCoord object.
coord2
Another SGridCoord object.

Returns

True if the two SGridCoord objects have matching column and row values.

Remarks

Requirements

Namespace: ShinobiGrids
Assembly: ShinobiGrids (in ShinobiGrids.dll)
Assembly Versions: 2.8.0.4

op_Inequality Method

Returns true if the two SGridCoord objects have column and row properties that do not match.

Syntax

public static bool operator!= (SGridCoord coord1, SGridCoord coord2)

Parameters

coord1
An SGridCoord object.
coord2
Another SGridCoord object.

Returns

True if the two SGridCoord objects do not have matching column and row values.

Remarks

Requirements

Namespace: ShinobiGrids
Assembly: ShinobiGrids (in ShinobiGrids.dll)
Assembly Versions: 2.8.0.4

Row Property

The struct of type Row that represents the index and section of the Row that this grid coord represents.

Syntax

[get: Foundation.Export("row")]
public virtual SGridRow Row { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Requirements

Namespace: ShinobiGrids
Assembly: ShinobiGrids (in ShinobiGrids.dll)
Assembly Versions: 2.8.0.4

RowIndex Property

The index of the Row that this grid coord belongs to (note that this does not inform you of the section that the Row belongs to).

Syntax

[get: Foundation.Export("rowIndex")]
public virtual nint RowIndex { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Requirements

Namespace: ShinobiGrids
Assembly: ShinobiGrids (in ShinobiGrids.dll)
Assembly Versions: 2.8.0.4

Section Property

The index of the section that this grid coord object belongs to.

Syntax

[get: Foundation.Export("section")]
public virtual nint Section { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Requirements

Namespace: ShinobiGrids
Assembly: ShinobiGrids (in ShinobiGrids.dll)
Assembly Versions: 2.8.0.4

ToString Method

Converts the SGridCoord to a meaningful string

Syntax

public override string ToString ()

Returns

Documentation for this section has not yet been entered.

Remarks

This is intended for debugging only. You should not rely on the format of this string.

Requirements

Namespace: ShinobiGrids
Assembly: ShinobiGrids (in ShinobiGrids.dll)
Assembly Versions: 2.8.0.4