ShinobiControls Xamarin Bindings Documentation

ShinobiEssentials : Shinobi.Essentials Namespace

SEssentialsSlidingOverlay Class

The SEssentialsSlidingOverlay class represents two UIViews, one of which slides over the other, to reveal it.

Syntax

[Foundation.Register("SEssentialsSlidingOverlay", true)]
public class SEssentialsSlidingOverlay : UIKit.UIView

Remarks

This saves screen real-estate by hiding content behind the main view and animating it in when required.

The SEssentialsSlidingOverlay.Underlay may be exposed from left, right, top or bottom of the main content view, which will feel like it is sliding (not shrinking) to expose the SEssentialsSlidingOverlay.Underlay. The SEssentialsSlidingOverlay.Underlay is the full height (left or right side) or full width (top or bottom) and its other dimension is a variable percentage of the SEssentialsSlidingOverlay.Overlay.

The sliding overlay has a style object, which is an instance of SEssentialsSlidingOverlayStyle. This manages the look and feel of the control by setting things like the tint color and background texture of the underlay and the overlay. The style object should always be used to update the look of the control, rather than accessing the underlay or overlay and setting their properties directly.

The style has precedence over any visual changes which are made to the sliding overlay directly. For example, if you were to set a property such as the tintColor on the underlay directly, this change will be overridden next time the style is updated. That is why it is important to use the style to manage the look and feel of the control.

Requirements

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

Members

See Also: Inherited members from UIKit.UIView.

Public Constructors

Default constructor.
Initialize the overlay with a frame. Toolbar is on by default.
A constructor that initializes the object from the data stored in the unarchiver object.
Initialize the overlay with a frame and specify whether a toolbar should be displayed
Initialize the overlay with a frame and specify whether a toolbar should be displayed and supply a style

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

AnimationCurve UIKit.UIViewAnimationCurve . The animation's curve, see UIViewAnimationCurve. This animation curve defines the way the subview slides in and out of view.
AnimationDuration nfloat . The duration, in seconds, over which the animation should take place
[read-only]
override
ClassHandle IntPtr . The handle for this class.
Delegate SEssentialsSlidingOverlayDelegate . The delegate for the SEssentialsSlidingOverlay
GestureAreaRatio nfloat . A value describing the area where the user can perform a gesture to reveal the subview.
GestureRecognizer UIKit.UIGestureRecognizer . A gesture recognizer.
[read-only]
Overlay SEssentialsView . The Overlay, which slides over to reveal the SEssentialsSlidingOverlay.Underlay - add subviews to this as necessary
[read-only]
Style SEssentialsSlidingOverlayStyle . The style object used to style the overlay and underlay.
[read-only]
Toolbar SEssentialsSlidingOverlayToolbar . Toolbar property - using this the toolbar can be changed or removed
[read-only]
Underlay SEssentialsView . The hidden view, which the SEssentialsSlidingOverlay.Overlay slides over to reveal - add subviews to this as necessary
UnderlayLocation SEssentialsSlidingOverlayLocation . The location of the SEssentialsSlidingOverlay.Underlay - the SEssentialsSlidingOverlay.Overlay slides out to reveal the SEssentialsSlidingOverlay.Underlay anchored in this direction.
UnderlayRevealAmount nfloat . The size of the underlay
UnderlaySizeType SEssentialsUnderlaySizeType . The method used to define the size of the underlay.
WeakDelegate Foundation.NSObject . A weakly typed delegate for the SEssentialsSlidingOverlay

Public Methods

ApplyTheme (SEssentialsTheme)
Applies the specified theme to the sliding overlay.
HideUnderlay (bool)
Hide the SEssentialsSlidingOverlay.Underlay, specifying animation
SetUnderlayLocation (SEssentialsSlidingOverlayLocation, bool)
The location of the SEssentialsSlidingOverlay.Underlay - the SEssentialsSlidingOverlay.Overlay slides out to reveal the SEssentialsSlidingOverlay.Underlay anchored in this direction.
ShowUnderlay (bool)
Show the SEssentialsSlidingOverlay.Underlay, specifying animation
ToggleUnderlay (bool)
Toggle the SEssentialsSlidingOverlay.Underlay's visibility, causing the SEssentialsSlidingOverlay.Overlay to slide over, revealing or concealing it.
UnderlayHidden () : bool
A boolean indicating whether the SEssentialsSlidingOverlay.Underlay is currently hidden

Protected Methods

override
Dispose (bool)
Releases unmanaged resources.

Member Details

SEssentialsSlidingOverlay Constructor

Default constructor.

Syntax

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

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

SEssentialsSlidingOverlay Constructor

Initialize the overlay with a frame. Toolbar is on by default.

Syntax

[Foundation.Export("initWithFrame:")]
public SEssentialsSlidingOverlay (CoreGraphics.CGRect frame)

Parameters

frame
The frame rectangle

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

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

SEssentialsSlidingOverlay Constructor

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

Syntax

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

SEssentialsSlidingOverlay Constructor

A constructor used when creating managed representations of unmanaged objects.

Syntax

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

SEssentialsSlidingOverlay Constructor

Initialize the overlay with a frame and specify whether a toolbar should be displayed

Syntax

[Foundation.Export("initWithFrame:andToolbar:")]
public SEssentialsSlidingOverlay (CoreGraphics.CGRect frame, bool showToolbar)

Parameters

frame
The frame rectangle
showToolbar
Whether a toolbar should be displayed

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

SEssentialsSlidingOverlay Constructor

Initialize the overlay with a frame and specify whether a toolbar should be displayed and supply a style

Syntax

[Foundation.Export("initWithFrame:andToolbar:style:")]
public SEssentialsSlidingOverlay (CoreGraphics.CGRect frame, bool showToolbar, SEssentialsSlidingOverlayStyle style)

Parameters

frame
The frame rectangle
showToolbar
Whether a toolbar should be displayed
style
The style

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

AnimationCurve Property

The animation's curve, see UIViewAnimationCurve. This animation curve defines the way the subview slides in and out of view.

Syntax

[get: Foundation.Export("animationCurve", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setAnimationCurve:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual UIKit.UIViewAnimationCurve AnimationCurve { 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

AnimationDuration Property

The duration, in seconds, over which the animation should take place

Syntax

[get: Foundation.Export("animationDuration", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setAnimationDuration:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual nfloat AnimationDuration { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Defaults to 0.25.

Requirements

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

ApplyTheme Method

Applies the specified theme to the sliding overlay.

Syntax

[Foundation.Export("applyTheme:")]
public virtual void ApplyTheme (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

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

Delegate Property

The delegate for the SEssentialsSlidingOverlay

Syntax

public SEssentialsSlidingOverlayDelegate Delegate { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Important. It is your responsibility to hold a reference to your delegate (if it is a separate object), to avoid it being garbage collected. This property does not do this for you (unlike most properties in the API) to match the behavior of the native code.

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

GestureAreaRatio Property

A value describing the area where the user can perform a gesture to reveal the subview.

Syntax

[get: Foundation.Export("gestureAreaRatio", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setGestureAreaRatio:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual nfloat GestureAreaRatio { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

This is a fraction between 0.0 and 1.0. This represents a fraction of the control's width or height (Defaults to 0.5)

Requirements

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

GestureRecognizer Property

A gesture recognizer.

Syntax

[get: Foundation.Export("gestureRecognizer", ObjCRuntime.ArgumentSemantic.Strong)]
[set: Foundation.Export("setGestureRecognizer:", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual UIKit.UIGestureRecognizer GestureRecognizer { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Using this the gesture recognizer can be disabled or changed completely. This is a swipe gesture by default and, unless overridden, the swipe direction is updated to keep in sync with the underlay location

Requirements

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

HideUnderlay Method

Hide the SEssentialsSlidingOverlay.Underlay, specifying animation

Syntax

[Foundation.Export("hideUnderlayAnimated:")]
public virtual void HideUnderlay (bool animate)

Parameters

animate
Whether the operation is animated

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

Overlay Property

The Overlay, which slides over to reveal the SEssentialsSlidingOverlay.Underlay - add subviews to this as necessary

Syntax

[get: Foundation.Export("overlay")]
public virtual SEssentialsView Overlay { 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

SetUnderlayLocation Method

The location of the SEssentialsSlidingOverlay.Underlay - the SEssentialsSlidingOverlay.Overlay slides out to reveal the SEssentialsSlidingOverlay.Underlay anchored in this direction.

Syntax

[Foundation.Export("setUnderlayLocation:animated:")]
public virtual void SetUnderlayLocation (SEssentialsSlidingOverlayLocation newLocation, bool animated)

Parameters

newLocation
The location to which the underlay should be moved.
animated
Specify true for the location change to be animated.

Remarks

This method allows the location to be set with or without animating from the current state to the new state.

Requirements

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

ShowUnderlay Method

Show the SEssentialsSlidingOverlay.Underlay, specifying animation

Syntax

[Foundation.Export("showUnderlayAnimated:")]
public virtual void ShowUnderlay (bool animate)

Parameters

animate
Whether the operation is animated

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

Style Property

The style object used to style the overlay and underlay.

Syntax

[get: Foundation.Export("style", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual SEssentialsSlidingOverlayStyle Style { 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

ToggleUnderlay Method

Toggle the SEssentialsSlidingOverlay.Underlay's visibility, causing the SEssentialsSlidingOverlay.Overlay to slide over, revealing or concealing it.

Syntax

[Foundation.Export("toggleUnderlayAnimated:")]
public virtual void ToggleUnderlay (bool animate)

Parameters

animate
Whether the operation is animated

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

Toolbar Property

Toolbar property - using this the toolbar can be changed or removed

Syntax

[get: Foundation.Export("toolbar")]
public virtual SEssentialsSlidingOverlayToolbar Toolbar { 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

Underlay Property

The hidden view, which the SEssentialsSlidingOverlay.Overlay slides over to reveal - add subviews to this as necessary

Syntax

[get: Foundation.Export("underlay")]
public virtual SEssentialsView Underlay { 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

UnderlayHidden Method

A boolean indicating whether the SEssentialsSlidingOverlay.Underlay is currently hidden

Syntax

[Foundation.Export("underlayHidden")]
public virtual bool UnderlayHidden ()

Returns

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

UnderlayLocation Property

The location of the SEssentialsSlidingOverlay.Underlay - the SEssentialsSlidingOverlay.Overlay slides out to reveal the SEssentialsSlidingOverlay.Underlay anchored in this direction.

Syntax

[get: Foundation.Export("underlayLocation", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setUnderlayLocation:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual SEssentialsSlidingOverlayLocation UnderlayLocation { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Setting this property will result in the change being animated. Use SEssentialsSlidingOverlay.SetUnderlayLocation(SEssentialsSlidingOverlayLocation, bool) to control this.

Requirements

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

UnderlayRevealAmount Property

The size of the underlay

Syntax

[get: Foundation.Export("underlayRevealAmount", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setUnderlayRevealAmount:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual nfloat UnderlayRevealAmount { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Defaults to 0.25.

If SEssentialsSlidingOverlay.UnderlaySizeType is set to SEssentialsUnderlaySizeType.Pixel then UnderlayRevealAmount defines the size of the underlay in pixels. This is a value between 0.0 and the width/height of the sliding overlay.

If SEssentialsSlidingOverlay.UnderlaySizeType is set to SEssentialsUnderlaySizeType.Ratio then UnderlayRevealAmount defines the size of the underlay as a proportion of the view. In this case, the value should be between 0.0 and 1.0.

Requirements

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

UnderlaySizeType Property

The method used to define the size of the underlay.

Syntax

[get: Foundation.Export("underlaySizeType", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setUnderlaySizeType:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual SEssentialsUnderlaySizeType UnderlaySizeType { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Defaults to SEssentialsUnderlaySizeType.Ratio.

SEssentialsUnderlaySizeType.Pixel allows the size of the underlay to be given as a value of pixels in SEssentialsSlidingOverlay.UnderlayRevealAmount.

SEssentialsUnderlaySizeType.Ratio allows the size of the underlay to be defined as a proportion of the view in SEssentialsSlidingOverlay.UnderlayRevealAmount.

Requirements

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

WeakDelegate Property

A weakly typed delegate for the SEssentialsSlidingOverlay

Syntax

[get: Foundation.Export("delegate", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setDelegate:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual Foundation.NSObject WeakDelegate { 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