ShinobiControls Xamarin Bindings Documentation

ShinobiGrids : ShinobiGrids Namespace

SDataGridTheme Class

A data-grid theme can set the initial styling properties of a data-grid for you to further customize if you wish.

Syntax

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

Remarks

The data-grid comes with four preset themes and any data-grid that is rendered will ask the theme for the current set of colors and styles.

The four themes are:

The default theme is iOS theme for iOS 6 and older devices, and iOS 7 for iOS 7 and newer. To change the theme that a data-grid is using, you can use the ShinobiDataGrid.ApplyTheme(SDataGridTheme) method. You can create particular themes by using the SDataGridTheme subclasses, SDataGridiOSTheme, SDataGridiOS7Theme, SDataGridLightTheme and SDataGridDarkTheme.
Example
myGrid.ApplyTheme(new SDataGridDarkTheme());

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.

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

AlternateRowStyle SDataGridCellStyle . The default style applied to rows when this theme is set initially.
[read-only]
override
ClassHandle IntPtr . The handle for this class.
GridLineStyle SDataGridLineStyle . The default style applied to grid lines.
HeaderRowStyle SDataGridCellStyle . The default style applied to cells in the header row.
HideVerticalGridlines bool . A bool controlling whether vertical grid lines are hidden in this theme.
IOS7Arrows bool . A bool controlling whether iOS 7 arrows are used in this theme.
RowStyle SDataGridCellStyle . The default style applied to rows when this theme is set initially.
SectionHeaderStyle SDataGridSectionHeaderStyle . The default style applied to the section header.
SelectedCellStyle SDataGridCellStyle . The default style applied to selected cells when this theme is set initially.
TintColor UIKit.UIColor . A UIColor representing the tint color while the grid is reordering, in this theme.

Public Methods

static
DefaultAlternateRowStyle () : SDataGridCellStyle
The default style applied to rows when this theme is set initially.
static
DefaultAlternatingRowStyle () : SDataGridCellStyle
This property has been deprecated in preference of SDataGridTheme.DefaultAlternateRowStyle.
static
DefaultGridLineStyle () : SDataGridLineStyle
The default style applied to grid lines.
static
DefaultHeaderRowStyle () : SDataGridCellStyle
The default style applied to cells in the header row.
static
DefaultRowStyle () : SDataGridCellStyle
The default style applied to rows when this theme is set initially.
static
DefaultSectionHeaderStyle () : SDataGridSectionHeaderStyle
The default style applied to the section header.
static
DefaultSelectedCellStyle () : SDataGridCellStyle
The default style applied to selected cells when this theme is set initially.
static
InitialTheme () : SDataGridInitialTheme
Get the theme styling that all new data-grids will be created with.
static
InitialThemeCellBackgroundColor () : UIKit.UIColor
A UIColor representing the background color set for cells in this theme.
static
InitialThemeCellBackgroundColorAlternate () : UIKit.UIColor
A UIColor representing the background color set for cells in this theme.
static
InitialThemeCellSelectionColor () : UIKit.UIColor
A UIColor representing the background color set for selected cells in this theme.
static
InitialThemeHeaderCellColor () : UIKit.UIColor
A UIColor representing the background color set for header cells in this theme.
static
InitialThemeSectionHeaderBackgroundColor () : UIKit.UIColor
A UIColor representing the fill color set for section headers in this theme.
static
InitialThemeSectionHeaderFontColor () : UIKit.UIColor
A UIColor representing the font color set for section headers in this theme.
static
SetInitialTheme (SDataGridInitialTheme)
Sets the theme styling that all new data-grids will be created with.

Protected Methods

override
Dispose (bool)
Releases unmanaged resources.

Member Details

SDataGridTheme Constructor

Default constructor.

Syntax

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

Remarks

Requirements

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

SDataGridTheme Constructor

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

Syntax

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

SDataGridTheme Constructor

A constructor used when creating managed representations of unmanaged objects.

Syntax

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

AlternateRowStyle Property

The default style applied to rows when this theme is set initially.

Syntax

[get: Foundation.Export("alternateRowStyle", ObjCRuntime.ArgumentSemantic.Strong)]
[set: Foundation.Export("setAlternateRowStyle:", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual SDataGridCellStyle AlternateRowStyle { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Note: this is the alternate row styling, see also RowStyle.

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

DefaultAlternateRowStyle Method

The default style applied to rows when this theme is set initially.

Syntax

[Foundation.Export("defaultAlternateRowStyle")]
public static SDataGridCellStyle DefaultAlternateRowStyle ()

Returns

Documentation for this section has not yet been entered.

Remarks

Note: this is the alternate row styling, see also SDataGridTheme.DefaultRowStyle.

Requirements

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

DefaultAlternatingRowStyle Method

This property has been deprecated in preference of SDataGridTheme.DefaultAlternateRowStyle.

Syntax

[Foundation.Export("defaultAlternatingRowStyle")]
[System.Obsolete("Use DefaultAlternateRowStyle instead", false)]
public static SDataGridCellStyle DefaultAlternatingRowStyle ()

Returns

Documentation for this section has not yet been entered.

Remarks

The default style applied to rows when this theme is set initially. Note: this is the alternate row styling, see also DefaultRowStyle.

Requirements

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

DefaultGridLineStyle Method

The default style applied to grid lines.

Syntax

[Foundation.Export("defaultGridLineStyle")]
public static SDataGridLineStyle DefaultGridLineStyle ()

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

DefaultHeaderRowStyle Method

The default style applied to cells in the header row.

Syntax

[Foundation.Export("defaultHeaderRowStyle")]
public static SDataGridCellStyle DefaultHeaderRowStyle ()

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

DefaultRowStyle Method

The default style applied to rows when this theme is set initially.

Syntax

[Foundation.Export("defaultRowStyle")]
public static SDataGridCellStyle DefaultRowStyle ()

Returns

Documentation for this section has not yet been entered.

Remarks

Note: alternate row styling may be configured see SDataGridTheme.DefaultAlternateRowStyle.

Requirements

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

DefaultSectionHeaderStyle Method

The default style applied to the section header.

Syntax

[Foundation.Export("defaultSectionHeaderStyle")]
public static SDataGridSectionHeaderStyle DefaultSectionHeaderStyle ()

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

DefaultSelectedCellStyle Method

The default style applied to selected cells when this theme is set initially.

Syntax

[Foundation.Export("defaultSelectedCellStyle")]
public static SDataGridCellStyle DefaultSelectedCellStyle ()

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

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

GridLineStyle Property

The default style applied to grid lines.

Syntax

[get: Foundation.Export("gridLineStyle", ObjCRuntime.ArgumentSemantic.Strong)]
[set: Foundation.Export("setGridLineStyle:", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual SDataGridLineStyle GridLineStyle { 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

HeaderRowStyle Property

The default style applied to cells in the header row.

Syntax

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

HideVerticalGridlines Property

A bool controlling whether vertical grid lines are hidden in this theme.

Syntax

[get: Foundation.Export("hideVerticalGridlines", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setHideVerticalGridlines:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual bool HideVerticalGridlines { 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

InitialTheme Method

Get the theme styling that all new data-grids will be created with.

Syntax

[Foundation.Export("initialTheme")]
public static SDataGridInitialTheme InitialTheme ()

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

InitialThemeCellBackgroundColor Method

A UIColor representing the background color set for cells in this theme.

Syntax

[Foundation.Export("initialThemeCellBackgroundColor")]
public static UIKit.UIColor InitialThemeCellBackgroundColor ()

Returns

Documentation for this section has not yet been entered.

Remarks

Note: alternate row styling may be configured see SDataGridTheme.InitialThemeCellBackgroundColorAlternate.

Requirements

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

InitialThemeCellBackgroundColorAlternate Method

A UIColor representing the background color set for cells in this theme.

Syntax

[Foundation.Export("initialThemeCellBackgroundColorAlternate")]
public static UIKit.UIColor InitialThemeCellBackgroundColorAlternate ()

Returns

Documentation for this section has not yet been entered.

Remarks

Note: this is the alternate color, see also SDataGridTheme.InitialThemeCellBackgroundColor.

Requirements

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

InitialThemeCellSelectionColor Method

A UIColor representing the background color set for selected cells in this theme.

Syntax

[Foundation.Export("initialThemeCellSelectionColor")]
public static UIKit.UIColor InitialThemeCellSelectionColor ()

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

InitialThemeHeaderCellColor Method

A UIColor representing the background color set for header cells in this theme.

Syntax

[Foundation.Export("initialThemeHeaderCellColor")]
public static UIKit.UIColor InitialThemeHeaderCellColor ()

Returns

Documentation for this section has not yet been entered.

Remarks

Note: header cells are defined per SDataGridColumn.

Requirements

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

InitialThemeSectionHeaderBackgroundColor Method

A UIColor representing the fill color set for section headers in this theme.

Syntax

[Foundation.Export("initialThemeSectionHeaderBackgroundColor")]
public static UIKit.UIColor InitialThemeSectionHeaderBackgroundColor ()

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

InitialThemeSectionHeaderFontColor Method

A UIColor representing the font color set for section headers in this theme.

Syntax

[Foundation.Export("initialThemeSectionHeaderFontColor")]
public static UIKit.UIColor InitialThemeSectionHeaderFontColor ()

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

IOS7Arrows Property

A bool controlling whether iOS 7 arrows are used in this theme.

Syntax

[get: Foundation.Export("iOS7Arrows", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setIOS7Arrows:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual bool IOS7Arrows { 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

RowStyle Property

The default style applied to rows when this theme is set initially.

Syntax

[get: Foundation.Export("rowStyle", ObjCRuntime.ArgumentSemantic.Strong)]
[set: Foundation.Export("setRowStyle:", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual SDataGridCellStyle RowStyle { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Note: alternate row styling may be configured see AlternateRowStyle.

Requirements

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

SectionHeaderStyle Property

The default style applied to the section header.

Syntax

[get: Foundation.Export("sectionHeaderStyle", ObjCRuntime.ArgumentSemantic.Strong)]
[set: Foundation.Export("setSectionHeaderStyle:", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual SDataGridSectionHeaderStyle SectionHeaderStyle { 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

SelectedCellStyle Property

The default style applied to selected cells when this theme is set initially.

Syntax

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

SetInitialTheme Method

Sets the theme styling that all new data-grids will be created with.

Syntax

[Foundation.Export("setInitialTheme:")]
public static void SetInitialTheme (SDataGridInitialTheme theme)

Parameters

theme
The theme to use.

Remarks

Only applies to data-grids that are created after this is set.

Using ShinobiDataGrid.ApplyTheme(SDataGridTheme) is now preferred over this static method.

Requirements

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

TintColor Property

A UIColor representing the tint color while the grid is reordering, in this theme.

Syntax

[get: Foundation.Export("tintColor", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setTintColor:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual UIKit.UIColor TintColor { 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