ShinobiControls Xamarin Bindings Documentation

ShinobiEssentials : Shinobi.Essentials Namespace

SEssentialsTheme Class

Theme for ShinobiEssentials.

Syntax

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

Remarks

The appearance of a ShinobiEssentials control is defined by its style object. The default settings of the style object are determined by the theme it is created with. A style object is always created with a theme, either one you set yourself, or the default global theme. The theme defines a set of generic properties, which individual style objects can then utilize for their specific needs. The properties defined are:

We also use the concept of decoration when configuring the look and feel of ShinobiEssentials controls. This refers to things such as shine, shadowing or chisel effects which are applied to the controls. In iOS7, we tend to turn off shine or shadowing effects, or at least make them a lot more subtle. In earlier versions of iOS, we use shine and shadowing effects to make items look more realistic. Chisel effects are applied in all versions of iOS, although again, they are more subtle in iOS7.

For more information on how the properties of a theme map to the properties of a specific style object, you should look at the API documentation for that style object. The available style objects are listed below:

Requirements

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

ActiveTintColor UIKit.UIColor . The color used for controls which have elements with an active state.
[read-only]
override
ClassHandle IntPtr . The handle for this class.
ElementStyle SEssentialsThemeElementStyle . The look and feel of sub-elements in each control will be affected by whether we are applying decoration to our control.
InactiveTintColor UIKit.UIColor . The color used for controls which have elements with an inactive state.
PrimaryDecorationTintColor UIKit.UIColor . This sets the primary color to use for decorations (e.g. the chisel on the sliding overlay).
PrimaryFont UIKit.UIFont . This sets the font used on controls which display text (e.g. the SEssentialsAccordion section title).
PrimaryTextColor UIKit.UIColor . This sets the font color of text used on controls.
PrimaryTexture UIKit.UIColor . This sets the texture used on the background of controls and is supplied as a UIColor.
PrimaryTintColor UIKit.UIColor . The color used behind the texture of controls.
SecondaryDecorationTintColor UIKit.UIColor . This sets the secondary color to use for decorations (e.g. the chisel on the sliding overlay).
SecondaryFont UIKit.UIFont . The alternative font to use for text display (e.g. tab header titles).
SecondaryTextColor UIKit.UIColor . This sets the secondary text color to use within controls.
SecondaryTexture UIKit.UIColor . This sets the texture on subviews of controls and is supplied as a UIColor.
SecondaryTintColor UIKit.UIColor . This sets the color used behind the texture on subviews of controls.
ShadowColor UIKit.UIColor . This sets the drop shadow color used on controls (e.g. underneath the sliding overlay's overlay, and the accordion drop shadow).
ShadowDepth nfloat . The depth of the drop shadow used on controls (e.g. underneath the sliding overlay's overlay, and the accordion drop shadow).
static
SharedTheme SEssentialsTheme . DEPRECATED: You should use ShinobiEssentials.Theme instead.
ShineColor UIKit.UIColor . This sets the shine color used on controls (e.g. toolbar shine on the sliding overlay, shine on progress indicators and accordion section headers).
TertiaryTintColor UIKit.UIColor . This sets the color used on controls that require a third themed color.

Public Methods

static
SetSharedTheme (SEssentialsTheme)
DEPRECATED: You should use ShinobiEssentials.Theme instead.

Protected Methods

override
Dispose (bool)
Releases unmanaged resources.

Member Details

SEssentialsTheme Constructor

Default constructor.

Syntax

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

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

SEssentialsTheme Constructor

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

Syntax

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

SEssentialsTheme Constructor

A constructor used when creating managed representations of unmanaged objects.

Syntax

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

ActiveTintColor Property

The color used for controls which have elements with an active state.

Syntax

[get: Foundation.Export("activeTintColor", ObjCRuntime.ArgumentSemantic.Strong)]
[set: Foundation.Export("setActiveTintColor:", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual UIKit.UIColor ActiveTintColor { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

An example of one of these controls would be the SEssentialsAccordion header. The pressed state of the header will use this color.

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

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

Documentation for this section has not yet been entered.

Requirements

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

ElementStyle Property

The look and feel of sub-elements in each control will be affected by whether we are applying decoration to our control.

Syntax

[get: Foundation.Export("elementStyle", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setElementStyle:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual SEssentialsThemeElementStyle ElementStyle { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

For example, in iOS7, we tend to not apply shading or shadowing, or at least use more subtle effects. In earlier versions of iOS, it is common to use shading and shadowing to give a more skeumorphic look. Sub-elements should reflect this. We currently provide two styles for sub-elements:
  • Flat. This is intended for use with iOS7 themes. Borders aren't applied around the edges of sub-elements, and shading effects are turned off.
  • Decorated. This is intended for use with earlier versions of iOS. Sub-elements are given shading and shadowing effects, and some elements will be given extra borders or chrome.

Requirements

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

InactiveTintColor Property

The color used for controls which have elements with an inactive state.

Syntax

[get: Foundation.Export("inactiveTintColor", ObjCRuntime.ArgumentSemantic.Strong)]
[set: Foundation.Export("setInactiveTintColor:", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual UIKit.UIColor InactiveTintColor { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

An example of one of these controls would be the progress indicators. The background track of the indicator will use this color.

Requirements

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

PrimaryDecorationTintColor Property

This sets the primary color to use for decorations (e.g. the chisel on the sliding overlay).

Syntax

[get: Foundation.Export("primaryDecorationTintColor", ObjCRuntime.ArgumentSemantic.Strong)]
[set: Foundation.Export("setPrimaryDecorationTintColor:", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual UIKit.UIColor PrimaryDecorationTintColor { 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

PrimaryFont Property

This sets the font used on controls which display text (e.g. the SEssentialsAccordion section title).

Syntax

[get: Foundation.Export("primaryFont", ObjCRuntime.ArgumentSemantic.Strong)]
[set: Foundation.Export("setPrimaryFont:", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual UIKit.UIFont PrimaryFont { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Individual controls will have styling options to control the font size.

Requirements

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

PrimaryTextColor Property

This sets the font color of text used on controls.

Syntax

[get: Foundation.Export("primaryTextColor", ObjCRuntime.ArgumentSemantic.Strong)]
[set: Foundation.Export("setPrimaryTextColor:", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual UIKit.UIColor PrimaryTextColor { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

e.g. SEssentialsAccordion section header font color, SEssentialTabbedView header font color.

Requirements

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

PrimaryTexture Property

This sets the texture used on the background of controls and is supplied as a UIColor.

Syntax

[get: Foundation.Export("primaryTexture", ObjCRuntime.ArgumentSemantic.Strong)]
[set: Foundation.Export("setPrimaryTexture:", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual UIKit.UIColor PrimaryTexture { get; set; }

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

PrimaryTintColor Property

The color used behind the texture of controls.

Syntax

[get: Foundation.Export("primaryTintColor", ObjCRuntime.ArgumentSemantic.Strong)]
[set: Foundation.Export("setPrimaryTintColor:", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual UIKit.UIColor PrimaryTintColor { get; set; }

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

SecondaryDecorationTintColor Property

This sets the secondary color to use for decorations (e.g. the chisel on the sliding overlay).

Syntax

[get: Foundation.Export("secondaryDecorationTintColor", ObjCRuntime.ArgumentSemantic.Strong)]
[set: Foundation.Export("setSecondaryDecorationTintColor:", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual UIKit.UIColor SecondaryDecorationTintColor { 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

SecondaryFont Property

The alternative font to use for text display (e.g. tab header titles).

Syntax

[get: Foundation.Export("secondaryFont", ObjCRuntime.ArgumentSemantic.Strong)]
[set: Foundation.Export("setSecondaryFont:", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual UIKit.UIFont SecondaryFont { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

If none is provided, the PrimaryFont will be used instead.

Requirements

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

SecondaryTextColor Property

This sets the secondary text color to use within controls.

Syntax

[get: Foundation.Export("secondaryTextColor", ObjCRuntime.ArgumentSemantic.Strong)]
[set: Foundation.Export("setSecondaryTextColor:", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual UIKit.UIColor SecondaryTextColor { 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

SecondaryTexture Property

This sets the texture on subviews of controls and is supplied as a UIColor.

Syntax

[get: Foundation.Export("secondaryTexture", ObjCRuntime.ArgumentSemantic.Strong)]
[set: Foundation.Export("setSecondaryTexture:", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual UIKit.UIColor SecondaryTexture { get; set; }

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

SecondaryTintColor Property

This sets the color used behind the texture on subviews of controls.

Syntax

[get: Foundation.Export("secondaryTintColor", ObjCRuntime.ArgumentSemantic.Strong)]
[set: Foundation.Export("setSecondaryTintColor:", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual UIKit.UIColor SecondaryTintColor { get; set; }

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

SetSharedTheme Method

DEPRECATED: You should use ShinobiEssentials.Theme instead.

Syntax

[System.Obsolete("Use ShinobiEssentials.Theme instead")]
public static void SetSharedTheme (SEssentialsTheme theme)

Parameters

theme
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

ShadowColor Property

This sets the drop shadow color used on controls (e.g. underneath the sliding overlay's overlay, and the accordion drop shadow).

Syntax

[get: Foundation.Export("shadowColor", ObjCRuntime.ArgumentSemantic.Strong)]
[set: Foundation.Export("setShadowColor:", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual UIKit.UIColor ShadowColor { 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

ShadowDepth Property

The depth of the drop shadow used on controls (e.g. underneath the sliding overlay's overlay, and the accordion drop shadow).

Syntax

[get: Foundation.Export("shadowDepth", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setShadowDepth:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual nfloat ShadowDepth { 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

SharedTheme Property

DEPRECATED: You should use ShinobiEssentials.Theme instead.

Syntax

[System.Obsolete("Use ShinobiEssentials.Theme instead", false)]
[get: Foundation.Export("sharedTheme")]
[set: Foundation.Export("setSharedTheme:")]
public static SEssentialsTheme SharedTheme { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

The default theme used by all controls is a singleton accessed through this method. When the properties on this are updated all dependent controls will update unless their styles have explicitly set values. By default this is initialized to SEssentialsDarkTheme. The default theme can be changed completely here and all dependent controls will update.

Requirements

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

ShineColor Property

This sets the shine color used on controls (e.g. toolbar shine on the sliding overlay, shine on progress indicators and accordion section headers).

Syntax

[get: Foundation.Export("shineColor", ObjCRuntime.ArgumentSemantic.Strong)]
[set: Foundation.Export("setShineColor:", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual UIKit.UIColor ShineColor { 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

TertiaryTintColor Property

This sets the color used on controls that require a third themed color.

Syntax

[get: Foundation.Export("tertiaryTintColor", ObjCRuntime.ArgumentSemantic.Strong)]
[set: Foundation.Export("setTertiaryTintColor:", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual UIKit.UIColor TertiaryTintColor { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

e.g. the button in the SEssentialsSlidingOverlay.

Requirements

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