ShinobiControls Xamarin Bindings Documentation

ShinobiEssentials : Shinobi.Essentials Namespace

SEssentialsActivityIndicator Class

An SEssentialsActivityIndicator shows that a task is in progress.

Syntax

[Foundation.Register("SEssentialsActivityIndicator", true)]
public class SEssentialsActivityIndicator : SEssentialsProgressIndicator

Remarks

The SEssentialsActivityIndicator is used to show that a task is in progress. An activity indicator starts animating when it is instantiated.

You can control the proportion of the indicator which is filled at any time using SEssentialsActivityIndicator.FillProportion. You can control how long the indicator takes to make a full revolution using SEssentialsActivityIndicator.CycleTime.

To create an activity indicator, you use one of the factory methods provided. For example:
Example
SEssentialsActivityIndicator activityIndicator = SEssentialsActivityIndicator.Create(SEssentialsIndicatorType.RadialContinuous, new RectangleF(0, 0, 200, 200));
This returns a activity indicator which you can use in your code.

When creating an indicator, you specify the type of indicator you would like. The following types are available:

SEssentialsActivityIndicator inherits properties from SEssentialsProgressIndicator, so for discrete indicators you can set the number of elements in the indicator or the factory which provides elements to the indicator, in the same way as you would do for a progress indicator.

Requirements

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

Members

See Also: Inherited members from SEssentialsProgressIndicator.

Public Constructors

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

[read-only]
override
ClassHandle IntPtr . The handle for this class.
[read-only]
override
ClassHandle IntPtr . The handle for this class. (Inherited from SEssentialsProgressIndicator.)
CycleTime nfloat . The time which the indicator takes to make a full revolution, in seconds.
ElementFactory SEssentialsDiscreteIndicatorElementFactory . A factory which provides individual elements to be drawn in the discrete progress indicator. (Inherited from SEssentialsProgressIndicator.)
FillProportion nfloat . The proportion of the indicator which is filled.
Progress nfloat . The current progress of the indicator. (Inherited from SEssentialsProgressIndicator.)
[read-only]
Style SEssentialsProgressIndicatorStyle . The styling which will be applied to the progress bar. (Inherited from SEssentialsProgressIndicator.)

Public Methods

ApplyTheme (SEssentialsTheme)
Applies the specified theme to the progress indicator. (Inherited from SEssentialsProgressIndicator.)
static
Create (SEssentialsIndicatorType, CoreGraphics.CGRect) : SEssentialsActivityIndicator
Creates an activity indicator
static
Create (SEssentialsIndicatorType, CoreGraphics.CGRect, SEssentialsProgressIndicatorStyle) : SEssentialsActivityIndicator
Creates an activity indicator

Protected Methods

override
Dispose (bool)
Releases unmanaged resources. (Inherited from SEssentialsProgressIndicator.)

Member Details

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

SEssentialsActivityIndicator Constructor

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

Syntax

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

SEssentialsActivityIndicator Constructor

A constructor used when creating managed representations of unmanaged objects.

Syntax

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

Create Method

Creates an activity indicator

Syntax

Parameters

indicatorType
The type of indicator to create
frame
The position and size of the indicator

Returns

Documentation for this section has not yet been entered.

Remarks

Use this instead of a constructor

Requirements

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

Create Method

Creates an activity indicator

Syntax

Parameters

indicatorType
The type of indicator to create
frame
The position and size of the indicator
style
The indicator's visual style

Returns

Documentation for this section has not yet been entered.

Remarks

Use this instead of a constructor

Requirements

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

CycleTime Property

The time which the indicator takes to make a full revolution, in seconds.

Syntax

[get: Foundation.Export("cycleTime", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setCycleTime:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual nfloat CycleTime { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

The default value of this property for continuous activity indicators is 5 seconds. The default value of this property for discrete activity indicators is 1 second.

Requirements

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

FillProportion Property

The proportion of the indicator which is filled.

Syntax

[get: Foundation.Export("fillProportion", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setFillProportion:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual nfloat FillProportion { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

The value of this property can range between 0 and 1. The default value of this property is 0.35.

Requirements

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