ShinobiControls Xamarin Bindings Documentation

ShinobiCalendars : Shinobi.Calendars Namespace

ShinobiCalendar Class

Displays an infinite scrolling list of dates.

Syntax

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

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: Shinobi.Calendars
Assembly: ShinobiCalendars (in ShinobiCalendars.dll)
Assembly Versions: 1.0.0.7

Members

See Also: Inherited members from UIKit.UIView.

Public Constructors

Default constructor.
Documentation for this section has not yet been entered.
A constructor that initializes the object from the data stored in the unarchiver object.
Creates a new ShinobiCalendar with the specified start date.
Creates a new ShinobiCalendar with the specified start date, initial zoom level, and style.
Creates a new ShinobiCalendar with the specified start date, initial zoom level, and style.
Creates a new ShinobiCalendar with the specified start date, zoom levels, min and max dates, and 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

[read-only]
override
ClassHandle IntPtr . The handle for this class.
DataSource ISCalendarDataSource . The datasource, which controls indicators and events the year view should display.
Delegate ISCalendarDelegate . The delegate, which allows the owner to respond to events and to customise the calendar.
[read-only]
GestureRecognizer UIKit.UIPinchGestureRecognizer . The gesture recognizer that the calendar uses to zoom in and out of the calendar.
LicenseKey string . The license key for this Calendar (trial versions only).
MaximumDate Foundation.NSDate . The maximum date that the user should be able to select on the calendar.
MaximumZoomLevel SCalendarZoomLevel . The maximum zoom level of the calendar.
MinimumDate Foundation.NSDate . The minimum date that the user should be able to select on the calendar.
MinimumZoomLevel SCalendarZoomLevel . The minimum zoom level of the calendar.
MonthColumnsAtYearZoomLevel nint . The number of month columns when the calendar is at the year zoom level.
Style SCalendarStyle . The style that the calendar uses to configure its appearance.

Public Methods

DequeueReusableEventView (string) : Foundation.NSObject
Returns a reusable event view object located by its identifier.
RegisterEventViewClass (ObjCRuntime.Class, string)
Registers a class for use in creating new event views.
ScrollToDate (Foundation.NSDate, SCalendarZoomLevel, bool)
Moves the calendar to the specified date while changing to the given zoom level.
ZoomIn ()
Zooms in a single zoom level around the center date.
ZoomOut ()
Zooms out a single zoom level around the center date.

Protected Methods

override
Dispose (bool)
Releases unmanaged resources.

Member Details

ShinobiCalendar Constructor

Default constructor.

Syntax

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

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: Shinobi.Calendars
Assembly: ShinobiCalendars (in ShinobiCalendars.dll)
Assembly Versions: 1.0.0.7

ShinobiCalendar Constructor

Documentation for this section has not yet been entered.

Syntax

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

Parameters

frame
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: Shinobi.Calendars
Assembly: ShinobiCalendars (in ShinobiCalendars.dll)
Assembly Versions: 1.0.0.7

ShinobiCalendar 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 ShinobiCalendar (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.Calendars
Assembly: ShinobiCalendars (in ShinobiCalendars.dll)
Assembly Versions: 1.0.0.7

ShinobiCalendar Constructor

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

Syntax

[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)]
protected ShinobiCalendar (Foundation.NSObjectFlag t)

Parameters

t
Unused sentinel value

Remarks

You should not invoke this method directly.

Requirements

Namespace: Shinobi.Calendars
Assembly: ShinobiCalendars (in ShinobiCalendars.dll)
Assembly Versions: 1.0.0.7

ShinobiCalendar Constructor

A constructor used when creating managed representations of unmanaged objects.

Syntax

[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)]
protected ShinobiCalendar (IntPtr handle)

Parameters

handle
Handle of the unmanaged object

Remarks

You should not invoke this method directly.

Requirements

Namespace: Shinobi.Calendars
Assembly: ShinobiCalendars (in ShinobiCalendars.dll)
Assembly Versions: 1.0.0.7

ShinobiCalendar Constructor

Creates a new ShinobiCalendar with the specified start date.

Syntax

[Foundation.Export("initWithFrame:andStartDate:")]
public ShinobiCalendar (CoreGraphics.CGRect frame, Foundation.NSDate startDate)

Parameters

frame
The inital frame for the calendar.
startDate
The proxy that provides the datasource and the delegate.

Returns

A new ShinobiCalendar.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: Shinobi.Calendars
Assembly: ShinobiCalendars (in ShinobiCalendars.dll)
Assembly Versions: 1.0.0.7

ShinobiCalendar Constructor

Creates a new ShinobiCalendar with the specified start date, initial zoom level, and style.

Syntax

[Foundation.Export("initWithFrame:startDate:initialZoomLevel:andStyle:")]
public ShinobiCalendar (CoreGraphics.CGRect frame, Foundation.NSDate startDate, SCalendarZoomLevel initialZoomLevel, SCalendarStyle style)

Parameters

frame
The inital frame for the calendar.
startDate
The proxy that provides the datasource and the delegate.
initialZoomLevel
The zoom level that the calendar will start at.
style
The style that will be applied to the calendar when it is created.

Returns

A new ShinobiCalendar.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: Shinobi.Calendars
Assembly: ShinobiCalendars (in ShinobiCalendars.dll)
Assembly Versions: 1.0.0.7

ShinobiCalendar Constructor

Creates a new ShinobiCalendar with the specified start date, initial zoom level, and style.

Syntax

[Foundation.Export("initWithFrame:startDate:initialZoomLevel:minimumZoomLevel:maximumZoomLevel:andStyle:")]
public ShinobiCalendar (CoreGraphics.CGRect frame, Foundation.NSDate startDate, SCalendarZoomLevel initialZoomLevel, SCalendarZoomLevel minimumZoomLevel, SCalendarZoomLevel maximumZoomLevel, SCalendarStyle style)

Parameters

frame
The inital frame for the calendar.
startDate
The proxy that provides the datasource and the delegate.
initialZoomLevel
The zoom level that the calendar will start at.
minimumZoomLevel
The minimum zoom level that the user will be able to zoom to.
maximumZoomLevel
The maximum zoom level that the user will be able to zoom to.
style
The style that will be applied to the calendar when it is created.

Returns

A new ShinobiCalendar.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: Shinobi.Calendars
Assembly: ShinobiCalendars (in ShinobiCalendars.dll)
Assembly Versions: 1.0.0.7

ShinobiCalendar Constructor

Creates a new ShinobiCalendar with the specified start date, zoom levels, min and max dates, and style.

Syntax

[Foundation.Export("initWithFrame:startDate:initialZoomLevel:minimumZoomLevel:maximumZoomLevel:minimumDate:maximumDate:andStyle:")]
public ShinobiCalendar (CoreGraphics.CGRect frame, Foundation.NSDate startDate, SCalendarZoomLevel initialZoomLevel, SCalendarZoomLevel minimumZoomLevel, SCalendarZoomLevel maximumZoomLevel, Foundation.NSDate minimumDate, Foundation.NSDate maximumDate, SCalendarStyle style)

Parameters

frame
The inital frame for the calendar.
startDate
The proxy that provides the datasource and the delegate.
initialZoomLevel
The zoom level that the calendar will start at.
minimumZoomLevel
The minimum zoom level that the user will be able to zoom to.
maximumZoomLevel
The maximum zoom level that the user will be able to zoom to.
minimumDate
The minimum date that the user will be able to scroll to / interact with.
maximumDate
The maximum date that the user will be able to scroll to / interact with.
style
The style that will be applied to the calendar when it is created.

Returns

A new ShinobiCalendar.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: Shinobi.Calendars
Assembly: ShinobiCalendars (in ShinobiCalendars.dll)
Assembly Versions: 1.0.0.7

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.Calendars
Assembly: ShinobiCalendars (in ShinobiCalendars.dll)
Assembly Versions: 1.0.0.7

DataSource Property

The datasource, which controls indicators and events the year view should display.

Syntax

[get: Foundation.Export("dataSource", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setDataSource:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual ISCalendarDataSource DataSource { 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.Calendars
Assembly: ShinobiCalendars (in ShinobiCalendars.dll)
Assembly Versions: 1.0.0.7

Delegate Property

The delegate, which allows the owner to respond to events and to customise the calendar.

Syntax

[get: Foundation.Export("delegate", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setDelegate:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual ISCalendarDelegate Delegate { 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.Calendars
Assembly: ShinobiCalendars (in ShinobiCalendars.dll)
Assembly Versions: 1.0.0.7

DequeueReusableEventView Method

Returns a reusable event view object located by its identifier.

Syntax

[Foundation.Export("dequeueReusableEventViewWithIdentifier:")]
public virtual Foundation.NSObject DequeueReusableEventView (string identifier)

Parameters

identifier
A string identifying the event view object to be reused. This parameter must not be nil.

Returns

An SCalendarEventView object with the associated reuse identifier. This method always returns a valid event view.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: Shinobi.Calendars
Assembly: ShinobiCalendars (in ShinobiCalendars.dll)
Assembly Versions: 1.0.0.7

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.Calendars
Assembly: ShinobiCalendars (in ShinobiCalendars.dll)
Assembly Versions: 1.0.0.7

GestureRecognizer Property

The gesture recognizer that the calendar uses to zoom in and out of the calendar.

Syntax

[get: Foundation.Export("gestureRecognizer")]
public virtual UIKit.UIPinchGestureRecognizer GestureRecognizer { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: Shinobi.Calendars
Assembly: ShinobiCalendars (in ShinobiCalendars.dll)
Assembly Versions: 1.0.0.7

LicenseKey Property

The license key for this Calendar (trial versions only).

Syntax

[get: Foundation.Export("licenseKey", ObjCRuntime.ArgumentSemantic.Strong)]
[set: Foundation.Export("setLicenseKey:", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual string LicenseKey { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

In trial versions, a valid license key must be set before the Calendar will render. When you download a trial version of ShinobiCalendars, you will also receive an email containing the license key.

Requirements

Namespace: Shinobi.Calendars
Assembly: ShinobiCalendars (in ShinobiCalendars.dll)
Assembly Versions: 1.0.0.7

MaximumDate Property

The maximum date that the user should be able to select on the calendar.

Syntax

[get: Foundation.Export("maximumDate")]
[set: Foundation.Export("setMaximumDate:")]
public virtual Foundation.NSDate MaximumDate { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

The calendar will not scroll to a position after this date.

Requirements

Namespace: Shinobi.Calendars
Assembly: ShinobiCalendars (in ShinobiCalendars.dll)
Assembly Versions: 1.0.0.7

MaximumZoomLevel Property

The maximum zoom level of the calendar.

Syntax

[get: Foundation.Export("maximumZoomLevel", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setMaximumZoomLevel:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual SCalendarZoomLevel MaximumZoomLevel { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

The calendar cannot zoom in past this level. Defaults to SCalendarZoomLevelDay.

Requirements

Namespace: Shinobi.Calendars
Assembly: ShinobiCalendars (in ShinobiCalendars.dll)
Assembly Versions: 1.0.0.7

MinimumDate Property

The minimum date that the user should be able to select on the calendar.

Syntax

[get: Foundation.Export("minimumDate")]
[set: Foundation.Export("setMinimumDate:")]
public virtual Foundation.NSDate MinimumDate { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

The calendar will not scroll to a position before this date.

Requirements

Namespace: Shinobi.Calendars
Assembly: ShinobiCalendars (in ShinobiCalendars.dll)
Assembly Versions: 1.0.0.7

MinimumZoomLevel Property

The minimum zoom level of the calendar.

Syntax

[get: Foundation.Export("minimumZoomLevel", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setMinimumZoomLevel:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual SCalendarZoomLevel MinimumZoomLevel { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

The calendar cannot zoom out past this level. Defaults to SCalendarZoomLevelYear.

Requirements

Namespace: Shinobi.Calendars
Assembly: ShinobiCalendars (in ShinobiCalendars.dll)
Assembly Versions: 1.0.0.7

MonthColumnsAtYearZoomLevel Property

The number of month columns when the calendar is at the year zoom level.

Syntax

[get: Foundation.Export("monthColumnsAtYearZoomLevel", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setMonthColumnsAtYearZoomLevel:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual nint MonthColumnsAtYearZoomLevel { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

This defaults to 2 on iPhone, and 3 on iPad. The maximum number is 4, and the minimum number is 1.

Requirements

Namespace: Shinobi.Calendars
Assembly: ShinobiCalendars (in ShinobiCalendars.dll)
Assembly Versions: 1.0.0.7

RegisterEventViewClass Method

Registers a class for use in creating new event views.

Syntax

[Foundation.Export("registerEventViewClass:forEventReuseIdentifier:")]
public virtual void RegisterEventViewClass (ObjCRuntime.Class eventViewClass, string identifier)

Parameters

eventViewClass
The class of an event view that you want to use in the calendar.
identifier
The reuse identifier for the cell. This parameter must not be nil or an empty string.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: Shinobi.Calendars
Assembly: ShinobiCalendars (in ShinobiCalendars.dll)
Assembly Versions: 1.0.0.7

ScrollToDate Method

Moves the calendar to the specified date while changing to the given zoom level.

Syntax

[Foundation.Export("scrollToDate:atZoomLevel:animated:")]
public virtual void ScrollToDate (Foundation.NSDate date, SCalendarZoomLevel zoomLevel, bool animated)

Parameters

date
The date the calendar will scroll to.
zoomLevel
The zoom level that the calendar will change to.
animated
The boolean controlling whether to animate to the specified date.

Remarks

This can be animated or can happen instantly. Setting the zoom level to the current zoom level will still move the view to the specified date.

Requirements

Namespace: Shinobi.Calendars
Assembly: ShinobiCalendars (in ShinobiCalendars.dll)
Assembly Versions: 1.0.0.7

Style Property

The style that the calendar uses to configure its appearance.

Syntax

[get: Foundation.Export("style")]
[set: Foundation.Export("setStyle:")]
public virtual SCalendarStyle Style { 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.Calendars
Assembly: ShinobiCalendars (in ShinobiCalendars.dll)
Assembly Versions: 1.0.0.7

ZoomIn Method

Zooms in a single zoom level around the center date.

Syntax

[Foundation.Export("zoomIn")]
public virtual void ZoomIn ()

Remarks

Does nothing if the current zoom level is the maximum zoom level.

Requirements

Namespace: Shinobi.Calendars
Assembly: ShinobiCalendars (in ShinobiCalendars.dll)
Assembly Versions: 1.0.0.7

ZoomOut Method

Zooms out a single zoom level around the center date.

Syntax

[Foundation.Export("zoomOut")]
public virtual void ZoomOut ()

Remarks

Does nothing if the current zoom level is the minimum zoom level.

Requirements

Namespace: Shinobi.Calendars
Assembly: ShinobiCalendars (in ShinobiCalendars.dll)
Assembly Versions: 1.0.0.7