ShinobiControls Xamarin Bindings Documentation

ShinobiEssentials : Shinobi.Essentials Namespace

SEssentialsPullToActionDefaultStatusView Class

A default implementation of the SEssentialsPullToAction's status view.

Syntax

[Foundation.Register("SEssentialsPullToActionDefaultStatusView", true)]
public class SEssentialsPullToActionDefaultStatusView : UIKit.UIView, ISEssentialsPullToActionStatusView, IDisposable

Remarks

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
A constructor that initializes the object from the data stored in the unarchiver object.

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

ActivityIndicator UIKit.UIView . The activity indicator which is displayed when the action is executing.
[read-only]
override
ClassHandle IntPtr . The handle for this class.
PullingIcon UIKit.UIView . An icon to be displayed when the status view is being pulled.
StatusLabel UIKit.UILabel . A label showing the current status of the Pull to Action control.
TextForStates Foundation.NSDictionary . The status view associates each state of the Pull to Action control with some text.

Public Methods

Protected Methods

override
Dispose (bool)
Releases unmanaged resources.

Extension Methods

static
ApplyStyle (this ISEssentialsPullToActionStatusView, SEssentialsPullToActionStyle)
Documentation for this section has not yet been entered.
static
Update (this ISEssentialsPullToActionStatusView, SEssentialsPullToActionState)
Documentation for this section has not yet been entered.
static
Update (this ISEssentialsPullToActionStatusView, nfloat, nfloat)
Documentation for this section has not yet been entered.

Member Details

SEssentialsPullToActionDefaultStatusView Constructor

Default constructor

Syntax

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

Remarks

Requirements

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

SEssentialsPullToActionDefaultStatusView 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 SEssentialsPullToActionDefaultStatusView (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

SEssentialsPullToActionDefaultStatusView Constructor

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

Syntax

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

SEssentialsPullToActionDefaultStatusView Constructor

A constructor used when creating managed representations of unmanaged objects.

Syntax

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

ActivityIndicator Property

The activity indicator which is displayed when the action is executing.

Syntax

[get: Foundation.Export("activityIndicator", ObjCRuntime.ArgumentSemantic.Strong)]
[set: Foundation.Export("setActivityIndicator:", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual UIKit.UIView ActivityIndicator { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

By default, this is an instance of UIActivityIndicator.

Warning: Override the method SEssentialsPullToActionDefaultStatusView.Update(SEssentialsPullToActionState) to customize when the activity indicator shows/hides.

Requirements

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

ApplyStyle Method

Syntax

[Foundation.Export("applyStyle:")]
public virtual void ApplyStyle (SEssentialsPullToActionStyle style)

Parameters

style
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

ClassHandle Property

The handle for this class.

Syntax

public override IntPtr ClassHandle { get; }

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

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

PullingIcon Property

An icon to be displayed when the status view is being pulled.

Syntax

[get: Foundation.Export("pullingIcon", ObjCRuntime.ArgumentSemantic.Strong)]
[set: Foundation.Export("setPullingIcon:", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual UIKit.UIView PullingIcon { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

By default, this is an Shinobi.Essentials.SEssentialsPullToActionArrow which rotates as the Pull to Action control nears its PullThreshold.

Warning: Override the method SEssentialsPullToActionDefaultStatusView.Update(SEssentialsPullToActionState) to customize when the pulling icon shows/hides.

Requirements

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

StatusLabel Property

A label showing the current status of the Pull to Action control.

Syntax

[get: Foundation.Export("statusLabel", ObjCRuntime.ArgumentSemantic.Strong)]
[set: Foundation.Export("setStatusLabel:", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual UIKit.UILabel StatusLabel { 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

TextForStates Property

The status view associates each state of the Pull to Action control with some text.

Syntax

[get: Foundation.Export("textForStates", ObjCRuntime.ArgumentSemantic.Strong)]
[set: Foundation.Export("setTextForStates:", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual Foundation.NSDictionary TextForStates { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

This text is displayed in the status label when the Pull to Action control is in that state. The default mappings are:
  • SEssentialsPullToActionState.Idle => "Idle"
  • SEssentialsPullToActionState.Pulling => "Pulling"
  • SEssentialsPullToActionState.Retracting => "Retracting"
  • SEssentialsPullToActionState.Triggered => "Triggered"
  • SEssentialsPullToActionState.Executing => "Executing"

Requirements

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

Update Method

Syntax

[Foundation.Export("updateForState:")]
public virtual void Update (SEssentialsPullToActionState state)

Parameters

state
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

Update Method

Documentation for this section has not yet been entered.

Syntax

[Foundation.Export("updateForPulledAmountChanged:pullThreshold:")]
public virtual void Update (nfloat pulledAmount, nfloat pullThreshold)

Parameters

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