ShinobiControls Xamarin Bindings Documentation

ShinobiGrids : ShinobiGrids Namespace

SDataGridPullToAction Class

The SDataGridPullToAction control attaches to a scrollview, or any class which is a sub-class of UIScrollView. When the user pulls down the scroll view, the Pull to Action control is displayed.

Syntax

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

Remarks

If the user pulls down the scroll view past a certain threshold, an action is triggered by the Pull to Action control. The Pull to Action control has a delegate, which is an instance of ShinobiGrids.ISDataGridPullToActionDelegate. The delegate is used to tell the control when the action is completed.

Requirements

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

Members

See Also: Inherited members from Foundation.NSObject.

Public Constructors

A constructor which takes in the initial frame of the Pull to Action Control.

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.
Delegate ISDataGridPullToActionDelegate . The delegate for the Pull to Action control. Will be sent notifications about changes in state, and the triggering of actions.
ExecutingHeight nfloat . The height of the Pull to Action control during its executing state. Defaults to 50 points. When the pull gesture ends after having passed the PullThreshold, the Pull to Action control will return to this height, until the ActionCompleted method is called.
Frame CoreGraphics.CGRect . The current frame of the Pull to Action control.
Hidden bool . Whether the Pull to Action control is currently visible. This defaults to false.
[read-only]
PulledAmount nfloat . The current distance that the Pull to Action has been pulled down by, in points.
PullThreshold nfloat . The distance at which an action is triggered, once the PulledAmount has exceeded this value. Defaults to 100 points.
ScrollView UIKit.UIScrollView . The UIScrollView that the Pull to Action is attached to. We only hold a weak reference, as we are retained by the scrollView as one of its subviews.
[read-only]
Style SDataGridPullToActionStyle . This property allows you to configure the look and feel of the Pull to Action control status view.
TextForStates Foundation.NSDictionary .

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

This text is displayed in the status label when the Pull to Action control is in that state. The default mappings are:

  • SDataGridPullToActionStatePulling => "Pull to update"
  • SDataGridPullToActionStateTriggered => "Release to update"
  • SDataGridPullToActionStateExecuting => "Loading..."

No text is displayed by default for the remaining states.

Public Methods

ActionCompleted ()
The delegate should call this once it has completed its action. This tells the Pull to Action control to retract back to its idle state.
AddToScrollView (UIKit.UIScrollView)
Adds the Pull to Action control as a subview of the specified scrollview.

Protected Methods

override
Dispose (bool)
Releases unmanaged resources.

Member Details

SDataGridPullToAction Constructor

A constructor which takes in the initial frame of the Pull to Action Control.

Syntax

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

Parameters

frame
The initial frame of the Pull to Action control

Remarks

Documentation for this section has not yet been entered.

Requirements

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

SDataGridPullToAction Constructor

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

Syntax

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

SDataGridPullToAction Constructor

A constructor used when creating managed representations of unmanaged objects.

Syntax

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

ActionCompleted Method

The delegate should call this once it has completed its action. This tells the Pull to Action control to retract back to its idle state.

Syntax

[Foundation.Export("actionCompleted")]
public virtual void ActionCompleted ()

Remarks

Requirements

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

AddToScrollView Method

Adds the Pull to Action control as a subview of the specified scrollview.

Syntax

[Foundation.Export("addToScrollView:")]
public virtual void AddToScrollView (UIKit.UIScrollView scrollView)

Parameters

scrollView
The scrollview to which to add the Pull to Action control

Remarks

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

Requirements

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

Delegate Property

The delegate for the Pull to Action control. Will be sent notifications about changes in state, and the triggering of actions.

Syntax

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

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

ExecutingHeight Property

The height of the Pull to Action control during its executing state. Defaults to 50 points. When the pull gesture ends after having passed the PullThreshold, the Pull to Action control will return to this height, until the ActionCompleted method is called.

Syntax

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

Frame Property

The current frame of the Pull to Action control.

Syntax

[get: Foundation.Export("frame", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setFrame:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual CoreGraphics.CGRect Frame { 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

Hidden Property

Whether the Pull to Action control is currently visible. This defaults to false.

Syntax

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

PulledAmount Property

The current distance that the Pull to Action has been pulled down by, in points.

Syntax

[get: Foundation.Export("pulledAmount")]
public virtual nfloat PulledAmount { get; }

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

PullThreshold Property

The distance at which an action is triggered, once the PulledAmount has exceeded this value. Defaults to 100 points.

Syntax

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

ScrollView Property

The UIScrollView that the Pull to Action is attached to. We only hold a weak reference, as we are retained by the scrollView as one of its subviews.

Syntax

[get: Foundation.Export("scrollView", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setScrollView:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual UIKit.UIScrollView ScrollView { 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

Style Property

This property allows you to configure the look and feel of the Pull to Action control status view.

Syntax

[get: Foundation.Export("style", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual SDataGridPullToActionStyle Style { get; }

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

TextForStates Property

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

This text is displayed in the status label when the Pull to Action control is in that state. The default mappings are:

  • SDataGridPullToActionStatePulling => "Pull to update"
  • SDataGridPullToActionStateTriggered => "Release to update"
  • SDataGridPullToActionStateExecuting => "Loading..."

No text is displayed by default for the remaining states.

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

Requirements

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