Class SFSchedule

Represents the SfSchedule that provides simple method, to plan a process or list of events in a particular time.

Inheritance

System.Object

SFSchedule

Namespace: Syncfusion.SfSchedule.iOS

Assembly: Syncfusion.SfSchedule.iOS.dll

Syntax

public class SFSchedule : UIView

Constructors

SFSchedule()

Initializes a new instance of the SFSchedule class

Declaration

public SFSchedule()

SFSchedule(RectangleF)

Initializes a new instance of the SFSchedule class

Declaration

public SFSchedule(RectangleF frame)

Parameters

Type	Name	Description
System.Drawing.RectangleF	frame	Frame for schedule

SFSchedule(IntPtr)

Initializes a new instance of the SFSchedule class

Declaration

public SFSchedule(IntPtr handle)

Parameters

Type	Name	Description
System.IntPtr	handle	Handle value

Properties

AllowAppointmentDrag

Gets or sets a value indicating whether this SFSchedule allow appointment drag.

Declaration

public bool AllowAppointmentDrag { get; set; }

Property Value

Type	Description
System.Boolean	true if allow appointment drag; otherwise, false.

AppointmentMapping

Gets or sets the visible appointments of SFSchedule.

Declaration

public AppointmentMapping AppointmentMapping { get; set; }

Property Value

Type	Description
AppointmentMapping	The visible appointments.

AppointmentStyle

Gets or sets the appointment style to customize the appearance of appointments

Declaration

public SFAppointmentStyle AppointmentStyle { get; set; }

Property Value

Type
SFAppointmentStyle

AppointmentViewLayout

Gets or sets the appointment view layout option

Declaration

public SFViewLayoutOptions AppointmentViewLayout { get; set; }

Property Value

Type
SFViewLayoutOptions

Calendar

Gets or sets the calendar

Declaration

public NSCalendar Calendar { get; set; }

Property Value

Type
Foundation.NSCalendar

CurrentTimeIndicatorColor

Gets or sets the color of the current time indicator.

Declaration

public UIColor CurrentTimeIndicatorColor { get; set; }

Property Value

Type	Description
UIKit.UIColor	The color of the current time indicator.

Remarks

The current time indicator color is only applied if the ShowCurrentTimeIndicator is enabled.

DayHeaderStyle

Gets or sets the day header style to customize the day header

Declaration

public SFViewHeaderStyle DayHeaderStyle { get; set; }

Property Value

Type
SFViewHeaderStyle

DayViewSettings

Gets or sets the day view settings to customize the day view

Declaration

public DayViewSettings DayViewSettings { get; set; }

Property Value

Type
DayViewSettings

DragDropSettings

Gets or sets the drag and drop settings.

Declaration

public DragDropSettings DragDropSettings { get; set; }

Property Value

Type	Description
DragDropSettings	The drag and drop settings.

EnableNavigation

Gets or sets a value indicating whether the EnableNavigation property which is used to enable or disable date navigation in the schedule using UI.

Declaration

public bool EnableNavigation { get; set; }

Property Value

Type
System.Boolean

FirstDayOfWeek

Gets or sets the first day of week

Declaration

public int FirstDayOfWeek { get; set; }

Property Value

Type
System.Int32

HeaderHeight

Gets or sets the schedule header height

Declaration

public double HeaderHeight { get; set; }

Property Value

Type
System.Double

HeaderStyle

Gets or sets the header style to customize the header

Declaration

public HeaderStyle HeaderStyle { get; set; }

Property Value

Type
HeaderStyle

InlineView

Gets or sets the inline view

Declaration

public UIView InlineView { get; set; }

Property Value

Type
UIKit.UIView

ItemsSource

Gets or sets the visible appointments of SFSchedule.

Declaration

public IEnumerable ItemsSource { get; set; }

Property Value

Type	Description
System.Collections.IEnumerable	The visible appointments.

Locale

Gets or sets The Locale property which is used for Specifying the localization language for the Schedule.

Declaration

public NSLocale Locale { get; set; }

Property Value

Type
Foundation.NSLocale

MaxDisplayDate

Gets or sets the MaxDisplayDate View of SfSchedule.

Declaration

public NSDate MaxDisplayDate { get; set; }

Property Value

Type
Foundation.NSDate

MinDisplayDate

Gets or sets the MinDisplayDate View of SfSchedule.

Declaration

public NSDate MinDisplayDate { get; set; }

Property Value

Type
Foundation.NSDate

MonthCellStyle

Gets or sets the month cell style to customize the month cell

Declaration

public SFMonthCellStyle MonthCellStyle { get; set; }

Property Value

Type
SFMonthCellStyle

MonthCellViewLayout

Gets or sets the month cell view layout option

Declaration

public SFViewLayoutOptions MonthCellViewLayout { get; set; }

Property Value

Type
SFViewLayoutOptions

MonthViewSettings

Gets or sets the month view settings to customize the month view

Declaration

public MonthViewSettings MonthViewSettings { get; set; }

Property Value

Type
MonthViewSettings

ScheduleDateHeaderFormat

Gets or sets the schedule date header format

Declaration

public NSString ScheduleDateHeaderFormat { get; set; }

Property Value

Type
Foundation.NSString

ScheduleView

Gets or sets the schedule view

Declaration

public SFScheduleView ScheduleView { get; set; }

Property Value

Type
SFScheduleView

SelectedDate

Gets or sets the selected date and time.

Declaration

public NSDate SelectedDate { get; set; }

Property Value

Type
Foundation.NSDate

SelectionStyle

Gets or sets the selection style to customize the selection

Declaration

public SFSelectionStyle SelectionStyle { get; set; }

Property Value

Type
SFSelectionStyle

SelectionView

Gets or sets selection view

Declaration

public UIView SelectionView { get; set; }

Property Value

Type
UIKit.UIView

ShowCurrentTimeIndicator

Gets or sets a value indicating whether the ShowCurrentTimeIndicator property which is used to enable or disable current time indicator in the schedule. It's applicable in day view, week view, work week view and timeline view.

Declaration

public bool ShowCurrentTimeIndicator { get; set; }

Property Value

Type
System.Boolean

SpecialTimeRegions

Gets or sets the day view settings to customize the day view

Declaration

public List<TimeRegionSettings> SpecialTimeRegions { get; set; }

Property Value

Type
System.Collections.Generic.List<TimeRegionSettings>

TimeInterval

Gets or sets the time interval value

Declaration

public double TimeInterval { get; set; }

Property Value

Type
System.Double

TimeIntervalHeight

Gets or sets the time interval height

Declaration

public double TimeIntervalHeight { get; set; }

Property Value

Type
System.Double

TimelineViewSettings

Gets or sets the day view settings to customize the day view

Declaration

public TimelineViewSettings TimelineViewSettings { get; set; }

Property Value

Type
TimelineViewSettings

TimeZone

Gets or sets a time zone for the schedule control.

Declaration

public string TimeZone { get; set; }

Property Value

Type
System.String

ViewHeaderHeight

Gets or sets the view header height

Declaration

public double ViewHeaderHeight { get; set; }

Property Value

Type
System.Double

VisibleDates

Gets the visible dates

Declaration

public NSMutableArray VisibleDates { get; }

Property Value

Type
Foundation.NSMutableArray

WeekViewSettings

Gets or sets the week view settings to customize the week view

Declaration

public WeekViewSettings WeekViewSettings { get; set; }

Property Value

Type
WeekViewSettings

WorkWeekViewSettings

Gets or sets the work week view settings to customize the work week view

Declaration

public WorkWeekViewSettings WorkWeekViewSettings { get; set; }

Property Value

Type
WorkWeekViewSettings

Methods

AwakeFromNib()

Awakes from nib.

Declaration

public override void AwakeFromNib()

Backward()

Moves to previous visible date.

Declaration

public void Backward()

Dispose(Boolean)

Dispose the specified events.

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing	Indicates whether dispose or not

Forward()

Moves to next visible date.

Declaration

public void Forward()

LayoutSubviews()

Updates the frame for child

Declaration

public override void LayoutSubviews()

MoveToDate(NSDate)

Navigates to the specified date in schedule.

Declaration

public void MoveToDate(NSDate dateNeedToBeMoved)

Parameters

Type	Name	Description
Foundation.NSDate	dateNeedToBeMoved	Date need to be moved

ReloadData()

Reloads the schedule date

Declaration

public void ReloadData()

WillMoveToWindow(UIWindow)

Tells the view that its window object is about to change.

Declaration

public override void WillMoveToWindow(UIWindow window)

Parameters

Type	Name	Description
UIKit.UIWindow	window	Window value

Events

AppointmentDragOver

Occurs when appointment drag over.

Declaration

public event EventHandler<AppointmentDragEventArgs> AppointmentDragOver

Event Type

Type
System.EventHandler<AppointmentDragEventArgs>

AppointmentDragStarting

Occurs when appointment drag starting.

Declaration

public event EventHandler<AppointmentDragStartingEventArgs> AppointmentDragStarting

Event Type

Type
System.EventHandler<AppointmentDragStartingEventArgs>

AppointmentDrop

Occurs when appointment drag over.

Declaration

public event EventHandler<AppointmentDropEventArgs> AppointmentDrop

Event Type

Type
System.EventHandler<AppointmentDropEventArgs>

AppointmentLoaded

Occurs when the schedule appointments loaded

Declaration

public event EventHandler<AppointmentLoadedEventArgs> AppointmentLoaded

Event Type

Type
System.EventHandler<AppointmentLoadedEventArgs>

AppointmentsForDate

Occurs when appointments set for particular date

Declaration

public event EventHandler<AppointmentsForDateEventArgs> AppointmentsForDate

Event Type

Type
System.EventHandler<AppointmentsForDateEventArgs>

AppointmentsFromDate

Occurs when appointment get from particular date

Declaration

public event EventHandler<AppointmentsFromDateEventArgs> AppointmentsFromDate

Event Type

Type
System.EventHandler<AppointmentsFromDateEventArgs>

CellDoubleTapped

Occurs when double tap on the cell or appointment inside the cell.

Declaration

public event EventHandler<CellTappedEventArgs> CellDoubleTapped

Event Type

Type
System.EventHandler<CellTappedEventArgs>

Remarks

ScheduleTappedEventArgs.Appointment will have value when appointment gets tapped, otherwise it will be null.

CellLongPressed

Occurs when long tap on the cell or appointment inside the cell.

Declaration

public event EventHandler<CellTappedEventArgs> CellLongPressed

Event Type

Type
System.EventHandler<CellTappedEventArgs>

Remarks

ScheduleTappedEventArgs.Appointment will have value when appointment gets tapped, otherwise it will be null.

CellTapped

Occurs when tap on the cell or appointment inside the cell.

Declaration

public event EventHandler<CellTappedEventArgs> CellTapped

Event Type

Type
System.EventHandler<CellTappedEventArgs>

Remarks

ScheduleTappedEventArgs.Appointment will have value when appointment gets tapped, otherwise it will be null.

HeaderTapped

Occurs when tap on the header

Declaration

public event EventHandler<HeaderTappedEventArgs> HeaderTapped

Event Type

Type
System.EventHandler<HeaderTappedEventArgs>

MonthCellLoaded

Occurs when month cell loaded.

Declaration

public event EventHandler<MonthCellLoadedEventArgs> MonthCellLoaded

Event Type

Type
System.EventHandler<MonthCellLoadedEventArgs>

MonthInlineAppointmentLoaded

Occurs when the month inline appointments loaded

Declaration

public event EventHandler<MonthInlineAppointmentLoadedEventArgs> MonthInlineAppointmentLoaded

Event Type

Type
System.EventHandler<MonthInlineAppointmentLoadedEventArgs>

MonthInlineAppointmentTapped

Occurs when tap on the month inline appointment

Declaration

public event EventHandler<MonthInlineAppointmentTappedEventArgs> MonthInlineAppointmentTapped

Event Type

Type
System.EventHandler<MonthInlineAppointmentTappedEventArgs>

MonthInlineLoaded

Occurs when the month inline loaded

Declaration

public event EventHandler<MonthInlineLoadedEventArgs> MonthInlineLoaded

Event Type

Type
System.EventHandler<MonthInlineLoadedEventArgs>

ViewHeaderTapped

Occurs when tap on the view header

Declaration

public event EventHandler<ViewHeaderTappedEventArgs> ViewHeaderTapped

Event Type

Type
System.EventHandler<ViewHeaderTappedEventArgs>

VisibleDatesChanged

Occurs when the visible dates changed

Declaration

public event EventHandler<VisibleDatesChangedEventArgs> VisibleDatesChanged

Event Type

Type
System.EventHandler<VisibleDatesChangedEventArgs>