ShinobiControls Xamarin Bindings Documentation

ShinobiGrids : ShinobiGrids Namespace

SDataGridDelegate Class

Abstract base class for your class that accepts notifications from the ShinobiDataGrid

Syntax

[Foundation.Model]
[Foundation.Protocol]
[Foundation.Register("SDataGridDelegate", true)]
public abstract class SDataGridDelegate : UIKit.UIScrollViewDelegate, ISDataGridDelegate, IDisposable

Remarks

The delegate of a ShinobiDataGrid (data-grid) object must adopt the SDataGridDelegate protocol. The delegate concerns itself with the styling of the data-grid and can also receive notifications about actions the data-grid may take or has taken in response to events and interactions.

The delegate should only be used for styling where you wish to provide a style for a particular row, column or gridline, or where each row/column/gridline is to have its own distinct style. If you wish to apply a uniform row/column/gridline style for the entire data-grid then the properites ShinobiDataGrid.DefaultCellStyleForRows, ShinobiDataGrid.DefaultCellStyleForAlternateRows, etc of your ShinobiDataGrid object are designed for this purpose and provide better performance than use of the delegate.

Hint: There are many layers to the grid and, as such, there are many layers of style objects. The application of these styles is subject to a strict precedence heirarchy, covered in more detail in the DataGridUserGuide.

Requirements

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

Members

See Also: Inherited members from UIKit.UIScrollViewDelegate.

Public Constructors

Default constructor

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.

Protected Methods

AlterStyleBeforeApplyingToCellAtCoordinate (ShinobiDataGrid, SDataGridCellStyle, SDataGridCoord)
Gives the delegate a chance to change the style that is about to be applied to a particular cell.
CellCanRespondToDoubleTap (ShinobiDataGrid, SDataGridCell) : bool
Asks the delegate whether a cell in the grid can respond to a double tap.
DidEndReorderingColum (ShinobiDataGrid, SDataGridColumn)
Informs the delegate that the specified column has completed reordering.
DidEndReorderingRow (ShinobiDataGrid, SDataGridRow)
Informs the delegate that the specified row has completed reordering.
DidEndResizingColumn (ShinobiDataGrid, SDataGridColumn, nfloat, nfloat)
Documentation for this section has not yet been entered.
DidReorderColumn (ShinobiDataGrid, SDataGridColumn, SDataGridColumn)
Informs the delegate that two columns within the ShinobiDataGrid object have been switched.
DidReorderRow (ShinobiDataGrid, SDataGridRow, SDataGridRow)
Informs the delegate that two rows within the ShinobiDataGrid object have been switched.
DidTapCell (ShinobiDataGrid, SDataGridCoord, bool)
Tells the delegate that a cell within the ShinobiDataGrid object has been tapped.
GetHorizontalGridLineStyle (ShinobiDataGrid, nint, nint) : SDataGridLineStyle
Documentation for this section has not yet been entered.
GetSectionHeaderStyle (ShinobiDataGrid, nint) : SDataGridSectionHeaderStyle
Documentation for this section has not yet been entered.
GetVerticalGridLineStyle (ShinobiDataGrid, nint) : SDataGridLineStyle
Documentation for this section has not yet been entered.
GetWidthForResizingColum (ShinobiDataGrid, SDataGridColumn, nfloat, nfloat) : Foundation.NSNumber
Documentation for this section has not yet been entered.
HeightForRow (ShinobiDataGrid, nint, nint) : Foundation.NSNumber
Documentation for this section has not yet been entered.
OnBeginEditingCell (ShinobiDataGrid, SDataGridCoord)
Tells the delegate that a cell within the ShinobiDataGrid grid object will begin editing.
OnChangedSortOrderForColumn (ShinobiDataGrid, SDataGridColumn, SDataGridColumnSortOrder)
Informs the delegate that a column has just had its sortOrder changed as a result of a user's tap gesture on said column's header cell.
OnChangingSortOrderForColumn (ShinobiDataGrid, SDataGridColumn, SDataGridColumnSortOrder)
Informs the delegate that a column is about to change its sortOrder as a result of a user's tap gesture on said column's header cell.
OnCollapsedSection (ShinobiDataGrid, nint)
Documentation for this section has not yet been entered.
OnCollapsingSection (ShinobiDataGrid, nint)
Documentation for this section has not yet been entered.
OnDeselectedCell (ShinobiDataGrid, SDataGridCoord)
Tells the delegate that a cell within the ShinobiDataGrid object has been deselected.
OnDeselectedRow (ShinobiDataGrid, SDataGridRow)
Informs the delegate that the deselection of an entire row has just happened as a result of the user having tapped a cell.
OnDeselectingCell (ShinobiDataGrid, SDataGridCoord)
Tells the delegate that a cell within the ShinobiDataGrid object is about to be deselected.
OnDeselectingRow (ShinobiDataGrid, SDataGridRow)
Informs the delegate that the deselection of an entire row is about to happen as a result of the user having tapped a cell.
OnExpandedSection (ShinobiDataGrid, nint)
Documentation for this section has not yet been entered.
OnExpandingSection (ShinobiDataGrid, nint)
Documentation for this section has not yet been entered.
OnFinishedEditingCell (ShinobiDataGrid, SDataGridCoord)
Informs the delegate that a cell within the ShinobiDataGrid object has been edited.
OnFinishedLayingOutShinobiDataGrid (ShinobiDataGrid)
Tells the delegate that the grid has finished laying out.
OnResizedColumn (ShinobiDataGrid, SDataGridColumn, nfloat, nfloat)
Documentation for this section has not yet been entered.
OnSelectedCell (ShinobiDataGrid, SDataGridCoord)
Tells the delegate that a cell within the ShinobiDataGrid object has been selected.
OnSelectedRow (ShinobiDataGrid, SDataGridRow)
Informs the delegate that the selection of an entire row has just happened as a result of the user having tapped a cell.
OnSelectingCell (ShinobiDataGrid, SDataGridCoord)
Tells the delegate that a cell within the ShinobiDataGrid object is about to be selected.
OnSelectingRow (ShinobiDataGrid, SDataGridRow)
Informs the delegate that the selection of an entire row is about to happen as a result of the user having tapped a cell.
PermittedDragDirectionForCell (ShinobiDataGrid, SDataGridCoord) : SDataGridDragDirection
Asks the delegate for which drag and drop directions are permitted.
ShouldBeginEditingCell (ShinobiDataGrid, SDataGridCoord) : bool
Asks the delegate if a cell should respond to an edit event.
ShouldCollapseSection (ShinobiDataGrid, nint) : bool
Documentation for this section has not yet been entered.
ShouldDeselectCell (ShinobiDataGrid, SDataGridCoord) : bool
Asks the delegate whether a currently selected cell that has been tapped should be marked as deselected.
ShouldDeselectRow (ShinobiDataGrid, SDataGridRow) : bool
Asks the delegate whether the currently selected row should be marked as deselected as the result of a tap gesture on a cell.
ShouldExpandSection (ShinobiDataGrid, nint) : bool
Documentation for this section has not yet been entered.
ShouldSelectCell (ShinobiDataGrid, SDataGridCoord) : bool
Asks the delegate whether a currently unselected cell that has been tapped should be marked as selected.
ShouldSelectRow (ShinobiDataGrid, SDataGridRow) : bool
Asks the delegate whether the indicated row should be marked as selected as the result of a tap gesture on a cell.
WillEndReorderingColumn (ShinobiDataGrid, SDataGridColumn)
Informs the delegate that the specified column is about to complete reordering.
WillEndReorderingRow (ShinobiDataGrid, SDataGridRow)
Informs the delegate that the specified row is about to complete reordering.
WillEndResizingColumn (ShinobiDataGrid, SDataGridColumn, nfloat, nfloat)
Documentation for this section has not yet been entered.

Member Details

SDataGridDelegate Constructor

Default constructor

Syntax

[Foundation.Export("init")]
[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)]
public SDataGridDelegate ()

Remarks

Documentation for this section has not yet been entered.

Requirements

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

SDataGridDelegate Constructor

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

Syntax

[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)]
protected SDataGridDelegate (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

SDataGridDelegate Constructor

A constructor used when creating managed representations of unmanaged objects.

Syntax

[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)]
protected SDataGridDelegate (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

AlterStyleBeforeApplyingToCellAtCoordinate Method

Gives the delegate a chance to change the style that is about to be applied to a particular cell.

Syntax

[Foundation.Export("shinobiDataGrid:alterStyle:beforeApplyingToCellAtCoordinate:")]
protected virtual void AlterStyleBeforeApplyingToCellAtCoordinate (ShinobiDataGrid grid, SDataGridCellStyle style, SDataGridCoord coordinate)

Parameters

grid
The grid that the cell belongs to.
style
The style about to be applied to the cell.
coordinate
The coordinate that identifies the location of the cell.

Remarks

This method is called whenever a cell is about to have a style applied to it, either upon a layout of the grid or upon a scroll gesture bringing a new cell into view.

Requirements

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

CellCanRespondToDoubleTap Method

Asks the delegate whether a cell in the grid can respond to a double tap.

Syntax

[Foundation.Export("shinobiDataGrid:cellCanRespondToDoubleTap:")]
protected virtual bool CellCanRespondToDoubleTap (ShinobiDataGrid grid, SDataGridCell cell)

Parameters

grid
The grid containing the cell that has been tapped.
cell
The cell which may be double tapped.

Returns

Documentation for this section has not yet been entered.

Remarks

Use this method to speed up single taps on cells which don't respond to a double tap.

Requirements

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

DidEndReorderingColum Method

Informs the delegate that the specified column has completed reordering.

Syntax

[Foundation.Export("shinobiDataGrid:didEndReorderingColumn:")]
protected virtual void DidEndReorderingColum (ShinobiDataGrid grid, SDataGridColumn column)

Parameters

grid
The datagrid which contains the column.
column
The column which has been dropped.

Remarks

This is called when the user's drag gesture has been completed.

Requirements

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

DidEndReorderingRow Method

Informs the delegate that the specified row has completed reordering.

Syntax

[Foundation.Export("shinobiDataGrid:didEndReorderingRow:")]
protected virtual void DidEndReorderingRow (ShinobiDataGrid grid, SDataGridRow row)

Parameters

grid
The datagrid which contains the row.
row
The row which has been dropped.

Remarks

This is called when the user's drag gesture has been completed.

Requirements

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

DidEndResizingColumn Method

Documentation for this section has not yet been entered.

Syntax

[Foundation.Export("shinobiDataGrid:didEndResizingColumn:fromWidth:toWidth:")]
protected virtual void DidEndResizingColumn (ShinobiDataGrid grid, SDataGridColumn column, nfloat oldWidth, nfloat newWidth)

Parameters

grid
Documentation for this section has not yet been entered.
column
Documentation for this section has not yet been entered.
oldWidth
Documentation for this section has not yet been entered.
newWidth
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

DidReorderColumn Method

Informs the delegate that two columns within the ShinobiDataGrid object have been switched.

Syntax

[Foundation.Export("shinobiDataGrid:didReorderColumn:withColumn:")]
protected virtual void DidReorderColumn (ShinobiDataGrid grid, SDataGridColumn columnSwitched, SDataGridColumn columnSwitchedWith)

Parameters

grid
The grid that contains the columns that have been switched.
columnSwitched
The first switched column.
columnSwitchedWith
The second switched column.

Remarks

This method gives the delegate an opportunity to update the data source appropriately.

Important: When a user drags and drops a column this only reorders the currently visible cells. Therefore it is important to update your data source so that when scrolling/panning takes place, the cells that become visible appear in the correct order.

Requirements

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

DidReorderRow Method

Informs the delegate that two rows within the ShinobiDataGrid object have been switched.

Syntax

[Foundation.Export("shinobiDataGrid:didReorderRow:withRow:")]
protected virtual void DidReorderRow (ShinobiDataGrid grid, SDataGridRow rowSwitched, SDataGridRow rowSwitchedWith)

Parameters

grid
The grid that contains the columns that have been switched.
rowSwitched
The first switched row.
rowSwitchedWith
The second switched row.

Remarks

This method gives the delegate an opportunity to update the data source appropriately.

Important: When a user drags and drops a row this only reorders the currently visible cells. Therefore it is important to update your data source so that when scrolling/panning takes place, the cells that become visible appear in the correct order.

Requirements

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

DidTapCell Method

Tells the delegate that a cell within the ShinobiDataGrid object has been tapped.

Syntax

[Foundation.Export("shinobiDataGrid:didTapCellAtCoordinate:isDoubleTap:")]
protected virtual void DidTapCell (ShinobiDataGrid grid, SDataGridCoord coordinate, bool isDoubleTap)

Parameters

grid
The grid containing the cell that has been tapped.
coordinate
The coordinate of the cell that has been tapped.
isDoubleTap
Indicates whether the cell has been double tapped (single tap otherwise).

Remarks

Documentation for this section has not yet been entered.

Requirements

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

GetHorizontalGridLineStyle Method

Documentation for this section has not yet been entered.

Syntax

[Foundation.Export("shinobiDataGrid:styleForHorizontalGridLineAtIndex:inSection:")]
protected virtual SDataGridLineStyle GetHorizontalGridLineStyle (ShinobiDataGrid grid, nint gridLineIndex, nint sectionIndex)

Parameters

grid
Documentation for this section has not yet been entered.
gridLineIndex
Documentation for this section has not yet been entered.
sectionIndex
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

GetSectionHeaderStyle Method

Documentation for this section has not yet been entered.

Syntax

[Foundation.Export("shinobiDataGrid:styleForSectionHeaderAtIndex:")]
protected virtual SDataGridSectionHeaderStyle GetSectionHeaderStyle (ShinobiDataGrid grid, nint sectionIndex)

Parameters

grid
Documentation for this section has not yet been entered.
sectionIndex
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

GetVerticalGridLineStyle Method

Documentation for this section has not yet been entered.

Syntax

[Foundation.Export("shinobiDataGrid:styleForVerticalGridLineAtIndex:")]
protected virtual SDataGridLineStyle GetVerticalGridLineStyle (ShinobiDataGrid grid, nint gridLineIndex)

Parameters

grid
Documentation for this section has not yet been entered.
gridLineIndex
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

GetWidthForResizingColum Method

Documentation for this section has not yet been entered.

Syntax

[Foundation.Export("shinobiDataGrid:widthForResizingColumn:withCurrentWidth:targetWidth:")]
protected virtual Foundation.NSNumber GetWidthForResizingColum (ShinobiDataGrid grid, SDataGridColumn column, nfloat oldWidth, nfloat newWidth)

Parameters

grid
Documentation for this section has not yet been entered.
column
Documentation for this section has not yet been entered.
oldWidth
Documentation for this section has not yet been entered.
newWidth
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

HeightForRow Method

Documentation for this section has not yet been entered.

Syntax

[Foundation.Export("shinobiDataGrid:heightForRowAtIndex:inSection:")]
protected virtual Foundation.NSNumber HeightForRow (ShinobiDataGrid grid, nint rowIndex, nint sectionIndex)

Parameters

grid
Documentation for this section has not yet been entered.
rowIndex
Documentation for this section has not yet been entered.
sectionIndex
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

OnBeginEditingCell Method

Tells the delegate that a cell within the ShinobiDataGrid grid object will begin editing.

Syntax

[Foundation.Export("shinobiDataGrid:willBeginEditingCellAtCoordinate:")]
protected virtual void OnBeginEditingCell (ShinobiDataGrid grid, SDataGridCoord coordinate)

Parameters

grid
The grid which contains the cell that will begin editing.
coordinate
The coordinate of the cell within grid that will begin editing.

Remarks

Documentation for this section has not yet been entered.

Requirements

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

OnChangedSortOrderForColumn Method

Informs the delegate that a column has just had its sortOrder changed as a result of a user's tap gesture on said column's header cell.

Syntax

[Foundation.Export("shinobiDataGrid:didChangeSortOrderForColumn:from:")]
protected virtual void OnChangedSortOrderForColumn (ShinobiDataGrid grid, SDataGridColumn column, SDataGridColumnSortOrder oldSortOrder)

Parameters

grid
The grid that the column in question belongs to.
column
The column that has just had its sortOrder changed.
oldSortOrder
The sort order that the column had prior to the change.

Remarks

Documentation for this section has not yet been entered.

Requirements

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

OnChangingSortOrderForColumn Method

Informs the delegate that a column is about to change its sortOrder as a result of a user's tap gesture on said column's header cell.

Syntax

[Foundation.Export("shinobiDataGrid:willChangeSortOrderForColumn:to:")]
protected virtual void OnChangingSortOrderForColumn (ShinobiDataGrid grid, SDataGridColumn column, SDataGridColumnSortOrder newSortOrder)

Parameters

grid
The grid that the column in question belongs to.
column
The column that is about to have its sortOrder changed.
newSortOrder
The sort order that column is about to have its sortOrder changed to.

Remarks

Documentation for this section has not yet been entered.

Requirements

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

OnCollapsedSection Method

Documentation for this section has not yet been entered.

Syntax

[Foundation.Export("shinobiDataGrid:didCollapseSectionAtIndex:")]
protected virtual void OnCollapsedSection (ShinobiDataGrid grid, nint sectionIndex)

Parameters

grid
Documentation for this section has not yet been entered.
sectionIndex
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

OnCollapsingSection Method

Documentation for this section has not yet been entered.

Syntax

[Foundation.Export("shinobiDataGrid:willCollapseSectionAtIndex:")]
protected virtual void OnCollapsingSection (ShinobiDataGrid grid, nint sectionIndex)

Parameters

grid
Documentation for this section has not yet been entered.
sectionIndex
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

OnDeselectedCell Method

Tells the delegate that a cell within the ShinobiDataGrid object has been deselected.

Syntax

[Foundation.Export("shinobiDataGrid:didDeselectCellAtCoordinate:")]
protected virtual void OnDeselectedCell (ShinobiDataGrid grid, SDataGridCoord coordinate)

Parameters

grid
The grid containing the cell that has been deselected.
coordinate
The coordinate of the cell that has been deselected.

Remarks

Documentation for this section has not yet been entered.

Requirements

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

OnDeselectedRow Method

Informs the delegate that the deselection of an entire row has just happened as a result of the user having tapped a cell.

Syntax

[Foundation.Export("shinobiDataGrid:didDeselectRow:")]
protected virtual void OnDeselectedRow (ShinobiDataGrid grid, SDataGridRow row)

Parameters

grid
The grid that has just had a row set as deselected.
row
The row that has just been set as deselected.

Remarks

Note that cellSelectionMode must be set to SDataGridSelectionMode.RowSingle or SDataGridSelectionMode.RowMulti for this delegate method to be called and that the cell deselection delegate methods such as SDataGridDelegate.OnDeselectedCell(ShinobiDataGrid, SDataGridCoord) will be called before this method.

Requirements

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

OnDeselectingCell Method

Tells the delegate that a cell within the ShinobiDataGrid object is about to be deselected.

Syntax

[Foundation.Export("shinobiDataGrid:willDeselectCellAtCoordinate:")]
protected virtual void OnDeselectingCell (ShinobiDataGrid grid, SDataGridCoord coordinate)

Parameters

grid
The grid containing the cell that will be deselected.
coordinate
The coordinate of the cell that is about to be deselected.

Remarks

Documentation for this section has not yet been entered.

Requirements

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

OnDeselectingRow Method

Informs the delegate that the deselection of an entire row is about to happen as a result of the user having tapped a cell.

Syntax

[Foundation.Export("shinobiDataGrid:willDeselectRow:")]
protected virtual void OnDeselectingRow (ShinobiDataGrid grid, SDataGridRow row)

Parameters

grid
The grid that is about to have a row set as deselected.
row
The row that is about to be deselected.

Remarks

Note that cellSelectionMode must be set to SDataGridSelectionMode.RowSingle or SDataGridSelectionMode.RowMulti for this delegate method to be called and that the cell deselection delegate methods such as SDataGridDelegate.OnDeselectedCell(ShinobiDataGrid, SDataGridCoord) will be called after this method.

Requirements

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

OnExpandedSection Method

Documentation for this section has not yet been entered.

Syntax

[Foundation.Export("shinobiDataGrid:didExpandSectionAtIndex:")]
protected virtual void OnExpandedSection (ShinobiDataGrid grid, nint sectionIndex)

Parameters

grid
Documentation for this section has not yet been entered.
sectionIndex
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

OnExpandingSection Method

Documentation for this section has not yet been entered.

Syntax

[Foundation.Export("shinobiDataGrid:willExpandSectionAtIndex:")]
protected virtual void OnExpandingSection (ShinobiDataGrid grid, nint sectionIndex)

Parameters

grid
Documentation for this section has not yet been entered.
sectionIndex
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

OnFinishedEditingCell Method

Informs the delegate that a cell within the ShinobiDataGrid object has been edited.

Syntax

[Foundation.Export("shinobiDataGrid:didFinishEditingCellAtCoordinate:")]
protected virtual void OnFinishedEditingCell (ShinobiDataGrid grid, SDataGridCoord coordinate)

Parameters

grid
The grid which contains the cell that has been edited.
coordinate
The coordinate of the cell within grid that has been edited.

Remarks

This method gives the delegate an opportunity to feed back any changes that the user makes to the grid to the data source.

Requirements

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

OnFinishedLayingOutShinobiDataGrid Method

Tells the delegate that the grid has finished laying out.

Syntax

[Foundation.Export("didFinishLayingOutShinobiDataGrid:")]
protected virtual void OnFinishedLayingOutShinobiDataGrid (ShinobiDataGrid grid)

Parameters

grid
The grid which has finished laying out/rendering.

Remarks

The grid lays out, and subsequently calls this method, upon initial render/layout, section collapse/expand and device rotation.

Requirements

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

OnResizedColumn Method

Documentation for this section has not yet been entered.

Syntax

[Foundation.Export("shinobiDataGrid:didResizeColumn:fromWidth:toWidth:")]
protected virtual void OnResizedColumn (ShinobiDataGrid grid, SDataGridColumn column, nfloat oldWidth, nfloat newWidth)

Parameters

grid
Documentation for this section has not yet been entered.
column
Documentation for this section has not yet been entered.
oldWidth
Documentation for this section has not yet been entered.
newWidth
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

OnSelectedCell Method

Tells the delegate that a cell within the ShinobiDataGrid object has been selected.

Syntax

[Foundation.Export("shinobiDataGrid:didSelectCellAtCoordinate:")]
protected virtual void OnSelectedCell (ShinobiDataGrid grid, SDataGridCoord coordinate)

Parameters

grid
The grid which contains the cell that has been selected.
coordinate
The coordinate of the cell that has been selected.

Remarks

Documentation for this section has not yet been entered.

Requirements

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

OnSelectedRow Method

Informs the delegate that the selection of an entire row has just happened as a result of the user having tapped a cell.

Syntax

[Foundation.Export("shinobiDataGrid:didSelectRow:")]
protected virtual void OnSelectedRow (ShinobiDataGrid grid, SDataGridRow row)

Parameters

grid
The grid that is about to have a row set as selected.
row
The row that is about to be selected.

Remarks

Note that cellSelectionMode must be set to SDataGridSelectionMode.RowSingle or SDataGridSelectionMode.RowMulti for this delegate method to be called and that the cell selection delegate methods such as SDataGridDelegate.OnSelectingCell(ShinobiDataGrid, SDataGridCoord) will be called before this method.

Requirements

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

OnSelectingCell Method

Tells the delegate that a cell within the ShinobiDataGrid object is about to be selected.

Syntax

[Foundation.Export("shinobiDataGrid:willSelectCellAtCoordinate:")]
protected virtual void OnSelectingCell (ShinobiDataGrid grid, SDataGridCoord coordinate)

Parameters

grid
The grid which contains the cell that is about to be selected.
coordinate
The coordinate of the cell that is about to be selected.

Remarks

This method gives the delegate an opportunity to apply a custom selection style/animation to the cell or another part of the grid.

Requirements

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

OnSelectingRow Method

Informs the delegate that the selection of an entire row is about to happen as a result of the user having tapped a cell.

Syntax

[Foundation.Export("shinobiDataGrid:willSelectRow:")]
protected virtual void OnSelectingRow (ShinobiDataGrid grid, SDataGridRow row)

Parameters

grid
The grid that is about to have a row set as selected.
row
The row that is about to be selected.

Remarks

Note that cellSelectionMode must be set to SDataGridSelectionMode.RowSingle or SDataGridSelectionMode.RowMulti for this delegate method to be called and that the cell selection delegate methods such as SDataGridDelegate.OnSelectingCell(ShinobiDataGrid, SDataGridCoord) will be called before this method.

Requirements

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

PermittedDragDirectionForCell Method

Asks the delegate for which drag and drop directions are permitted.

Syntax

[Foundation.Export("shinobiDataGrid:permittedDragDirectionForCellAtCoordinate:")]
protected virtual SDataGridDragDirection PermittedDragDirectionForCell (ShinobiDataGrid grid, SDataGridCoord coordinate)

Parameters

grid
The grid asking for the drag decision.
coordinate
The coordinate of the cell that the gesture originated from.

Returns

An entry from the ShinobiGrids.SDataGridDragDirection enum that controls the action the grid will take.

Remarks

This query is triggered from a gesture originating on the cell at a given coord.

Important: Note that row dragging cannot be initiated from a frozen row and that column dragging cannot be initiated from a frozen column despite what you return from this method.

Requirements

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

ShouldBeginEditingCell Method

Asks the delegate if a cell should respond to an edit event.

Syntax

[Foundation.Export("shinobiDataGrid:shouldBeginEditingCellAtCoordinate:")]
protected virtual bool ShouldBeginEditingCell (ShinobiDataGrid grid, SDataGridCoord coordinate)

Parameters

grid
The grid containing the cell in question.
coordinate
The coordinate of the cell which wants to know if it should respond to an edit event.

Returns

A bool that indicates if the cell will respond to an edit event. true results in the cell responding, otherwise the cell ignores the edit event.

Remarks

Note that if you implement this method it overrides the SDataGridColumn.Editable.

Requirements

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

ShouldCollapseSection Method

Documentation for this section has not yet been entered.

Syntax

[Foundation.Export("shinobiDataGrid:shouldCollapseSectionAtIndex:")]
protected virtual bool ShouldCollapseSection (ShinobiDataGrid grid, nint sectionIndex)

Parameters

grid
Documentation for this section has not yet been entered.
sectionIndex
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

ShouldDeselectCell Method

Asks the delegate whether a currently selected cell that has been tapped should be marked as deselected.

Syntax

[Foundation.Export("shinobiDataGrid:shouldDeselectCellAtCoordinate:")]
protected virtual bool ShouldDeselectCell (ShinobiDataGrid grid, SDataGridCoord coordinate)

Parameters

grid
The grid which contains the cell in question.
coordinate
The coordinate of the cell in question.

Returns

Documentation for this section has not yet been entered.

Remarks

This can be used to control deselection on a cell by cell basis.

Requirements

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

ShouldDeselectRow Method

Asks the delegate whether the currently selected row should be marked as deselected as the result of a tap gesture on a cell.

Syntax

[Foundation.Export("shinobiDataGrid:shouldDeselectRow:")]
protected virtual bool ShouldDeselectRow (ShinobiDataGrid grid, SDataGridRow row)

Parameters

grid
The ShinobiGrid which contains the row in question.
row
The row which may or may not be deselected depending on the return value.

Returns

A bool that indicates if row should be marked as deselected.

Remarks

This method can only be called if the grid's cellSelectionMode is set to SDataGridSelectionMode.RowSingle or SDataGridSelectionMode.RowMulti. Note that the cell selection/deselection delegate methods will be called after this method.

Requirements

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

ShouldExpandSection Method

Documentation for this section has not yet been entered.

Syntax

[Foundation.Export("shinobiDataGrid:shouldExpandSectionAtIndex:")]
protected virtual bool ShouldExpandSection (ShinobiDataGrid grid, nint sectionIndex)

Parameters

grid
Documentation for this section has not yet been entered.
sectionIndex
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

ShouldSelectCell Method

Asks the delegate whether a currently unselected cell that has been tapped should be marked as selected.

Syntax

[Foundation.Export("shinobiDataGrid:shouldSelectCellAtCoordinate:")]
protected virtual bool ShouldSelectCell (ShinobiDataGrid grid, SDataGridCoord coordinate)

Parameters

grid
The grid which contains the cell that has been selected.
coordinate
The coordinate of the cell that has been selected.

Returns

Documentation for this section has not yet been entered.

Remarks

This can be used to control selection on a cell by cell basis.

Requirements

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

ShouldSelectRow Method

Asks the delegate whether the indicated row should be marked as selected as the result of a tap gesture on a cell.

Syntax

[Foundation.Export("shinobiDataGrid:shouldSelectRow:")]
protected virtual bool ShouldSelectRow (ShinobiDataGrid grid, SDataGridRow row)

Parameters

grid
The grid which contains the row in question.
row
The row which may or may not be selected depending on the return value.

Returns

A bool that indicates if row should be marked as selected.

Remarks

This method can only be called if the grid's cellSelectionMode is set to SDataGridSelectionMode.RowSingle or SDataGridSelectionMode.RowMulti. Note that the cell selection/deselection delegate methods will be called after this method.

Requirements

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

WillEndReorderingColumn Method

Informs the delegate that the specified column is about to complete reordering.

Syntax

[Foundation.Export("shinobiDataGrid:willEndReorderingColumn:")]
protected virtual void WillEndReorderingColumn (ShinobiDataGrid grid, SDataGridColumn column)

Parameters

grid
The datagrid which contains the column.
column
The column which is about to be dropped.

Remarks

This is called when the user's drag gesture has been completed.

Requirements

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

WillEndReorderingRow Method

Informs the delegate that the specified row is about to complete reordering.

Syntax

[Foundation.Export("shinobiDataGrid:willEndReorderingRow:")]
protected virtual void WillEndReorderingRow (ShinobiDataGrid grid, SDataGridRow row)

Parameters

grid
The datagrid which contains the row.
row
The row which is about to be dropped.

Remarks

This is called when the user's drag gesture has been completed.

Requirements

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

WillEndResizingColumn Method

Documentation for this section has not yet been entered.

Syntax

[Foundation.Export("shinobiDataGrid:willEndResizingColumn:fromWidth:toWidth:")]
protected virtual void WillEndResizingColumn (ShinobiDataGrid grid, SDataGridColumn column, nfloat oldWidth, nfloat newWidth)

Parameters

grid
Documentation for this section has not yet been entered.
column
Documentation for this section has not yet been entered.
oldWidth
Documentation for this section has not yet been entered.
newWidth
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