ShinobiControls Xamarin Bindings Documentation

ShinobiGrids : ShinobiGrids Namespace

SDataGridDataSourceHelperDelegate Class

Abstract base class for your class that acts as delegate for ShinobiGrids.SDataGridDataSourceHelper.

Syntax

[Foundation.Model]
[Foundation.Protocol]
[Foundation.Register("SDataGridDataSourceHelperDelegate", true)]
public abstract class SDataGridDataSourceHelperDelegate : SDataGridDelegate, ISDataGridDataSourceHelperDelegate, IDisposable

Remarks

Documentation for this section has not yet been entered.

Requirements

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

Members

See Also: Inherited members from SDataGridDelegate.

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. (Inherited from SDataGridDelegate.)
CellCanRespondToDoubleTap (ShinobiDataGrid, SDataGridCell) : bool
Asks the delegate whether a cell in the grid can respond to a double tap. (Inherited from SDataGridDelegate.)
DidEndReorderingColum (ShinobiDataGrid, SDataGridColumn)
Informs the delegate that the specified column has completed reordering. (Inherited from SDataGridDelegate.)
DidEndReorderingRow (ShinobiDataGrid, SDataGridRow)
Informs the delegate that the specified row has completed reordering. (Inherited from SDataGridDelegate.)
DidEndResizingColumn (ShinobiDataGrid, SDataGridColumn, nfloat, nfloat)
Documentation for this section has not yet been entered. (Inherited from SDataGridDelegate.)
DidReorderColumn (ShinobiDataGrid, SDataGridColumn, SDataGridColumn)
Informs the delegate that two columns within the ShinobiDataGrid object have been switched. (Inherited from SDataGridDelegate.)
DidReorderRow (ShinobiDataGrid, SDataGridRow, SDataGridRow)
Informs the delegate that two rows within the ShinobiDataGrid object have been switched. (Inherited from SDataGridDelegate.)
DidTapCell (ShinobiDataGrid, SDataGridCoord, bool)
Tells the delegate that a cell within the ShinobiDataGrid object has been tapped. (Inherited from SDataGridDelegate.)
DidUpdateSelectedItems (SDataGridDataSourceHelper, Foundation.NSObject[])
Informs the delegate that the selection state has changed.
abstract
DisplayValueForProperty (SDataGridDataSourceHelper, string, Foundation.NSObject) : Foundation.NSObject
Provide the value to use for a given key for display purposes.
GetHorizontalGridLineStyle (ShinobiDataGrid, nint, nint) : SDataGridLineStyle
Documentation for this section has not yet been entered. (Inherited from SDataGridDelegate.)
GetSectionHeaderStyle (ShinobiDataGrid, nint) : SDataGridSectionHeaderStyle
Documentation for this section has not yet been entered. (Inherited from SDataGridDelegate.)
GetVerticalGridLineStyle (ShinobiDataGrid, nint) : SDataGridLineStyle
Documentation for this section has not yet been entered. (Inherited from SDataGridDelegate.)
GetWidthForResizingColum (ShinobiDataGrid, SDataGridColumn, nfloat, nfloat) : Foundation.NSNumber
Documentation for this section has not yet been entered. (Inherited from SDataGridDelegate.)
abstract
GroupValueForProperty (SDataGridDataSourceHelper, string, Foundation.NSObject) : Foundation.NSObject
Provide the value to use for a given key for groupping purposes.
HeightForRow (ShinobiDataGrid, nint, nint) : Foundation.NSNumber
Documentation for this section has not yet been entered. (Inherited from SDataGridDelegate.)
OnBeginEditingCell (ShinobiDataGrid, SDataGridCoord)
Tells the delegate that a cell within the ShinobiDataGrid grid object will begin editing. (Inherited from SDataGridDelegate.)
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. (Inherited from SDataGridDelegate.)
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. (Inherited from SDataGridDelegate.)
OnCollapsedSection (ShinobiDataGrid, nint)
Documentation for this section has not yet been entered. (Inherited from SDataGridDelegate.)
OnCollapsingSection (ShinobiDataGrid, nint)
Documentation for this section has not yet been entered. (Inherited from SDataGridDelegate.)
OnDeselectedCell (ShinobiDataGrid, SDataGridCoord)
Tells the delegate that a cell within the ShinobiDataGrid object has been deselected. (Inherited from SDataGridDelegate.)
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. (Inherited from SDataGridDelegate.)
OnDeselectingCell (ShinobiDataGrid, SDataGridCoord)
Tells the delegate that a cell within the ShinobiDataGrid object is about to be deselected. (Inherited from SDataGridDelegate.)
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. (Inherited from SDataGridDelegate.)
OnExpandedSection (ShinobiDataGrid, nint)
Documentation for this section has not yet been entered. (Inherited from SDataGridDelegate.)
OnExpandingSection (ShinobiDataGrid, nint)
Documentation for this section has not yet been entered. (Inherited from SDataGridDelegate.)
OnFinishedEditingCell (ShinobiDataGrid, SDataGridCoord)
Informs the delegate that a cell within the ShinobiDataGrid object has been edited. (Inherited from SDataGridDelegate.)
OnFinishedLayingOutShinobiDataGrid (ShinobiDataGrid)
Tells the delegate that the grid has finished laying out. (Inherited from SDataGridDelegate.)
OnResizedColumn (ShinobiDataGrid, SDataGridColumn, nfloat, nfloat)
Documentation for this section has not yet been entered. (Inherited from SDataGridDelegate.)
OnSelectedCell (ShinobiDataGrid, SDataGridCoord)
Tells the delegate that a cell within the ShinobiDataGrid object has been selected. (Inherited from SDataGridDelegate.)
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. (Inherited from SDataGridDelegate.)
OnSelectingCell (ShinobiDataGrid, SDataGridCoord)
Tells the delegate that a cell within the ShinobiDataGrid object is about to be selected. (Inherited from SDataGridDelegate.)
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. (Inherited from SDataGridDelegate.)
PermittedDragDirectionForCell (ShinobiDataGrid, SDataGridCoord) : SDataGridDragDirection
Asks the delegate for which drag and drop directions are permitted. (Inherited from SDataGridDelegate.)
PopulateCell (SDataGridDataSourceHelper, SDataGridCell, Foundation.NSObject, string, Foundation.NSObject) : bool
Override the population of cells
ShouldBeginEditingCell (ShinobiDataGrid, SDataGridCoord) : bool
Asks the delegate if a cell should respond to an edit event. (Inherited from SDataGridDelegate.)
ShouldCollapseSection (ShinobiDataGrid, nint) : bool
Documentation for this section has not yet been entered. (Inherited from SDataGridDelegate.)
ShouldDeselectCell (ShinobiDataGrid, SDataGridCoord) : bool
Asks the delegate whether a currently selected cell that has been tapped should be marked as deselected. (Inherited from SDataGridDelegate.)
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. (Inherited from SDataGridDelegate.)
ShouldExpandSection (ShinobiDataGrid, nint) : bool
Documentation for this section has not yet been entered. (Inherited from SDataGridDelegate.)
ShouldSelectCell (ShinobiDataGrid, SDataGridCoord) : bool
Asks the delegate whether a currently unselected cell that has been tapped should be marked as selected. (Inherited from SDataGridDelegate.)
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. (Inherited from SDataGridDelegate.)
abstract
SortValueForProperty (SDataGridDataSourceHelper, string, Foundation.NSObject) : Foundation.NSObject
Provide the value to use for a given key for sorting purposes.
WillEndReorderingColumn (ShinobiDataGrid, SDataGridColumn)
Informs the delegate that the specified column is about to complete reordering. (Inherited from SDataGridDelegate.)
WillEndReorderingRow (ShinobiDataGrid, SDataGridRow)
Informs the delegate that the specified row is about to complete reordering. (Inherited from SDataGridDelegate.)
WillEndResizingColumn (ShinobiDataGrid, SDataGridColumn, nfloat, nfloat)
Documentation for this section has not yet been entered. (Inherited from SDataGridDelegate.)

Member Details

SDataGridDataSourceHelperDelegate Constructor

Default constructor

Syntax

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

Remarks

Documentation for this section has not yet been entered.

Requirements

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

SDataGridDataSourceHelperDelegate Constructor

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

Syntax

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

SDataGridDataSourceHelperDelegate Constructor

A constructor used when creating managed representations of unmanaged objects.

Syntax

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

DidUpdateSelectedItems Method

Informs the delegate that the selection state has changed.

Syntax

[Foundation.Export("dataGridDataSourceHelper:didUpdateSelectedItems:")]
protected virtual void DidUpdateSelectedItems (SDataGridDataSourceHelper helper, Foundation.NSObject[] selectedItems)

Parameters

helper
The dataSource-helper that is indicating a state change.
selectedItems
The items that are no selected. This is an array of model objects.

Remarks

Documentation for this section has not yet been entered.

Requirements

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

DisplayValueForProperty Method

Provide the value to use for a given key for display purposes.

Syntax

[Foundation.Export("dataGridDataSourceHelper:displayValueForProperty:withSourceObject:")]
protected abstract Foundation.NSObject DisplayValueForProperty (SDataGridDataSourceHelper helper, string propertyKey, Foundation.NSObject source)

Parameters

helper
The datasource helper that is making this request.
propertyKey
The name of the property that the datasource helper is requesting a value for.
source
The data object that the datasource helper is requesting a value from.

Returns

The value to use for the propertyKey.

Remarks

If you return null from this function the default Obj-C method [NSObject valueForKey:] will be used with the propertyKey on your data object. In this case you must either annotate each property with an Export attribute, such as [Export("myKey")], or override ValueForKey on your data object.

Requirements

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

GroupValueForProperty Method

Provide the value to use for a given key for groupping purposes.

Syntax

[Foundation.Export("dataGridDataSourceHelper:groupValueForProperty:withSourceObject:")]
protected abstract Foundation.NSObject GroupValueForProperty (SDataGridDataSourceHelper helper, string propertyKey, Foundation.NSObject source)

Parameters

helper
The datasource helper that is making this request.
propertyKey
The name of the property that the datasource helper is requesting a value for.
source
The data object that the datasource helper is requesting a value from.

Returns

The value to use for the propertyKey.

Remarks

If you return null from this function the default Obj-C method [NSObject valueForKey:] will be used with the propertyKey on your data object. In this case you must either annotate each property with an Export attribute, such as [Export("myKey")], or override ValueForKey on your data object.

Requirements

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

PopulateCell Method

Override the population of cells

Syntax

[Foundation.Export("dataGridDataSourceHelper:populateCell:withValue:forProperty:sourceObject:")]
protected virtual bool PopulateCell (SDataGridDataSourceHelper helper, SDataGridCell cell, Foundation.NSObject value, string propertyKey, Foundation.NSObject source)

Parameters

helper
The datasource helper that is making this request.
cell
The cell to be populated.
value
The value to populate the cell with, this is the value that the datasource helper has already extracted from the source object.
propertyKey
The name of the property that this cell should be populated with.
source
The data object that is being rendered in the row that this cell belongs to.

Returns

true to indicate that cell has been populated for the given propertyKey, or false to indicate that the cell has not been populated by this method and that the datasource helper should populate the cell using the deafult behaviour.

Remarks

The SDataGridDataSourceHelper is able to automatically populate columns that contain SDataGridTextCell instances. For any other cell type you must implement this delegate method in order to populate the cell. The cell that should be populated is passed via the cell parameter, and the value that it should be populated is passed via the value parameter.

If you return false for a PropertyKey, the default behaviour of the datasource helper will used. This allows you to selectively populate cells.

Requirements

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

SortValueForProperty Method

Provide the value to use for a given key for sorting purposes.

Syntax

[Foundation.Export("dataGridDataSourceHelper:sortValueForProperty:withSourceObject:")]
protected abstract Foundation.NSObject SortValueForProperty (SDataGridDataSourceHelper helper, string propertyKey, Foundation.NSObject source)

Parameters

helper
The datasource helper that is making this request.
propertyKey
The name of the property that the datasource helper is requesting a value for.
source
The data object that the datasource helper is requesting a value from.

Returns

The value to use for the propertyKey.

Remarks

If you return null from this function the default Obj-C method [NSObject valueForKey:] will be used with the propertyKey on your data object. In this case you must either annotate each property with an Export attribute, such as [Export("myKey")], or override ValueForKey on your data object.

Requirements

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