ShinobiControls Xamarin Bindings Documentation

ShinobiEssentials : Shinobi.Essentials Namespace

ShinobiEssentials Class

A global utility class for the ShinobiEssentials framework.

Syntax

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

Remarks

It allows you to do the following:

All controls by default use the global theme. To access this theme and set one of its values you would use the following code:
Example
SEssentialsTheme globalTheme = ShinobiEssentials.Theme;
If you wish to change the current global theme then use:
Example
ShinobiEssentials.Theme = new SEssentialsDarkTheme();
To change the primary tint color on all controls using the theme you would use the following code:
Example
globalTheme.PrimaryTintColor = UIColor.Red;

Once you've updated the theme, you should go through all your controls and call ApplyTheme on them, to configure them from the theme.

Requirements

Namespace: Shinobi.Essentials
Assembly: ShinobiEssentials (in ShinobiEssentials.dll)
Assembly Versions: 2.8.0.4

Members

See Also: Inherited members from Foundation.NSObject.

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

[read-only]
override
ClassHandle IntPtr . The handle for this class.
[read-only]
static
Info string . Returns a string describing the version of the ShinobiEssentials framework being used.
static
Theme SEssentialsTheme . The global theme, which is used by default when creating any new ShinobiEssentials controls.

Public Methods

static
SetLicenseKey (string)
Sets the license key for the trial version of the ShinobiEssentials framework.
static
VerifyLicenseKey ()
Verifies the license key.

Member Details

ShinobiEssentials Constructor

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

Syntax

[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)]
protected ShinobiEssentials (Foundation.NSObjectFlag t)

Parameters

t
Unused sentinel value

Remarks

You should not invoke this method directly.

Requirements

Namespace: Shinobi.Essentials
Assembly: ShinobiEssentials (in ShinobiEssentials.dll)
Assembly Versions: 2.8.0.4

ShinobiEssentials Constructor

A constructor used when creating managed representations of unmanaged objects.

Syntax

[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)]
protected ShinobiEssentials (IntPtr handle)

Parameters

handle
Handle of the unmanaged object

Remarks

You should not invoke this method directly.

Requirements

Namespace: Shinobi.Essentials
Assembly: ShinobiEssentials (in ShinobiEssentials.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: Shinobi.Essentials
Assembly: ShinobiEssentials (in ShinobiEssentials.dll)
Assembly Versions: 2.8.0.4

Info Property

Returns a string describing the version of the ShinobiEssentials framework being used.

Syntax

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

Value

Documentation for this section has not yet been entered.

Remarks

This includes a version number, the type of framework (Standard, or Trial) and the date upon which the version was released.

Requirements

Namespace: Shinobi.Essentials
Assembly: ShinobiEssentials (in ShinobiEssentials.dll)
Assembly Versions: 2.8.0.4

SetLicenseKey Method

Sets the license key for the trial version of the ShinobiEssentials framework.

Syntax

[Foundation.Export("setLicenseKey:")]
public static void SetLicenseKey (string licenseKey)

Parameters

licenseKey

Remarks

You will be emailed the license key when you download the framework.

Requirements

Namespace: Shinobi.Essentials
Assembly: ShinobiEssentials (in ShinobiEssentials.dll)
Assembly Versions: 2.8.0.4

Theme Property

The global theme, which is used by default when creating any new ShinobiEssentials controls.

Syntax

[get: Foundation.Export("theme")]
[set: Foundation.Export("setTheme:")]
public static SEssentialsTheme Theme { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Requirements

Namespace: Shinobi.Essentials
Assembly: ShinobiEssentials (in ShinobiEssentials.dll)
Assembly Versions: 2.8.0.4

VerifyLicenseKey Method

Verifies the license key.

Syntax

[Foundation.Export("verifyLicenseKey")]
public static void VerifyLicenseKey ()

Remarks

Each control in the framework does this when they are initialized.

Requirements

Namespace: Shinobi.Essentials
Assembly: ShinobiEssentials (in ShinobiEssentials.dll)
Assembly Versions: 2.8.0.4