ShinobiControls Xamarin Bindings Documentation

ShinobiGrids : ShinobiGrids Namespace

SDataGridColumn Class

A class representing a column in a data grid.

Syntax

[Foundation.Register("SDataGridColumn", true)]
public class SDataGridColumn : Foundation.NSObject

Remarks

In order to render your data within the data-grid you need to add one or more columns of type SDataGridColumn. One of the most important functions of the columns is to specify the type of cells which are used. A cell must be a subclass of ShinobiGrids.SDataGridCell, which provides the basic functionality required by the data-grid for pooling, and other core features such as selection.

Each column also specifies the header text which is displayed at the top of each column: SDataGridColumn.Title. You can also specify the type of cell used for the header by setting the SDataGridColumn.HeaderCellType property.

A user can sort the rows of the data-grid by tapping on the column headers. The sort behaviour is specified on a per-column basis by setting the sortMode property. This can have the following values:

SDataGridColumnSortMode.None – This indicates that the data-grid cannot be sorted by the data within this column.

SDataGridColumnSortMode.BiState – This indicates that the data-grid can be sorted by the data within this column. When a column is in bi-state sort mode it toggles between an ascending and descending sort with each tap.

SDataGridColumnSortMode.TriState – This indicates that the data-grid can be sorted by the data within this column. When a column is in tri-state sort mode it iterates through the ascending, descending, and unsorted. A tri-state sort mode can be used for data that has a ‘natural’ sort order, allowing the user to sort the data-grid ascending or descending, then return it to its original sort order.

The current sort order for a column can be retrieved from its SDataGridColumn.SortOrder property. This can also be used to programmatically set the sort state of the data-grid. Column sorting is mutually exclusive, in other words, when the user taps to sort by a column, the other columns that are currently sorted have their SortOrder set to none. Changes in sort order can be detected by providing a delegate to the data-grid.

Requirements

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

Members

See Also: Inherited members from Foundation.NSObject.

Public Constructors

Default constructor
Returns an SDataGridColumn object with the specified title and a cell type of SDataGridTextCell.
Returns an SDataGridColumn object with the specified title and cell type.
Returns an SDataGridColumn object with the specified title, property Key and a cell type of SDataGridTextCell.
Wrapper around SDataGridColumn(string, ObjCRuntime.Class).
Returns an SDataGridColumn object with the specified title, named property, cell type and header cell type.
Wrapper around SDataGridColumn(string, string, ObjCRuntime.Class, ObjCRuntime.Class).

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

CanReorderViaLongPress bool . Controls if this column can be dragged and dropped via a long press on the header cell.
CanResizeViaPinch bool . Specifies whether or not this column is resizeable in response to a user's pinch gesture.
CellStyle SDataGridCellStyle . The style object that will be used for all cells associated with this column.
CellType ObjCRuntime.Class . Represents the cell type that this column will contain.
[read-only]
override
ClassHandle IntPtr . The handle for this class.
DisplayIndex nint . Represents the position that this column will be displayed at.
Editable bool . Dictates if the cells in this column are editable.
HeaderCellStyle SDataGridCellStyle . The style object that will be used for the header cell associated with this column.
HeaderCellType ObjCRuntime.Class . Represents the type of cell that will be used to populate the header row of this column.
MinimumWidth Foundation.NSNumber . The minimum width for this column.
PropertyKey string . The key to pass to the Delegate when using the ShinobiGrids.SDataGridDataSourceHelper.
SortMode SDataGridColumnSortMode . Controls how the SDataGridColumn.SortOrder changes when this column's header cell is tapped.
SortOrder SDataGridColumnSortOrder . Represents the current sort order of this column.
Tag nint . An integer that you can use to identify SDataGridColumn objects in your application.
Title string . The title belonging to this SDataGridColumn.
Width Foundation.NSNumber . Represents the width of this column.

Public Methods

static
Create (string) : SDataGridColumn
A convenience method that returns an SDataGridColumn object that has been added to the autorelease pool.
static
Create (string, ObjCRuntime.Class) : SDataGridColumn
A convenience method that returns an SDataGridColumn object that has been added to the autorelease pool.
static
Create (string, nuint) : SDataGridColumn
Documentation for this section has not yet been entered.
static
Create (string, string) : SDataGridColumn
A convenience method that returns an SDataGridColumn object that has been added to the autorelease pool.
static
Create (string, Type) : SDataGridColumn
Wrapper around SDataGridColumn.Create(string, ObjCRuntime.Class).
static
Create (string, string, ObjCRuntime.Class, ObjCRuntime.Class) : SDataGridColumn
A convenience method that returns an SDataGridColumn object that has been added to the autorelease pool.
static
Create (string, string, Type, Type) : SDataGridColumn
Wrapper around SDataGridColumn.Create(string, string, ObjCRuntime.Class, ObjCRuntime.Class).
HasCellType (ObjCRuntime.Class) : bool
Tests if this SDataGridColumn object has a specificed cell type.
HasCellType (Type) : bool
Wrapper around SDataGridColumn.HasCellType(ObjCRuntime.Class).
HasHeaderCellType (ObjCRuntime.Class) : bool
Same as SDataGridColumn.HasCellType(ObjCRuntime.Class) but for headerCellType.
HasHeaderCellType (Type) : bool
Wrapper around SDataGridColumn.HasHeaderCellType(ObjCRuntime.Class).
HeaderCell () : SDataGridHeaderCell
Provides access to the header cell for this column.

Protected Methods

override
Dispose (bool)
Releases unmanaged resources.

Member Details

SDataGridColumn Constructor

Default constructor

Syntax

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

Remarks

Documentation for this section has not yet been entered.

Requirements

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

SDataGridColumn Constructor

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

Syntax

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

SDataGridColumn Constructor

A constructor used when creating managed representations of unmanaged objects.

Syntax

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

SDataGridColumn Constructor

Returns an SDataGridColumn object with the specified title and a cell type of SDataGridTextCell.

Syntax

[Foundation.Export("initWithTitle:")]
public SDataGridColumn (string title)

Parameters

title
The text you wish to set as the header's text.

Remarks

Documentation for this section has not yet been entered.

Requirements

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

SDataGridColumn Constructor

Returns an SDataGridColumn object with the specified title and cell type.

Syntax

[Foundation.Export("initWithTitle:cellType:")]
public SDataGridColumn (string title, ObjCRuntime.Class cellType)

Parameters

title
The text you wish to set as the header's text.
cellType
The type of cells that this column will send to your data source method.

Remarks

Documentation for this section has not yet been entered.

Requirements

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

SDataGridColumn Constructor

Returns an SDataGridColumn object with the specified title, property Key and a cell type of SDataGridTextCell.

Syntax

[Foundation.Export("initWithTitle:forProperty:")]
public SDataGridColumn (string title, string propertyKey)

Parameters

title
The text you wish to set as the header's text.
propertyKey
The key to pass to the Delegate when using the ShinobiGrids.SDataGridDataSourceHelper.

Remarks

Documentation for this section has not yet been entered.

Requirements

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

SDataGridColumn Constructor

Syntax

public SDataGridColumn (string title, Type cellType)

Parameters

title
Documentation for this section has not yet been entered.
cellType
Documentation for this section has not yet been entered.

Remarks

Requirements

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

SDataGridColumn Constructor

Returns an SDataGridColumn object with the specified title, named property, cell type and header cell type.

Syntax

[Foundation.Export("initWithTitle:forProperty:cellType:headerCellType:")]
public SDataGridColumn (string title, string propertyKey, ObjCRuntime.Class cellType, ObjCRuntime.Class headerCellType)

Parameters

title
The text you wish to set as the header's text.
propertyKey
The key to pass to the Delegate when using the ShinobiGrids.SDataGridDataSourceHelper.
cellType
The type of cells that this column will send to your data source method.
headerCellType
The type of header cell that will be used for this column.

Remarks

Documentation for this section has not yet been entered.

Requirements

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

SDataGridColumn Constructor

Syntax

public SDataGridColumn (string title, string propertyKey, Type cellType, Type headerCellType)

Parameters

title
Documentation for this section has not yet been entered.
propertyKey
Documentation for this section has not yet been entered.
cellType
Documentation for this section has not yet been entered.
headerCellType
Documentation for this section has not yet been entered.

Remarks

Requirements

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

CanReorderViaLongPress Property

Controls if this column can be dragged and dropped via a long press on the header cell.

Syntax

[get: Foundation.Export("canReorderViaLongPress", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setCanReorderViaLongPress:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual bool CanReorderViaLongPress { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

If you wish to change how the dragging and dropping of rows works then see ShinobiDataGrid.CanReorderRows.

Requirements

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

CanResizeViaPinch Property

Specifies whether or not this column is resizeable in response to a user's pinch gesture.

Syntax

[get: Foundation.Export("canResizeViaPinch", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setCanResizeViaPinch:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual bool CanResizeViaPinch { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Defaults to false.

Requirements

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

CellStyle Property

The style object that will be used for all cells associated with this column.

Syntax

[get: Foundation.Export("cellStyle", ObjCRuntime.ArgumentSemantic.Strong)]
[set: Foundation.Export("setCellStyle:", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual SDataGridCellStyle CellStyle { 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

CellType Property

Represents the cell type that this column will contain.

Syntax

[get: Foundation.Export("cellType", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setCellType:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual ObjCRuntime.Class CellType { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

This controls the type of cell that will be returned to you in the datasource method SDataGridDataSource.PrepareCellForDisplay(ShinobiDataGrid, SDataGridCell). If you do not set this then the type ShinobiGrids.SDataGridCell will be assumed and set automatically.

Warning: The type used must be ShinobiGrids.SDataGridCell or a subclass.

Important: If you want to use a custom subclass of SDataGridCell, you will need to register the class and set up a binding for the constructor, like the following:
Example
[Register ("MyGridCell")]
public class MyGridCell : SDataGridCell
{
	[Export ("initWithReuseIdentifier:")]
	public MyGridCell(string identifier)
		: base(identifier)
	{
		//Your custom setup here
	}
}
This is required because the cells are created inside the native library, so we need to let the native code know about our managed class and how to create it.

Once you have created your custom class in this way, you can set the Cell Type in the following way:
Example
SDataGridColumn column = new SDataGridColumn("Title", "myPropertyKey");
column.CellType = new Class("MyGridCell");
Note that the name specified in the constructor of the Class object should match that specified in the Register attribute on your class, not the class name itself (if they differ).

Finally, if you are using a ShinobiGrids.SDataGridDataSourceHelper then be sure to implement the SDataGridDataSourceHelperDelegate.PopulateCell(SDataGridDataSourceHelper, SDataGridCell, Foundation.NSObject, string, Foundation.NSObject) method for your Delegate, so you can tell it how to populate your custom cells with data.

See the CreatingCustomCells sample project for a more detailed example.

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

Documentation for this section has not yet been entered.

Requirements

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

Create Method

A convenience method that returns an SDataGridColumn object that has been added to the autorelease pool.

Syntax

[Foundation.Export("columnWithTitle:")]
public static SDataGridColumn Create (string title)

Parameters

title
Documentation for this section has not yet been entered.

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

Create Method

A convenience method that returns an SDataGridColumn object that has been added to the autorelease pool.

Syntax

[Foundation.Export("columnWithTitle:cellType:")]
public static SDataGridColumn Create (string title, ObjCRuntime.Class cellType)

Parameters

title
Documentation for this section has not yet been entered.
cellType
Documentation for this section has not yet been entered.

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

Create Method

Documentation for this section has not yet been entered.

Syntax

[Foundation.Export("columnWithTitle:displayIndex:")]
public static SDataGridColumn Create (string title, nuint displayIndex)

Parameters

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

Create Method

A convenience method that returns an SDataGridColumn object that has been added to the autorelease pool.

Syntax

[Foundation.Export("columnWithTitle:forProperty:")]
public static SDataGridColumn Create (string title, string propertyKey)

Parameters

title
Documentation for this section has not yet been entered.
propertyKey
Documentation for this section has not yet been entered.

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

Create Method

Syntax

public static SDataGridColumn Create (string title, Type cellType)

Parameters

title
Documentation for this section has not yet been entered.
cellType
Documentation for this section has not yet been entered.

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

Create Method

A convenience method that returns an SDataGridColumn object that has been added to the autorelease pool.

Syntax

[Foundation.Export("columnWithTitle:forProperty:cellType:headerCellType:")]
public static SDataGridColumn Create (string title, string propertyKey, ObjCRuntime.Class cellType, ObjCRuntime.Class headerCellType)

Parameters

title
Documentation for this section has not yet been entered.
propertyKey
Documentation for this section has not yet been entered.
cellType
Documentation for this section has not yet been entered.
headerCellType
Documentation for this section has not yet been entered.

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

Create Method

Syntax

public static SDataGridColumn Create (string title, string propertyKey, Type cellType, Type headerCellType)

Parameters

title
Documentation for this section has not yet been entered.
propertyKey
Documentation for this section has not yet been entered.
cellType
Documentation for this section has not yet been entered.
headerCellType
Documentation for this section has not yet been entered.

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

DisplayIndex Property

Represents the position that this column will be displayed at.

Syntax

[get: Foundation.Export("displayIndex", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setDisplayIndex:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual nint DisplayIndex { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

This property takes precedence over the order in which you add the columns to the grid. A default value of NSNotFound is assigned when initializing a column. If NSNotFound is the displayIndex when this column is added to a grid then the count of the grid's current columns is automatically assigned to this property.

Warning: Note that display indices will be normalised. So setting display indices of {-101, 0, 0, 1, 2, -102, -1000} will result in normalised indices of {2, 3, 4, 5, 6, 1, 0}.

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

Editable Property

Dictates if the cells in this column are editable.

Syntax

[get: Foundation.Export("editable", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setEditable:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual bool Editable { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

true results in cells that are able to respond to edit events, otherwise the cells appearing in this column are not editable.

Note that implementing the delegate method SDataGridDelegate.ShouldBeginEditingCell(ShinobiDataGrid, SDataGridCoord) overrides this property.

Requirements

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

HasCellType Method

Tests if this SDataGridColumn object has a specificed cell type.

Syntax

[Foundation.Export("hasCellType:")]
public virtual bool HasCellType (ObjCRuntime.Class cellTypeToTest)

Parameters

cellTypeToTest
The type which this column will compare its cellType against.

Returns

bool that indicates if this column has (or inherits from) the specified type.

Remarks

Returns true if this column's cellType is the same as or inherits from cellTypeToTest. Otherwise returns false.

Requirements

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

HasCellType Method

Syntax

public bool HasCellType (Type cellType)

Parameters

cellType
Documentation for this section has not yet been entered.

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

HasHeaderCellType Method

Same as SDataGridColumn.HasCellType(ObjCRuntime.Class) but for headerCellType.

Syntax

[Foundation.Export("hasHeaderCellType:")]
public virtual bool HasHeaderCellType (ObjCRuntime.Class headerCellType)

Parameters

headerCellType
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

HasHeaderCellType Method

Syntax

public bool HasHeaderCellType (Type headerCellType)

Parameters

headerCellType
Documentation for this section has not yet been entered.

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

HeaderCell Method

Provides access to the header cell for this column.

Syntax

[Foundation.Export("headerCell")]
public virtual SDataGridHeaderCell HeaderCell ()

Returns

Documentation for this section has not yet been entered.

Remarks

Note that this method will only return a cell if the column in question is currently visible, otherwise null is returned.

Requirements

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

HeaderCellStyle Property

The style object that will be used for the header cell associated with this column.

Syntax

[get: Foundation.Export("headerCellStyle", ObjCRuntime.ArgumentSemantic.Strong)]
[set: Foundation.Export("setHeaderCellStyle:", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual SDataGridCellStyle HeaderCellStyle { 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

HeaderCellType Property

Represents the type of cell that will be used to populate the header row of this column.

Syntax

[get: Foundation.Export("headerCellType", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setHeaderCellType:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual ObjCRuntime.Class HeaderCellType { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

If you do not set this then the type ShinobiGrids.SDataGridHeaderCell will be assumed and used automatically.

Warning: The type used must be ShinobiGrids.SDataGridHeaderCell or a subclass.

For information on subclassing, see SDataGridColumn.CellType

Requirements

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

MinimumWidth Property

The minimum width for this column.

Syntax

[get: Foundation.Export("minimumWidth", ObjCRuntime.ArgumentSemantic.Strong)]
[set: Foundation.Export("setMinimumWidth:", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual Foundation.NSNumber MinimumWidth { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

This is used if auto-calculating the width of columns in the grid and when resizing the columns via a pinch gesture. Default for this property is null.

Requirements

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

PropertyKey Property

The key to pass to the Delegate when using the ShinobiGrids.SDataGridDataSourceHelper.

Syntax

[get: Foundation.Export("propertyKey", ObjCRuntime.ArgumentSemantic.Strong)]
[set: Foundation.Export("setPropertyKey:", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual string PropertyKey { 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

SortMode Property

Controls how the SDataGridColumn.SortOrder changes when this column's header cell is tapped.

Syntax

[get: Foundation.Export("sortMode", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setSortMode:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual SDataGridColumnSortMode SortMode { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

If set to SDataGridColumnSortMode.None, then sortOrder will never change from SDataGridColumnSortOrder.None as the user taps this column's header cell.

If set to SDataGridColumnSortMode.BiState, then this column will initially start with a default SortOrder of SDataGridColumnSortOrder.None and cycle between SDataGridColumnSortOrder.Ascending and SDataGridColumnSortOrder.Descending with each subsequent tap on this column's header cell.

If set to SDataGridColumnSortMode.TriState, then this column will initially start with a default SortOrder of SDataGridColumnSortOrder.None and cycle between SDataGridColumnSortOrder.Ascending, SDataGridColumnSortOrder.Descending and SDataGridColumnSortOrder.None with each subsequent tap on this column's header cell.

Requirements

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

SortOrder Property

Represents the current sort order of this column.

Syntax

[get: Foundation.Export("sortOrder", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setSortOrder:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual SDataGridColumnSortOrder SortOrder { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Tapping this column's header cell changes SortOrder according to the current SDataGridColumn.SortMode. Tapping this column's header cell will return all other columns within the owning grid to having a SortOrder of SDataGridColumnSortOrder.None. Default value is SDataGridColumnSortOrder.None.

Requirements

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

Tag Property

An integer that you can use to identify SDataGridColumn objects in your application.

Syntax

[get: Foundation.Export("tag")]
[set: Foundation.Export("setTag:")]
public virtual nint Tag { 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

Title Property

The title belonging to this SDataGridColumn.

Syntax

[get: Foundation.Export("title", ObjCRuntime.ArgumentSemantic.Strong)]
[set: Foundation.Export("setTitle:", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual string Title { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

This will be rendered in the SDataGrid's header row.

Requirements

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

Width Property

Represents the width of this column.

Syntax

[get: Foundation.Export("width", ObjCRuntime.ArgumentSemantic.Strong)]
[set: Foundation.Export("setWidth:", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual Foundation.NSNumber Width { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Setting null means some default width will be used by the grid. Default for this property is null.

Requirements

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