ShinobiControls Xamarin Bindings Documentation

ShinobiGrids : ShinobiGrids Namespace

ShinobiGrid Class

A ShinobiGrid displays data in a grid with multiple columns, rows and sections

Syntax

[Foundation.Register("ShinobiGrid", true)]
public class ShinobiGrid : UIKit.UIScrollView, IDisposable, UIKit.IUIScrollViewDelegate

Remarks

The ShinobiGrid class is intended for easy construction of a grid structure that is presented in Columns, Rows and sections, composed of cells, separated by gridlines, that display content to the user. Columns, Rows and sections are zero-indexed, where the first Column in a grid is at index 0, the first Row in a section is at index 0 and the first section in the grid is at index 0. Cells can be located within a grid from their grid coordinate.

Sections group Rows horizontally and have section headers that allow the user to tap and collapse a section. The grid will have one section by default, but this can be altered by implementing the appropriate SGridDelegate method.

A ShinobiGrid object can present content that is too large for its own frame by allowing for panning and scrolling. This behaviour is automatic where the content dimensions (total cell heights or widths) are greater than the grid's dimensions - no additional setup/calibration is required. The grid will calculate the height of Columns and width of Rows if none are supplied - in order to stop this behaviour simply implement the appropriate style method from SGridDelegate or apply the appropriate default style on the grid itself (such as defaultRowStyle etc.).

A ShinobiGrid object must have an associated object that acts as the data source (which must inherit from ShinobiGrids.SGridDataSource). The data source provides the necessary information to construct the grid, such as number of Rows, sections and Columns, and the content to be displayed within each cell. The data source concerns itself solely with the data model, and issues relating to the style of the grid are controlled through the delegate.

Important: The datasource property is a *weak* reference to the grid's datasource. This means you must maintain a reference to it, to prevent prevent the datasource from being autoreleased / released by ARC.

The delegate of the ShinobiGrid object must inherit from ShinobiGrids.SGridDelegate and can be used to provide styles for specific Rows/Columns/gridlines. Only provide a delegate for your ShinobiGrid object if you wish to provide a style for a specific element of the grid. If you wish to style the grid in a uniform manner (every gridline will be styled identically etc) then the properties such as DefaultRowStyle, DefaultColumnStyles and DefaultGridLineStyle are designed for this purpose. As such it is not necessary for a ShinobiGrid to have a delegate.

Important: The delegate property is a *weak* reference to the grid's delegate. This means you must maintain a reference to it, to prevent prevent the delegate from being autoreleased / released by ARC.

ShinobiGrid uses cell pooling to make your grid as memory efficient as possible. Cells that are not currently visible are returned to an internal cell pool for later use and cells that become visible due to users scrolling/panning are retrieved from this pool. This means that ShinobiGrid caches cells only for visible Rows and Columns, but caches styling objects for the entire grid. For ShinobiGrid to be able to pool cells correctly it needs to know what the cells will be used for. You should use a different `reuseIdentifier` for each distinct type of cell within your grid - for example if you have header cells and normal cells in your grid, you might use the identifiers `HEADER` and `NORMAL`. For code examples of using the identifiers see the ShinobiGrid sample apps.

Requirements

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

Members

See Also: Inherited members from UIKit.UIScrollView.

Public Constructors

Default constructor
Constructor
A constructor that initializes the object from the data stored in the unarchiver object.

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

CanEditCellsViaDoubleTap bool . Dictates whether this grid can be edited or not. If CanEditCellsViaDoubleTap is `true`, then a user can double tap a cell to edit its contents. Default value is `false`. See SGridDelegate.OnEditedAutoCell for a means of intercepting user's changes to cell content.
CanReorderColsViaLongPress bool . A boolean that dictates whether the columns of this grid can be dragged and dropped by the user. If set to true then the user can touch and hold a cell to initiate the drag and drop of a column - the cell being touched and held will display a pulse animation to indicate it is ready for dragging.
CanReorderRowsViaLongPress bool . A boolean that dictates whether the rows of this grid can be dragged and dropped by the user. If set to true then the user can touch and hold a cell to initiate the drag and drop of a row - the cell being touched and held will display a pulse animation to indicate it is ready for dragging.
CanResizeColumnsViaPinch bool . Dictates whether this grid's Columns can be resized or not. If canResizeColumnsViaPinch is `true`, then a user can pinch two Columns to resize them. Default value is `false`.
CanSelectViaSingleTap bool .

Dictates whether this grid can be single tapped or not.

If canSelectViaSingleTap is true, then a user can single tap grid cells and section headers. Tapping a cell triggers the SGridDelegate.OnSelectingCell delegate call. Tapping a section header collapses the section. Default value for this property is true.

[read-only]
override
ClassHandle IntPtr . The handle for this class.
DataSource SGridDataSource . The object that acts as the data source for the receving ShinobiGrid object. The data source must be an instance of a subclass of ShinobiGrids.SGridDataSource. The data source is not retained.
DefaultArrowImage UIKit.UIImage . The default arrow image that will be used when indicating the directions that a column/row can be dragged in after initating a long-press gesture.
DefaultBorderStyle SGridBorderStyle . This property represents the style that will be applied to this grid's content border. The border belongs the the content of the grid and not the grid itself. If you wish to apply a border to the grid then this can be accomplished as with a regular UIView through the use of the `layer` property (as ShinobiGrid is a descendant of UIView).
DefaultColumnStyle SGridColRowStyle . This property sets a default Column style that will be used in all Columns in this grid. Use this property to quickly set a base Column style for the grid. This property will be overriden by any style that is more specific, such as styles assigned in the delegate methods or styles assigned when returning a cell in the datasource method.
DefaultGridLineStyle SGridLineStyle . This property is the default style that will be applied to all gridlines that belong this this ShinobiGrid object. Any style applied to a gridline via the delegate object will take priority over this property.
DefaultPermittedDragDirection SGridDragDirection . An enum that dictates whether the rows of this grid can be dragged and dropped by the user.
DefaultRowStyle SGridColRowStyle . This property sets a default Row style that will be used in all Rows in all sections in this grid. Use this property to quickly set a base Row style for the grid. This property will be overriden by any style that is more specific, such as styles assigned in the delegate methods or styles assigned when returning a cell in the datasource method.
DefaultSectionHeaderStyle SGridSectionHeaderStyle . This property represents the style that will be applied to all section headers in this grid. To specify individual styles for each (or a particular) section header then see SGridDelegate.GetSectionHeaderStyle. Note that a style specified with the delegate method will take priority over this property.
DefaultSelectedCellStyle SGridCellStyle . The default style to be used upon row/cell selection.
DeferredLayout bool . Controls whether or not your app should wait for the grid to finish laying out before appearing.
Delegate SGridDelegate . The object that acts as the delegate of the receiving ShinobiGrid object.
DirectionalLockAllowDiagonalPanning bool .

A Boolean value that determines whether directional lock disallows diagnonal panning.

This property only takes effect if directionalLockEnabled is true. If this property is false, scrolling behaves as dictated by directionalLockEnabled. If this property is true and the user begins dragging, the scroll view disables scrolling in the other direction. If the drag direction is diagonal, then the grid will lock in the most dominant direction.

The default value is false.

DoubleTapEventMask SGridEvent .

The type of event that the grid fires upon a double tap.

See ShinobiGrid.SingleTapEventMask.

EnableBlending bool .

Indicates whether the grid will alpha blend the style colors.

An example of where color layering occurs is when you have a defaultRowStyle that has a red background color and a column style that has a blue background color. If the blue background color had an alpha of 1 then no blending will take place, but an alpha of less than 1 blends so that we see the red color 'beneath' the blue color. If this property is `NO` then, then the color that is 'on top' in the layering will be used without blending with the 'beneath' colors (in the example above we would see a blue background color).

[read-only]
static
Info string . The version info for the grid
LicenseKey string . Deprecated. Use ShinobiDataGrids.LicenseKey instead.
LinesOnTop SGridLinesOnTop . Controls the manner in which the gridlines are displayed in this grid. If this property is set to `SGridLinesVerticalOnTop` then the vertical gridlines will be drawn over the top of the horizontal gridlines. The opposite is true if this property is set to `SGridLinesHorizontalOnTop`.
MinimumColWidth Foundation.NSNumber . If the grid cannot find a column width to use then it will try to calculate one to use.
MinimumRowHeight Foundation.NSNumber . If the grid cannot find a row height to use then it will try to calculate one to use.
NumberOfFrozenColumns nuint .

Property states how many columns should be frozen. The columns are frozen from the left hand side of the grid.

The default value is 0, which represents there being no frozen columns.

NumberOfFrozenRows nuint .

Property states how many rows should be frozen. The rows are frozen from the top of the grid downwards.

The default value is 0, which represents there being no frozen rows.

PreventSingleRowDeselection bool .

Prevents single-row deselection. When the grid is in single-row selection mode, this will prevent the user from deselecting the selected row.

Defaults to NO.

RowStylesTakePriority bool . This boolean value dictates the course of action to take if conflicting Row and Column styles are found. If set to `true`, then the Row style will take priority over the Column style. If set to `false` then the oppostie is true. The default value is `false` (Column styles take priority by default). If you set the Row at index 0 to have a `BackgroundColor` of red, and the Column at index 0 to have a `backgroundColor` of blue, then the cell at `gridCoord` {0,0} is being told to have a `backgroundColor` of red and blue. Setting this property to true in this instance would mean that the Row style (red background) will be appled.
SelectionMode SGridSelectionMode . Controls the cell selection mode of the grid.
SingleTapEventMask SGridEvent .

The type of event that the grid fires upon a single tap.

ShinobiGrids.SGridEvent is a bitmask, allowing you to specify multiple events for a single gesture. For example, SingleTapEventMask = SGridEvent.Select | SGridEvent.Edit will cause the grid to select and edit a cell on single tap.

The grid may be configured to use either select or edit a cell on a single tap. To disable the single tap gesture, set this property to SGridEvent.None.

TintColor UIKit.UIColor . The color to use when tinting the grid, during a drag and drop operation. Defaults to null, for no tint color.
[read-only]
VisibleColumnIndexes nint[]. An array of column indexes. Each represents a currently visible column
[read-only]
VisibleRows SGridRow[]. An array of ShinobiGrids.SGridRow objects. Each represents a currently visible Row
override
WeakDelegate Foundation.NSObject . The object that acts as the delegate of the receiving ShinobiGrid object.

Public Methods

ClearAllSelectedCellsWithAnimation (bool)
Set all the currently selected cells to deselect.
DequeueReusableCell (string) : Foundation.NSObject
Returns a reusable ShinobiGrid cell object located by its identifier.
FindRowAfterRow (SGridRow) : SGridRow
This function will return the next Row down.
FindRowBeforeRow (SGridRow) : SGridRow
This function will return the next Row up.
FreezeColsToTheLeftOfAndIncluding (nint)
Documentation for this section has not yet been entered.
FreezeRowsAboveAndIncluding (SGridRow)
This method freezes all Rows above (and including) the supplied Row. Note that if a cell belongs to both a frozen Row and frozen Column that it will not be scrollable in any direction.
HandleEditEventOnCell (SGridCell)
Undocumented
HandleReorderEventOnCell (SGridCell)
Undocumented
HandleSelectionEventOnCell (SGridCell)
Undocumented
NumberOfColumns () : nuint
Returns the total number of columns that the grid currently has.
NumberOfRows (nint) : nuint
Documentation for this section has not yet been entered.
NumberOfSections () : nuint
Returns the number of sections that the grid currently has.
RedrawColsAtIndices (Foundation.NSNumber[])
Redraws the specified columns. This causes the columns in question to have their styles rebuilt and reapplied (according to the grid's style heirarchy rules). This includes querying any delegate methods responsible for style. This method does not query the grid's data source.
RedrawRows (Foundation.NSValue[])
Redraws the specified rows. This causes the rows in question to have their styles rebuilt and reapplied (according to the grid's style heirarchy rules). This includes querying any delegate methods responsible for style. This method does not query the grid's data source.
Reload ()
Reloads this ShinobiGrid object. Use this method to reload all the data that is used to construct the grid.
ReloadColsAtIndices (Foundation.NSNumber[])
Reloads the data for the columns at the specified indices. This forces a query of your data source for all visible rows in the columns at the supplied indices. This method also triggers a redraw of the specified columns as per ShinobiGrid.RedrawColsAtIndices(Foundation.NSNumber[]).
ReloadRows (Foundation.NSValue[])
Reloads the data for the specified rows. This forces a query of your data source for all visible columns in the supplied rows. This method also triggers a redraw of the specified rows as per ShinobiGrid.RedrawRows(Foundation.NSValue[]).
SectionIsCollapsed (nuint) : bool
Documentation for this section has not yet been entered.
SelectedCellGridCoords () : SGridCoord[]
Returns an array of grid coordinates of all the currently selected (and visible) cells. If no cells are currently selected then returns an empty array. Grid coordinates representing cells that are not visible are not returned.
SelectedRows () : SGridRow[]
Return an array of NSValue objects that represent the currently selected rows in the grid.
SetRowSelected (SGridRow, bool, bool)
Set an entire row in this grid as being selected/deselected. Using this method results in the on selecting/selected/deselecting/deselected delegate callback methods being called. The should select/deselect delegate callbacks will not be called.
SetSectionAsCollapsed (nuint, bool)
Documentation for this section has not yet been entered.
SetSelectedRows (Foundation.NSValue[])
Calls ShinobiGrid.SetSelectedRows(Foundation.NSValue[], bool) with animated = false
SetSelectedRows (Foundation.NSValue[], bool)
Replaces the currently selected rows with a new array of selected rows. This results in all the currently selected rows being deselected, and then all the rows in newSelectedRows being set as selected by calling ShinobiGrid.SetRowSelected(SGridRow, bool, bool) on all of them.
VisibleCell (nint, SGridRow) : SGridCell
Documentation for this section has not yet been entered.

Protected Methods

override
Dispose (bool)
Releases unmanaged resources.

Member Details

ShinobiGrid Constructor

Default constructor

Syntax

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

Remarks

Requirements

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

ShinobiGrid Constructor

Constructor

Syntax

public ShinobiGrid (CoreGraphics.CGRect frame)

Parameters

frame
The frame dimensions

Remarks

T

Requirements

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

ShinobiGrid Constructor

A constructor that initializes the object from the data stored in the unarchiver object.

Syntax

[Foundation.Export("initWithCoder:")]
[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)]
public ShinobiGrid (Foundation.NSCoder coder)

Parameters

coder
The unarchiver object

Remarks

This constructor is provided to allow the class to be initialized from an unarchiver (for example, during NIB deserialization).

Requirements

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

ShinobiGrid Constructor

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

Syntax

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

ShinobiGrid Constructor

A constructor used when creating managed representations of unmanaged objects.

Syntax

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

CanEditCellsViaDoubleTap Property

Dictates whether this grid can be edited or not. If CanEditCellsViaDoubleTap is `true`, then a user can double tap a cell to edit its contents. Default value is `false`. See SGridDelegate.OnEditedAutoCell for a means of intercepting user's changes to cell content.

Syntax

[System.Obsolete("Use doubleTapEventMask instead", false)]
[get: Foundation.Export("canEditCellsViaDoubleTap", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setCanEditCellsViaDoubleTap:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual bool CanEditCellsViaDoubleTap { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Having this value set to true means that the grid has an internal double tap gesture recogniser that is enabled. Setting this property to false disables this gesture recogniser.

Important: This method has been deprecated in preference of DoubleTapEventMask.

Requirements

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

CanReorderColsViaLongPress Property

A boolean that dictates whether the columns of this grid can be dragged and dropped by the user. If set to true then the user can touch and hold a cell to initiate the drag and drop of a column - the cell being touched and held will display a pulse animation to indicate it is ready for dragging.

Syntax

[System.Obsolete("Use DefaultPermittedDragDirection instead.", false)]
[get: Foundation.Export("canReorderColsViaLongPress", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setCanReorderColsViaLongPress:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual bool CanReorderColsViaLongPress { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Important: ShinobiGrid has an internal long press gesture recogniser which is enabled if either this property or the ShinobiGrid.CanReorderRowsViaLongPress property is set to true. Setting both these properties to false disables this gesture recogniser.

Important: This method has been deprecated in preference of DefaultPermittedDragDirection.

Requirements

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

CanReorderRowsViaLongPress Property

A boolean that dictates whether the rows of this grid can be dragged and dropped by the user. If set to true then the user can touch and hold a cell to initiate the drag and drop of a row - the cell being touched and held will display a pulse animation to indicate it is ready for dragging.

Syntax

[System.Obsolete("Use DefaultPermittedDragDirection instead.", false)]
[get: Foundation.Export("canReorderRowsViaLongPress", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setCanReorderRowsViaLongPress:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual bool CanReorderRowsViaLongPress { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Important: ShinobiGrid has an internal long press gesture recogniser which is enabled if either this property or the ShinobiGrid.CanReorderColsViaLongPress property is set to true. Setting both these properties to false disables this gesture recogniser.

Important: This method has been deprecated in preference of DefaultPermittedDragDirection.

Requirements

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

CanResizeColumnsViaPinch Property

Dictates whether this grid's Columns can be resized or not. If canResizeColumnsViaPinch is `true`, then a user can pinch two Columns to resize them. Default value is `false`.

Syntax

[get: Foundation.Export("canResizeColumnsViaPinch", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setCanResizeColumnsViaPinch:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual bool CanResizeColumnsViaPinch { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Important: Having this value set to `true` means that the grid has an internal pinch gesture recogniser that is enabled. Setting this property to `false` disables this gesture recogniser.

Requirements

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

CanSelectViaSingleTap Property

Dictates whether this grid can be single tapped or not.

If canSelectViaSingleTap is true, then a user can single tap grid cells and section headers. Tapping a cell triggers the SGridDelegate.OnSelectingCell delegate call. Tapping a section header collapses the section. Default value for this property is true.

Syntax

[System.Obsolete("Use SingleTapEventMask instead", false)]
[get: Foundation.Export("canSelectViaSingleTap", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setCanSelectViaSingleTap:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual bool CanSelectViaSingleTap { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Important: Having this value set to true means that the grid has an internal single tap gesture recogniser that is enabled. Setting this property to false disables this gesture recogniser.

This method has been deprecated in preference of ShinobiGrid.SingleTapEventMask.

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

ClearAllSelectedCellsWithAnimation Method

Set all the currently selected cells to deselect.

Syntax

[Foundation.Export("clearAllSelectedCellsWithAnimation:")]
public virtual void ClearAllSelectedCellsWithAnimation (bool animate)

Parameters

animate
A boolean that controls if the clearing of the selected cells should be animated or not.

Remarks

Documentation for this section has not yet been entered.

Requirements

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

DataSource Property

The object that acts as the data source for the receving ShinobiGrid object. The data source must be an instance of a subclass of ShinobiGrids.SGridDataSource. The data source is not retained.

Syntax

[get: Foundation.Export("dataSource", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setDataSource:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual SGridDataSource DataSource { get; set; }

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

DefaultArrowImage Property

The default arrow image that will be used when indicating the directions that a column/row can be dragged in after initating a long-press gesture.

Syntax

[get: Foundation.Export("defaultArrowImage", ObjCRuntime.ArgumentSemantic.Strong)]
[set: Foundation.Export("setDefaultArrowImage:", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual UIKit.UIImage DefaultArrowImage { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

*Important* The arrow supplied should point right. The top, left and bottom arrow images will be supplied by rotating this image as though it were pointing right initially.

Requirements

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

DefaultBorderStyle Property

This property represents the style that will be applied to this grid's content border. The border belongs the the content of the grid and not the grid itself. If you wish to apply a border to the grid then this can be accomplished as with a regular UIView through the use of the `layer` property (as ShinobiGrid is a descendant of UIView).

Syntax

[get: Foundation.Export("defaultBorderStyle", ObjCRuntime.ArgumentSemantic.Strong)]
[set: Foundation.Export("setDefaultBorderStyle:", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual SGridBorderStyle DefaultBorderStyle { get; set; }

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

DefaultColumnStyle Property

This property sets a default Column style that will be used in all Columns in this grid. Use this property to quickly set a base Column style for the grid. This property will be overriden by any style that is more specific, such as styles assigned in the delegate methods or styles assigned when returning a cell in the datasource method.

Syntax

[get: Foundation.Export("defaultColumnStyle", ObjCRuntime.ArgumentSemantic.Strong)]
[set: Foundation.Export("setDefaultColumnStyle:", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual SGridColRowStyle DefaultColumnStyle { get; set; }

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

DefaultGridLineStyle Property

This property is the default style that will be applied to all gridlines that belong this this ShinobiGrid object. Any style applied to a gridline via the delegate object will take priority over this property.

Syntax

[get: Foundation.Export("defaultGridLineStyle", ObjCRuntime.ArgumentSemantic.Strong)]
[set: Foundation.Export("setDefaultGridLineStyle:", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual SGridLineStyle DefaultGridLineStyle { get; set; }

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

DefaultPermittedDragDirection Property

An enum that dictates whether the rows of this grid can be dragged and dropped by the user.

Syntax

[get: Foundation.Export("defaultPermittedDragDirection", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setDefaultPermittedDragDirection:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual SGridDragDirection DefaultPermittedDragDirection { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Important: ShinobiGrid has an internal long press gesture recogniser which is enabled if either this property is not SGridDragDirection.None. Setting this property to SGridDragDirection.None disables this gesture recogniser.

Requirements

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

DefaultRowStyle Property

This property sets a default Row style that will be used in all Rows in all sections in this grid. Use this property to quickly set a base Row style for the grid. This property will be overriden by any style that is more specific, such as styles assigned in the delegate methods or styles assigned when returning a cell in the datasource method.

Syntax

[get: Foundation.Export("defaultRowStyle", ObjCRuntime.ArgumentSemantic.Strong)]
[set: Foundation.Export("setDefaultRowStyle:", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual SGridColRowStyle DefaultRowStyle { get; set; }

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

DefaultSectionHeaderStyle Property

This property represents the style that will be applied to all section headers in this grid. To specify individual styles for each (or a particular) section header then see SGridDelegate.GetSectionHeaderStyle. Note that a style specified with the delegate method will take priority over this property.

Syntax

[get: Foundation.Export("defaultSectionHeaderStyle", ObjCRuntime.ArgumentSemantic.Strong)]
[set: Foundation.Export("setDefaultSectionHeaderStyle:", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual SGridSectionHeaderStyle DefaultSectionHeaderStyle { get; set; }

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

DefaultSelectedCellStyle Property

The default style to be used upon row/cell selection.

Syntax

[get: Foundation.Export("defaultSelectedCellStyle", ObjCRuntime.ArgumentSemantic.Strong)]
[set: Foundation.Export("setDefaultSelectedCellStyle:", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual SGridCellStyle DefaultSelectedCellStyle { get; set; }

Value

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

DeferredLayout Property

Controls whether or not your app should wait for the grid to finish laying out before appearing.

Syntax

[get: Foundation.Export("deferredLayout", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setDeferredLayout:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual bool DeferredLayout { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

If set to true the layout of the grid will be pushed to the beginning of your app's next run loop - the effect of this is that your app will appear without the grid and the grid will add itself to the view when it has finished laying out. Default value is false.

Requirements

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

Delegate Property

The object that acts as the delegate of the receiving ShinobiGrid object.

Syntax

public SGridDelegate Delegate { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

The delegate must be an instance of a subclass of ShinobiGrids.SGridDelegate. The delegate is not retained.

Requirements

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

DequeueReusableCell Method

Returns a reusable ShinobiGrid cell object located by its identifier.

Syntax

[Foundation.Export("dequeueReusableCellWithIdentifier:")]
public virtual Foundation.NSObject DequeueReusableCell (string identifier)

Parameters

identifier
The identifier of a pool of ShinobiGrid cell objects

Returns

A previously created ShinobiGrid cell object

Remarks

Requirements

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

DirectionalLockAllowDiagonalPanning Property

A Boolean value that determines whether directional lock disallows diagnonal panning.

This property only takes effect if directionalLockEnabled is true. If this property is false, scrolling behaves as dictated by directionalLockEnabled. If this property is true and the user begins dragging, the scroll view disables scrolling in the other direction. If the drag direction is diagonal, then the grid will lock in the most dominant direction.

The default value is false.

Syntax

[get: Foundation.Export("directionalLockAllowDiagonalPanning", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setDirectionalLockAllowDiagonalPanning:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual bool DirectionalLockAllowDiagonalPanning { get; set; }

Value

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

Dispose Method

Releases unmanaged resources.

Syntax

protected override void Dispose (bool disposing)

Parameters

disposing
True if called by Dispose, false if called from a finalizer

Remarks

Requirements

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

DoubleTapEventMask Property

The type of event that the grid fires upon a double tap.

See ShinobiGrid.SingleTapEventMask.

Syntax

[get: Foundation.Export("doubleTapEventMask")]
[set: Foundation.Export("setDoubleTapEventMask:")]
public virtual SGridEvent DoubleTapEventMask { get; set; }

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

EnableBlending Property

Indicates whether the grid will alpha blend the style colors.

An example of where color layering occurs is when you have a defaultRowStyle that has a red background color and a column style that has a blue background color. If the blue background color had an alpha of 1 then no blending will take place, but an alpha of less than 1 blends so that we see the red color 'beneath' the blue color. If this property is `NO` then, then the color that is 'on top' in the layering will be used without blending with the 'beneath' colors (in the example above we would see a blue background color).

Syntax

[get: Foundation.Export("enableBlending", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setEnableBlending:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual bool EnableBlending { get; set; }

Value

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

FindRowAfterRow Method

This function will return the next Row down.

Syntax

[Foundation.Export("findRowAfterRow:")]
public virtual SGridRow FindRowAfterRow (SGridRow rowToStepDownFrom)

Parameters

rowToStepDownFrom
The Row that will be stepped down from in order to find the next Row.

Returns

The Row resulting from incrementing `RowToStepDownFrom` by one place

Remarks

Important: This function is purely a utility function and has no bounds checking in relation to the grid. If you ask it to return the next Row down from the very last Row in the grid, it will return what would be the next Row down regardless of the fact that the returned Row does not exist in the grid.

Requirements

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

FindRowBeforeRow Method

This function will return the next Row up.

Syntax

[Foundation.Export("findRowBeforeRow:")]
public virtual SGridRow FindRowBeforeRow (SGridRow rowToStepUpFrom)

Parameters

rowToStepUpFrom
The Row that will be stepped up from in order to find the previous Row.

Returns

The Row resulting from decrementing `RowToStepUpFrom` by one place.

Remarks

Important: This function is purely a utility function and has no bounds checking in relation to the grid. If you ask it to return the next Row up from the very first Row in the grid, it will return what would be the next Row up regardless of the fact that the returned Row does not exist in the grid.

Requirements

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

FreezeColsToTheLeftOfAndIncluding Method

Documentation for this section has not yet been entered.

Syntax

[Foundation.Export("freezeColsToTheLeftOfAndIncludingIndex:")]
[System.Obsolete("Use NumberOfFrozenColumns instead", false)]
public virtual void FreezeColsToTheLeftOfAndIncluding (nint colIndex)

Parameters

colIndex
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

FreezeRowsAboveAndIncluding Method

This method freezes all Rows above (and including) the supplied Row. Note that if a cell belongs to both a frozen Row and frozen Column that it will not be scrollable in any direction.

Syntax

[Foundation.Export("freezeRowsAboveAndIncludingRow:")]
[System.Obsolete("Use NumberOfFrozenRows instead", false)]
public virtual void FreezeRowsAboveAndIncluding (SGridRow row)

Parameters

row
The Row that should be frozen, along with all Rows that appear above it in the grid.

Remarks

Obsolete: use ShinobiGrid.NumberOfFrozenRows instead

Requirements

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

HandleEditEventOnCell Method

Undocumented

Syntax

[Foundation.Export("handleEditEventOnCell:")]
public virtual void HandleEditEventOnCell (SGridCell cellToEdit)

Parameters

cellToEdit
Documentation for this section has not yet been entered.

Remarks

Handle an edit event on a grid cell. This method is called a cell is edited via a gesture. The gesture that fires this depends on `doubleTapEvent`. Subclass this method to provide your own implementation.

Requirements

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

HandleReorderEventOnCell Method

Undocumented

Syntax

[Foundation.Export("handleReorderEventOnCell:")]
public virtual void HandleReorderEventOnCell (SGridCell cellTriggeringReorder)

Parameters

cellTriggeringReorder
Documentation for this section has not yet been entered.

Remarks

Handle a reorder event on a grid cell. This method is called when a cell is reordered via a gesture. The default implementation will select a cell, ready for reordering. Subclass this method to provide your own implementation.

Requirements

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

HandleSelectionEventOnCell Method

Undocumented

Syntax

[Foundation.Export("handleSelectionEventOnCell:")]
public virtual void HandleSelectionEventOnCell (SGridCell cellToSelect)

Parameters

cellToSelect
Documentation for this section has not yet been entered.

Remarks

Handle a selection event on one or more cells. This method is called when one or more cells are selected via a gesture. The gesture that fires this depends on `singleTapEvent`. Subclass this method to provide your own implementation.

Requirements

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

Info Property

The version info for the grid

Syntax

[get: Foundation.Export("getInfo")]
public static string Info { get; }

Value

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

LicenseKey Property

Deprecated. Use ShinobiDataGrids.LicenseKey instead.

Syntax

[System.Obsolete("Use static ShinobiDataGrids.LicenseKey instead", false)]
[get: Foundation.Export("licenseKey", ObjCRuntime.ArgumentSemantic.Strong)]
[set: Foundation.Export("setLicenseKey:", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual string LicenseKey { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

The License Key for this Grid A valid license key must be set before the grid will render

Requirements

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

LinesOnTop Property

Controls the manner in which the gridlines are displayed in this grid. If this property is set to `SGridLinesVerticalOnTop` then the vertical gridlines will be drawn over the top of the horizontal gridlines. The opposite is true if this property is set to `SGridLinesHorizontalOnTop`.

Syntax

[get: Foundation.Export("linesOnTop", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setLinesOnTop:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual SGridLinesOnTop LinesOnTop { get; set; }

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

MinimumColWidth Property

If the grid cannot find a column width to use then it will try to calculate one to use.

Syntax

[System.Obsolete("Use DefaultColumnStyle.MinimumSize instead", false)]
[get: Foundation.Export("minimumColWidth", ObjCRuntime.ArgumentSemantic.Strong)]
[set: Foundation.Export("setMinimumColWidth:", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual Foundation.NSNumber MinimumColWidth { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

It does this by trying to fit every column into the width of the grid - this property dictates the minimum column width that will be used in this case and also applies to resizing columns via a pinch gesture.

Important: This method has been deprecated in preference of DefaultColumnStyle.MinimumSize.

Requirements

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

MinimumRowHeight Property

If the grid cannot find a row height to use then it will try to calculate one to use.

Syntax

[System.Obsolete("Use DefaultRowStyle.MinimumSize instead", false)]
[get: Foundation.Export("minimumRowHeight", ObjCRuntime.ArgumentSemantic.Strong)]
[set: Foundation.Export("setMinimumRowHeight:", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual Foundation.NSNumber MinimumRowHeight { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

It does this by trying to fit every row into the height of the grid - this property dictates the minimum row height that will be used in this case.

Important: This method has been deprecated in preference of DefaultRowStyle.MinimumSize.

Requirements

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

NumberOfColumns Method

Returns the total number of columns that the grid currently has.

Syntax

[Foundation.Export("numberOfColumns")]
public virtual nuint NumberOfColumns ()

Returns

Documentation for this section has not yet been entered.

Remarks

Requirements

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

NumberOfFrozenColumns Property

Property states how many columns should be frozen. The columns are frozen from the left hand side of the grid.

The default value is 0, which represents there being no frozen columns.

Syntax

[get: Foundation.Export("numberOfFrozenColumns", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setNumberOfFrozenColumns:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual nuint NumberOfFrozenColumns { get; set; }

Value

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

NumberOfFrozenRows Property

Property states how many rows should be frozen. The rows are frozen from the top of the grid downwards.

The default value is 0, which represents there being no frozen rows.

Syntax

[get: Foundation.Export("numberOfFrozenRows", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setNumberOfFrozenRows:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual nuint NumberOfFrozenRows { get; set; }

Value

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

NumberOfRows Method

Documentation for this section has not yet been entered.

Syntax

[Foundation.Export("numberOfRowsForSection:")]
public virtual nuint NumberOfRows (nint sectionIndex)

Parameters

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

NumberOfSections Method

Returns the number of sections that the grid currently has.

Syntax

[Foundation.Export("numberOfSections")]
public virtual nuint NumberOfSections ()

Returns

Documentation for this section has not yet been entered.

Remarks

Requirements

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

PreventSingleRowDeselection Property

Prevents single-row deselection. When the grid is in single-row selection mode, this will prevent the user from deselecting the selected row.

Defaults to NO.

Syntax

[get: Foundation.Export("preventSingleRowDeselection", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setPreventSingleRowDeselection:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual bool PreventSingleRowDeselection { get; set; }

Value

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

RedrawColsAtIndices Method

Redraws the specified columns. This causes the columns in question to have their styles rebuilt and reapplied (according to the grid's style heirarchy rules). This includes querying any delegate methods responsible for style. This method does not query the grid's data source.

Syntax

[Foundation.Export("redrawColsAtIndices:")]
public virtual void RedrawColsAtIndices (Foundation.NSNumber[] colIndices)

Parameters

colIndices
An array of NSNumber objects that represent the indices of the columns to be redrawn. The method intValue will be used to extract the index from each NSNumber object.

Remarks

Important: This does not update column widths or query number of rows, sections or columns. If you wish to update dimensions of the grid you must use ShinobiGrid.Reload.

Caution: This method will only work if called from the UI thread.

Requirements

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

RedrawRows Method

Redraws the specified rows. This causes the rows in question to have their styles rebuilt and reapplied (according to the grid's style heirarchy rules). This includes querying any delegate methods responsible for style. This method does not query the grid's data source.

Syntax

[Foundation.Export("redrawRows:")]
public virtual void RedrawRows (Foundation.NSValue[] rows)

Parameters

rows
An array of NSValue objects that contain SGridRow structs representing the rows to be redrawn.

Remarks

Important: This does not update row heights or query number of rows, sections or columns. If you wish to update dimensions of the grid you must use ShinobiGrid.Reload.

Caution: This method will only work if called from the UI thread.

Requirements

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

Reload Method

Reloads this ShinobiGrid object. Use this method to reload all the data that is used to construct the grid.

Syntax

[Foundation.Export("reload")]
public virtual void Reload ()

Remarks

Important: This is the only method from the Reload and Redraw variety that forces a recheck of column widths and row heights and is therefore the most expensive of these methods due to the need to reposition all grid elements.

Caution: This method will only work if called from the UI thread.

Requirements

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

ReloadColsAtIndices Method

Reloads the data for the columns at the specified indices. This forces a query of your data source for all visible rows in the columns at the supplied indices. This method also triggers a redraw of the specified columns as per ShinobiGrid.RedrawColsAtIndices(Foundation.NSNumber[]).

Syntax

[Foundation.Export("reloadColsAtIndices:")]
public virtual void ReloadColsAtIndices (Foundation.NSNumber[] colIndices)

Parameters

colIndices
An array of SDataGridColumn objects representing the columns to be redrawn.

Remarks

Important: This does not update column widths or query number of rows, sections or columns. If you wish to update dimensions of the grid you must use ShinobiGrid.Reload.

Caution: This method will only work if called from the UI thread.

Requirements

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

ReloadRows Method

Reloads the data for the specified rows. This forces a query of your data source for all visible columns in the supplied rows. This method also triggers a redraw of the specified rows as per ShinobiGrid.RedrawRows(Foundation.NSValue[]).

Syntax

[Foundation.Export("reloadRows:")]
public virtual void ReloadRows (Foundation.NSValue[] rows)

Parameters

rows
An array of NSValue objects that contain SGridRow structs representing the rows to be redrawn.

Remarks

Important: This does not update row heights or query number of rows, sections or columns. If you wish to update dimensions of the grid you must use ShinobiGrid.Reload.

Caution: This method will only work if called from the UI thread.

Requirements

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

RowStylesTakePriority Property

This boolean value dictates the course of action to take if conflicting Row and Column styles are found. If set to `true`, then the Row style will take priority over the Column style. If set to `false` then the oppostie is true. The default value is `false` (Column styles take priority by default). If you set the Row at index 0 to have a `BackgroundColor` of red, and the Column at index 0 to have a `backgroundColor` of blue, then the cell at `gridCoord` {0,0} is being told to have a `backgroundColor` of red and blue. Setting this property to true in this instance would mean that the Row style (red background) will be appled.

Syntax

[get: Foundation.Export("rowStylesTakePriority", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setRowStylesTakePriority:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual bool RowStylesTakePriority { get; set; }

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

SectionIsCollapsed Method

Documentation for this section has not yet been entered.

Syntax

[Foundation.Export("sectionAtIndexIsCollapsed:")]
public virtual bool SectionIsCollapsed (nuint index)

Parameters

index
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

SelectedCellGridCoords Method

Returns an array of grid coordinates of all the currently selected (and visible) cells. If no cells are currently selected then returns an empty array. Grid coordinates representing cells that are not visible are not returned.

Syntax

[Foundation.Export("selectedCellGridCoords")]
public virtual SGridCoord[] SelectedCellGridCoords ()

Returns

An array of SGridCoord objects that locate all the selected, visible cells in the grid.

Remarks

Documentation for this section has not yet been entered.

Requirements

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

SelectedRows Method

Return an array of NSValue objects that represent the currently selected rows in the grid.

Syntax

public SGridRow[] SelectedRows ()

Returns

An array of NSValue objects that encode SGridRow structs indicating the currently selected rows.

Remarks

Documentation for this section has not yet been entered.

Requirements

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

SelectionMode Property

Controls the cell selection mode of the grid.

Syntax

[get: Foundation.Export("selectionMode", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setSelectionMode:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual SGridSelectionMode SelectionMode { get; set; }

Value

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

SetRowSelected Method

Set an entire row in this grid as being selected/deselected. Using this method results in the on selecting/selected/deselecting/deselected delegate callback methods being called. The should select/deselect delegate callbacks will not be called.

Syntax

[Foundation.Export("setRow:asSelected:animated:")]
public virtual void SetRowSelected (SGridRow row, bool isSelected, bool animated)

Parameters

row
The row to set as selected/deselected.
isSelected
true if the row should be set as selected.
animated
true if this row's selection change should be animated.

Remarks

Important: Using this method ignores ShinobiGrid.SelectionMode, meaning that no automatic cell/row deselection will occur.

Requirements

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

SetSectionAsCollapsed Method

Documentation for this section has not yet been entered.

Syntax

[Foundation.Export("setSectionAtIndex:asCollapsed:")]
public virtual void SetSectionAsCollapsed (nuint index, bool collapsed)

Parameters

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

SetSelectedRows Method

Syntax

[Foundation.Export("setSelectedRows:")]
public virtual void SetSelectedRows (Foundation.NSValue[] newSelectedRows)

Parameters

newSelectedRows
An array of NSValue objects (that contain SGridRow structs) to be marked as 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

SetSelectedRows Method

Replaces the currently selected rows with a new array of selected rows. This results in all the currently selected rows being deselected, and then all the rows in newSelectedRows being set as selected by calling ShinobiGrid.SetRowSelected(SGridRow, bool, bool) on all of them.

Syntax

[Foundation.Export("setSelectedRows:animated:")]
public virtual void SetSelectedRows (Foundation.NSValue[] newSelectedRows, bool animated)

Parameters

newSelectedRows
An array of NSValue objects (that contain SGridRow structs) to be marked as selected.
animated
true if the clear of old selected rows and the selection of the new rows should be animated.

Remarks

Documentation for this section has not yet been entered.

Requirements

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

SingleTapEventMask Property

The type of event that the grid fires upon a single tap.

ShinobiGrids.SGridEvent is a bitmask, allowing you to specify multiple events for a single gesture. For example, SingleTapEventMask = SGridEvent.Select | SGridEvent.Edit will cause the grid to select and edit a cell on single tap.

The grid may be configured to use either select or edit a cell on a single tap. To disable the single tap gesture, set this property to SGridEvent.None.

Syntax

[get: Foundation.Export("singleTapEventMask")]
[set: Foundation.Export("setSingleTapEventMask:")]
public virtual SGridEvent SingleTapEventMask { get; set; }

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

TintColor Property

The color to use when tinting the grid, during a drag and drop operation. Defaults to null, for no tint color.

Syntax

[get: Foundation.Export("tintColor", ObjCRuntime.ArgumentSemantic.Strong)]
[set: Foundation.Export("setTintColor:", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual UIKit.UIColor TintColor { get; set; }

Value

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

VisibleCell Method

Documentation for this section has not yet been entered.

Syntax

[Foundation.Export("visibleCellAtCol:andRow:")]
public virtual SGridCell VisibleCell (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.

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

VisibleColumnIndexes Property

An array of column indexes. Each represents a currently visible column

Syntax

public nint[] VisibleColumnIndexes { get; }

Value

Remarks

Use this function to query which Columns are currently visible in the grid.

Requirements

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

VisibleRows Property

An array of ShinobiGrids.SGridRow objects. Each represents a currently visible Row

Syntax

public SGridRow[] VisibleRows { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Use this function to query which Rows are currently visible within the grid.

Requirements

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

WeakDelegate Property

The object that acts as the delegate of the receiving ShinobiGrid object.

Syntax

[get: Foundation.Export("delegate", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setDelegate:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public override Foundation.NSObject WeakDelegate { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

The delegate may be of any type, but should implement the whatever methods you require from those defined in SGridDelegate. They should also be attributed with the Foundation.Export attribute, using the Objective C selector names listed in the detailed API documentation for each method. The delegate is not retained.

Requirements

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