menu

Xamarin.Forms

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class SfSchedule - Xamarin.Forms API Reference | Syncfusion

    Show / Hide Table of Contents

    Class SfSchedule

    The SfSchedule class provides simple method to plan a process or list of events in a particular time.

    Inheritance
    System.Object
    SfSchedule
    Implements
    System.IDisposable
    Namespace: Syncfusion.SfSchedule.XForms
    Assembly: Syncfusion.SfSchedule.XForms.dll
    Syntax
    public class SfSchedule : View, IParentThemeElement, IThemeElement, IDisposable

    Constructors

    SfSchedule()

    Initializes a new instance of the SfSchedule class.

    Declaration
    public SfSchedule()

    Fields

    AllowAppointmentDragProperty

    Gets or sets a value indicating whether the schedule can allows the appointment to drag or not on the view. This is a bindable property.

    Declaration
    public static readonly BindableProperty AllowAppointmentDragProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    AppointmentMappingProperty

    Gets or sets the Appointment Mapping for schedule to map the custom appointment properties to schedule appointment properties. This is a bindable property.

    Declaration
    public static readonly BindableProperty AppointmentMappingProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    AppointmentStyleProperty

    Gets or sets the Appointment Style for Schedule to customize the appearance of displaying appointment in schedule. This is a bindable property.

    Declaration
    public static readonly BindableProperty AppointmentStyleProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    AppointmentTemplateProperty

    Gets or sets the Appointment Template to customize the appointment's default UI with custom UI in schedule. This is a bindable property.

    Declaration
    public static readonly BindableProperty AppointmentTemplateProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    AppointmentViewLayoutProperty

    Gets or sets the Appointment view layout to render the custom appointment view layout with default or overlay layout option. This is a bindable property.

    Declaration
    public static readonly BindableProperty AppointmentViewLayoutProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    BackgroundColorProperty

    The background color property.

    Declaration
    public static readonly BindableProperty BackgroundColorProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    CellDoubleTappedCommandProperty

    Gets or sets the Schedule cell double tapped command which is executed when schedule cell is tapped twice. This is a binding property.

    Declaration
    public static readonly BindableProperty CellDoubleTappedCommandProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    CellLongPressedCommandProperty

    Gets or sets the Schedule cell long pressed command which is executed when schedule cell is Holden or long pressed. This is a bindable property.

    Declaration
    public static readonly BindableProperty CellLongPressedCommandProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    CellTappedCommandProperty

    Gets or sets the Schedule cell tapped command which is executed when schedule cell is tapped. This is a bindable property.

    Declaration
    public static readonly BindableProperty CellTappedCommandProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    CurrentTimeIndicatorColorProperty

    The current time indicator property.

    Declaration
    public static readonly BindableProperty CurrentTimeIndicatorColorProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    DataSourceProperty

    Gets or sets the Data Source property for schedule which is used to set the appointment collection to schedule. This is a bindable property.

    Declaration
    public static readonly BindableProperty DataSourceProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    DayViewSettingsProperty

    Gets or sets Day View Settings property for schedule to customize and configure the appearance of day view in schedule. This is a bindable property.

    Declaration
    public static readonly BindableProperty DayViewSettingsProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    DragDropSettingsProperty

    Gets or sets the drag drop settings it has properties to customize the drag and drop operations of appointments in schedule. This is a bindable property.

    Declaration
    public static readonly BindableProperty DragDropSettingsProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    EnableNavigationProperty

    Gets or sets a value indicating whether the schedule can enable navigation or not to it's previous/next view. This is a bindable property.

    Declaration
    public static readonly BindableProperty EnableNavigationProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    FirstDayOfWeekProperty

    Gets or set the First Day of Week for schedule to modify the default first day of the week with any day in schedule. This is a bindable property.

    Declaration
    public static readonly BindableProperty FirstDayOfWeekProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    HeaderHeightProperty

    Gets or sets the Header Height property for schedule to customize the default height of the schedule header view. This is a bindable property.

    Declaration
    public static readonly BindableProperty HeaderHeightProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    HeaderStyleProperty

    Gets or sets the Header Style for Schedule to customize and configure the appearance of header view in schedule. This is a bindable property.

    Declaration
    public static readonly BindableProperty HeaderStyleProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    InlineViewLayoutProperty

    Gets or sets the inline view layout property for schedule to render the custom inline view layout with default or overlay layout option. This is a bindable property.

    Declaration
    public static readonly BindableProperty InlineViewLayoutProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    InlineViewProperty

    Gets or sets the InlineView for Schedule MonthView it replaces the default inline view UI with given custom UI in schedule. This is a bindable property.

    Declaration
    public static readonly BindableProperty InlineViewProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    LocaleProperty

    Gets or sets the Locale value for schedule to localize the schedule default strings with given language. This is a bindable property.

    Declaration
    public static readonly BindableProperty LocaleProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    MaxDisplayDateProperty

    Gets or sets the Max Display Date value for schedule to restrict the visible from navigate beyond the date. This is a bindable property.

    Declaration
    public static readonly BindableProperty MaxDisplayDateProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    MinDisplayDateProperty

    Gets or sets the Min Display Date value for schedule to restrict the visible view from navigate behind the date. This is a bindable property.

    Declaration
    public static readonly BindableProperty MinDisplayDateProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    MonthCellStyleProperty

    Gets or sets the Month View Cell Style for schedule to customize and configure the month view cell in month view of schedule. This is a bindable property.

    Declaration
    public static readonly BindableProperty MonthCellStyleProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    MonthCellViewLayoutProperty

    Gets or sets the month cell view layout property to define the month cell view layout option of schedule.

    Declaration
    public static readonly BindableProperty MonthCellViewLayoutProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    MonthViewSettingsProperty

    Gets or sets the Month View Settings for schedule to customize and configure the appearance of month view in schedule. This is a bindable property.

    Declaration
    public static readonly BindableProperty MonthViewSettingsProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    MoveToDateProperty

    Gets or sets the Move To Date value for schedule which navigates the schedule to the particular date and time value. This is a bindable property.

    Declaration
    public static readonly BindableProperty MoveToDateProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    ResourceItemTemplateProperty

    Gets or sets the Resource Item Template to replace the default UI of resource view with given custom UI. This is a bindable property.

    Declaration
    public static readonly BindableProperty ResourceItemTemplateProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    ResourceMappingProperty

    Gets or sets the Resource Mapping for schedule to map the custom resource properties to schedule resource properties. This is a bindable property.

    Declaration
    public static readonly BindableProperty ResourceMappingProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    ResourceViewHeightProperty

    Gets or sets the Resource View height to customize the default height of resource container view in the Schedule. This is a bindable property.

    Declaration
    public static readonly BindableProperty ResourceViewHeightProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty
    Remarks

    If schedule view is timeline view and ResourceViewMode is Absolute, it is considered as width for resource view.

    ResourceViewModeProperty

    Gets or sets resource view mode property which defines the mode of resource view to display in schedule. This is a bindable property.

    Declaration
    public static readonly BindableProperty ResourceViewModeProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty
    Remarks

    ResourceViewMode Absolute option is applicable only for timeline view.

    ResourceViewSettingsProperty

    Gets or sets the resource view settings to customize and configure the appearance of resource view in schedule. This is a bindable property.

    Declaration
    public static readonly BindableProperty ResourceViewSettingsProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    ScheduleHeaderDateFormatProperty

    Gets or sets the Schedule Header Date Format for schedule to customize the displaying date format in the schedule header view. This is a bindable property.

    Declaration
    public static readonly BindableProperty ScheduleHeaderDateFormatProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    ScheduleResourcesProperty

    Gets or sets the Schedule Resources for Schedule which is used to set the resource collection for schedule. This is a bindable property.

    Declaration
    public static readonly BindableProperty ScheduleResourcesProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    ScheduleViewProperty

    Gets or sets the Schedule View property for Schedule which defines the view to be display in schedule. This is a bindable property.

    Declaration
    public static readonly BindableProperty ScheduleViewProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    SelectedDateProperty

    Gets or sets the Selected Date property for schedule to select a particular date or time slot programmatically. This is a bindable property.

    Declaration
    public static readonly BindableProperty SelectedDateProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    SelectedResourcesProperty

    Gets or sets the Selected resources property for schedule to select the resource view programmatically on schedule. This is a bindable property.

    Declaration
    public static readonly BindableProperty SelectedResourcesProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    SelectionStyleProperty

    Gets or sets the Selection Style property for schedule to customize the appearance of selection view in schedule. This is a bindable property.

    Declaration
    public static readonly BindableProperty SelectionStyleProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    SelectionViewProperty

    Gets or sets the Selection View for schedule which replaces the selection view's default UI view with given Custom UI view. This is a bindable property.

    Declaration
    public static readonly BindableProperty SelectionViewProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    ShowAppointmentsInlineProperty

    Gets or sets a value indicating whether schedule can show the appointments in inline or not in month view. This is a bindable property.

    Declaration
    public static readonly BindableProperty ShowAppointmentsInlineProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    ShowCurrentTimeIndicatorProperty

    Gets or sets a value indicating whether schedule can show the Current time indicator. This is a bindable property.

    Declaration
    public static readonly BindableProperty ShowCurrentTimeIndicatorProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    ShowResourceViewProperty

    Gets or sets a value indicating whether schedule can show the resource view or not in the schedule views. This is a bindable property.

    Declaration
    public static readonly BindableProperty ShowResourceViewProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    SpecialTimeRegionsProperty

    Gets or sets a value of special time regions on schedule. This is a bindable property.

    Declaration
    public static readonly BindableProperty SpecialTimeRegionsProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    TimeIntervalHeightProperty

    Gets or sets the Time Interval Height property for schedule to customize the default height of time slot in schedule. This is a bindable property.

    Declaration
    public static readonly BindableProperty TimeIntervalHeightProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    TimeIntervalProperty

    Gets or sets the Time Interval property for schedule to customize the default time interval between time slots in schedule. This is a bindable property.

    Declaration
    public static readonly BindableProperty TimeIntervalProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    TimelineViewSettingsProperty

    Gets or sets the TimelineViewSettings property.

    Declaration
    public static readonly BindableProperty TimelineViewSettingsProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    TimeZoneProperty

    Gets or sets the Time zone property for schedule to customize the default time zone of schedule with particular time zone. This is a bindable property.

    Declaration
    public static readonly BindableProperty TimeZoneProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    ViewHeaderHeightProperty

    Gets or sets the View Header Height for schedule to customize the default height of view header view in schedule. This is a bindable property.

    Declaration
    public static readonly BindableProperty ViewHeaderHeightProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    ViewHeaderStyleProperty

    Gets or sets the View Header Style for schedule to customize the appearance of view header view in schedule. This is a bindable property.

    Declaration
    public static readonly BindableProperty ViewHeaderStyleProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    VisibleDatesChangedCommandProperty

    Gets or sets the Visible Dates Changed Command to be executed when navigate or view type change of schedule. This is a bindable property.

    Declaration
    public static readonly BindableProperty VisibleDatesChangedCommandProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    WeekViewSettingsProperty

    Gets or sets the Week View Settings property for schedule to customize the appearance of week view in schedule. This is a bindable property.

    Declaration
    public static readonly BindableProperty WeekViewSettingsProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    WorkWeekViewSettingsProperty

    Gets or sets the Work Week View Settings for schedule to customize the appearance of work week view in schedule. This is a bindable property.

    Declaration
    public static readonly BindableProperty WorkWeekViewSettingsProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    Properties

    AllowAppointmentDrag

    Gets or sets a value indicating whether the schedule can allows the appointment to drag or not on the view.

    Declaration
    public bool AllowAppointmentDrag { get; set; }
    Property Value
    Type Description
    System.Boolean

    true if allow appointment drag; otherwise, false.

    AppointmentMapping

    Gets or sets the Appointment Mapping for schedule to map the custom appointment properties to schedule appointment properties.

    Declaration
    public ScheduleAppointmentMapping AppointmentMapping { get; set; }
    Property Value
    Type Description
    ScheduleAppointmentMapping

    This property takes the ScheduleAppointmentMapping value.

    Remarks

    AppointmentMapping need to be specified, when custom class collection is provided as DataSource for Schedule.

    AppointmentStyle

    Gets or sets the Appointment Style for Schedule to customize the appearance of displaying appointment in schedule.

    Declaration
    public AppointmentStyle AppointmentStyle { get; set; }
    Property Value
    Type Description
    AppointmentStyle

    This property takes the AppointmentStyle value.

    AppointmentTemplate

    Gets or sets the Appointment Template to customize the appointment's default UI with custom UI in schedule.

    Declaration
    public DataTemplate AppointmentTemplate { get; set; }
    Property Value
    Type Description
    Xamarin.Forms.DataTemplate

    The appointment template.

    AppointmentViewLayout

    Gets or sets the Appointment view layout for schedule to render the custom appointment view layout with default or overlay layout option.

    Declaration
    public ViewLayoutOptions AppointmentViewLayout { get; set; }
    Property Value
    Type Description
    ViewLayoutOptions

    This property takes the AppointmentViewLayout value.

    BackgroundColor

    Gets or sets the color of the background.

    Declaration
    public Color BackgroundColor { get; set; }
    Property Value
    Type Description
    Xamarin.Forms.Color

    The color of the background.

    CellDoubleTappedCommand

    Gets or sets the Schedule cell double tapped command which is executed when schedule cell is tapped twice.

    Declaration
    public ICommand CellDoubleTappedCommand { get; set; }
    Property Value
    Type Description
    System.Windows.Input.ICommand

    The cell double tapped command.

    CellLongPressedCommand

    Gets or sets the Schedule cell long pressed command which is executed when schedule cell is Holden or long pressed.

    Declaration
    public ICommand CellLongPressedCommand { get; set; }
    Property Value
    Type Description
    System.Windows.Input.ICommand

    The cell long pressed command.

    CellTappedCommand

    Gets or sets the Cell tapped command for schedule which is executed when the cell tapped in schedule.

    Declaration
    public ICommand CellTappedCommand { get; set; }
    Property Value
    Type Description
    System.Windows.Input.ICommand

    The cell tapped command.

    CurrentTimeIndicatorColor

    Gets or sets a value indicating color of the current time indicator. This is a bindable property.

    Declaration
    public Color CurrentTimeIndicatorColor { get; set; }
    Property Value
    Type Description
    Xamarin.Forms.Color

    The color of the current time indicator.

    Remarks

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

    DataSource

    Gets or sets the Data Source property for schedule which is used to set the appointment collection to schedule.

    Declaration
    public IEnumerable DataSource { get; set; }
    Property Value
    Type Description
    System.Collections.IEnumerable

    This property takes the System.Collections.IEnumerable value.

    Remarks

    DataSource can take IEnumarable collection of both ScheduleAppointment or custom class. When custom class collection is provided, it is necessary to map the custom class with schedule using AppointmentMapping.

    DayViewSettings

    Gets or sets Day View Settings property for schedule to customize and configure the appearance of day view in schedule.

    Declaration
    public DayViewSettings DayViewSettings { get; set; }
    Property Value
    Type Description
    DayViewSettings

    This property takes the DayViewSettings value.

    DragDropSettings

    Gets or sets the drag drop settings it has properties to customize the drag and drop operations of appointments in schedule.

    Declaration
    public DragDropSettings DragDropSettings { get; set; }
    Property Value
    Type Description
    DragDropSettings

    The drag drop settings.

    EnableNavigation

    Gets or sets a value indicating whether the schedule can enable navigation or not to it's previous/next view.

    Declaration
    public bool EnableNavigation { get; set; }
    Property Value
    Type Description
    System.Boolean

    This property takes the System.Boolean value.

    FirstDayOfWeek

    Gets or sets or set the First Day of Week for schedule to modify the default first day of the week with any day in schedule.

    Declaration
    public int FirstDayOfWeek { get; set; }
    Property Value
    Type Description
    System.Int32

    This property takes the System.Int32 value.

    HeaderHeight

    Gets or sets the Header Height property for schedule to customize the default height of the schedule header view.

    Declaration
    public double HeaderHeight { get; set; }
    Property Value
    Type Description
    System.Double

    This property takes the System.Double value.

    HeaderStyle

    Gets or sets the Header Style for Schedule to customize and configure the appearance of header view in schedule.

    Declaration
    public HeaderStyle HeaderStyle { get; set; }
    Property Value
    Type Description
    HeaderStyle

    This property takes the HeaderStyle value.

    InlineView

    Gets or sets the InlineView for Schedule MonthView it replaces the default inline view UI with given custom UI in schedule.

    Declaration
    public View InlineView { get; set; }
    Property Value
    Type Description
    Xamarin.Forms.View

    This property takes the Xamarin.Forms.View value.

    Locale

    Gets or sets the Locale value for schedule to localize the schedule default strings with given language.

    Declaration
    public string Locale { get; set; }
    Property Value
    Type Description
    System.String

    This property takes the System.String value.

    MaxDisplayDate

    Gets or sets the Max Display Date value for schedule to restrict the visible from navigate beyond the date.

    Declaration
    public DateTime MaxDisplayDate { get; set; }
    Property Value
    Type Description
    System.DateTime

    This property takes the System.DateTime value.

    MinDisplayDate

    Gets or sets the Min Display Date value for schedule to restrict the visible view from navigate behind the date.

    Declaration
    public DateTime MinDisplayDate { get; set; }
    Property Value
    Type Description
    System.DateTime

    This property takes the System.DateTime value.

    MonthCellStyle

    Gets or sets the Month View Cell Style for schedule to customize and configure the month view cell in month view of schedule.

    Declaration
    public MonthViewCellStyle MonthCellStyle { get; set; }
    Property Value
    Type Description
    MonthViewCellStyle

    This property takes the MonthCellStyle value.

    MonthCellViewLayout

    Gets or sets the MonthCellViewLayout property is used to define the View of the Schedule. This is a bindable property.

    Declaration
    public ViewLayoutOptions MonthCellViewLayout { get; set; }
    Property Value
    Type Description
    ViewLayoutOptions

    This property takes the MonthCellViewLayout value.

    MonthViewSettings

    Gets or sets the MonthViewSettings property is used to configure the Month View in the Schedule. This is a bindable property.

    Declaration
    public MonthViewSettings MonthViewSettings { get; set; }
    Property Value
    Type Description
    MonthViewSettings

    This property takes the MonthViewSettings value.

    MoveToDate

    Gets or sets the Move To Date value for schedule which navigates the schedule to the particular date and time value.

    Declaration
    public DateTime MoveToDate { get; set; }
    Property Value
    Type
    System.DateTime

    ResourceItemTemplate

    Gets or sets the Resource Item Template to replace the default UI of resource view with given custom UI.

    Declaration
    public DataTemplate ResourceItemTemplate { get; set; }
    Property Value
    Type Description
    Xamarin.Forms.DataTemplate

    The resource item template.

    ResourceMapping

    Gets or sets the Resource Mapping for schedule to map the custom resource properties to schedule resource properties.

    Declaration
    public ResourceMapping ResourceMapping { get; set; }
    Property Value
    Type
    ResourceMapping

    ResourceViewHeight

    Gets or sets the Resource View height for schedule to customize the default height of resource container view in the Schedule.

    Declaration
    public int ResourceViewHeight { get; set; }
    Property Value
    Type Description
    System.Int32

    Resource view height.

    Remarks

    If schedule view is timeline view and ResourceViewMode is Absolute, it is considered as width for resource view.

    ResourceViewMode

    Gets or sets resource view mode property which defines the mode of resource view to display in schedule.

    Declaration
    public ResourceViewMode ResourceViewMode { get; set; }
    Property Value
    Type
    ResourceViewMode
    Remarks

    ResourceViewMode Absolute option is applicable only for timeline view.

    ResourceViewSettings

    Gets or sets the resource view settings to customize and configure the appearance of resource view in schedule.

    Declaration
    public ResourceViewSettings ResourceViewSettings { get; set; }
    Property Value
    Type Description
    ResourceViewSettings

    Resource view settings.

    ScheduleHeaderDateFormat

    Gets or sets the Schedule Header Date Format for schedule to customize the displaying date format in the schedule header view.

    Declaration
    public string ScheduleHeaderDateFormat { get; set; }
    Property Value
    Type Description
    System.String

    This property takes the System.String value.

    ScheduleResources

    Gets or sets the Schedule Resources for Schedule which is used to set the resource collection for schedule.

    Declaration
    public ObservableCollection<object> ScheduleResources { get; set; }
    Property Value
    Type
    System.Collections.ObjectModel.ObservableCollection<System.Object>

    ScheduleView

    Gets or sets the Schedule View property for Schedule which defines the view to be display in schedule.

    Declaration
    public ScheduleView ScheduleView { get; set; }
    Property Value
    Type Description
    ScheduleView

    This property takes the ScheduleView value.

    SelectedDate

    Gets or sets the Selected Date property for schedule to select a particular date or time slot programmatically.

    Declaration
    public Nullable<DateTime> SelectedDate { get; set; }
    Property Value
    Type Description
    System.Nullable<System.DateTime>

    This property takes the System.DateTime value.

    SelectedResources

    Gets or sets the Selected resources property for schedule to select the resource view programmatically on schedule.

    Declaration
    public ObservableCollection<object> SelectedResources { get; set; }
    Property Value
    Type Description
    System.Collections.ObjectModel.ObservableCollection<System.Object>

    Selected resources.

    SelectionStyle

    Gets or sets the Selection Style property for schedule to customize the appearance of selection view in schedule.

    Declaration
    public SelectionStyle SelectionStyle { get; set; }
    Property Value
    Type Description
    SelectionStyle

    This property takes the AppointmentStyle value.

    SelectionView

    Gets or sets the Selection View for schedule which replaces the selection view's default UI view with given Custom UI view.

    Declaration
    public View SelectionView { get; set; }
    Property Value
    Type Description
    Xamarin.Forms.View

    This property takes the Xamarin.Forms.View value.

    ShowAppointmentsInline

    Gets or sets a value indicating whether the ShowAppointmentsInline property is used to enable/disable the inline appointments view. This is a bindable property.

    Declaration
    public bool ShowAppointmentsInline { get; set; }
    Property Value
    Type Description
    System.Boolean

    This property takes the System.Boolean value.

    Remarks

    It's applicable in MonthView, WeekView and WorkWeekView for WindowsPhone, whereas only for MonthView in Android and iOS.

    ShowCurrentTimeIndicator

    Gets or sets a value indicating whether the ShowCurrentTimeIndicator property is used to enable/disable the current time indicator. This is a bindable property.

    Declaration
    public bool ShowCurrentTimeIndicator { get; set; }
    Property Value
    Type Description
    System.Boolean

    This property takes the System.Boolean value.

    Remarks

    It's applicable in day view, week view, workweekview and timelineview.

    ShowResourceView

    Gets or sets a value indicating whether schedule can show the resource view or not in the schedule views.

    Declaration
    public bool ShowResourceView { get; set; }
    Property Value
    Type
    System.Boolean

    SpecialTimeRegions

    Gets or sets the special time regions of the schedule.

    Declaration
    public ObservableCollection<TimeRegionSettings> SpecialTimeRegions { get; set; }
    Property Value
    Type Description
    System.Collections.ObjectModel.ObservableCollection<TimeRegionSettings>

    The special time regions.

    TimeInterval

    Gets or sets the Time Interval property for schedule to customize the default time interval between time slots in schedule.

    Declaration
    public double TimeInterval { get; set; }
    Property Value
    Type Description
    System.Double

    This property takes the System.DateTime value.

    TimeIntervalHeight

    Gets or sets the Time Interval Height property for schedule to customize the default height of time slot in schedule.

    Declaration
    public double TimeIntervalHeight { get; set; }
    Property Value
    Type Description
    System.Double

    This property takes the System.DateTime value.

    TimelineViewSettings

    Gets or sets the TimelineViewSettings property is used to configure the Timeline view in the Schedule. This is a bindable property.

    Declaration
    public TimelineViewSettings TimelineViewSettings { get; set; }
    Property Value
    Type Description
    TimelineViewSettings

    This property takes the TimelineViewSettings value.

    TimeZone

    Gets or sets the Time zone property for schedule to customize the default time zone of schedule with particular time zone.

    Declaration
    public string TimeZone { get; set; }
    Property Value
    Type Description
    System.String

    This property takes the System.String value.

    ViewHeaderHeight

    Gets or sets the View Header Height for schedule to customize the default height of view header view in schedule.

    Declaration
    public double ViewHeaderHeight { get; set; }
    Property Value
    Type Description
    System.Double

    This property takes the System.Double value.

    ViewHeaderStyle

    Gets or sets the View Header Style for schedule to customize the appearance of view header view in schedule.

    Declaration
    public ViewHeaderStyle ViewHeaderStyle { get; set; }
    Property Value
    Type Description
    ViewHeaderStyle

    This property takes the ViewHeaderStyle value.

    VisibleDatesChangedCommand

    Gets or sets the Visible Dates Changed Command to be executed when navigate or view type change of schedule.

    Declaration
    public ICommand VisibleDatesChangedCommand { get; set; }
    Property Value
    Type Description
    System.Windows.Input.ICommand

    The visible dates changed command.

    WeekViewSettings

    Gets or sets the Week View Settings property for schedule to customize the appearance of week view in schedule.

    Declaration
    public WeekViewSettings WeekViewSettings { get; set; }
    Property Value
    Type Description
    WeekViewSettings

    This property takes the WeekViewSettings value.

    WorkWeekViewSettings

    Gets or sets the Work Week View Settings for schedule to customize the appearance of work week view in schedule.

    Declaration
    public WorkWeekViewSettings WorkWeekViewSettings { get; set; }
    Property Value
    Type Description
    WorkWeekViewSettings

    This property takes the WorkWeekViewSettings value.

    Methods

    Backward()

    Navigates the schedule in Backward direction to display the previous visible date(s) of the corresponding view.

    Declaration
    public void Backward()

    Dispose()

    Releases all the managed and unmanaged resourced used by schedule object to reduce the memory usage.

    Declaration
    public void Dispose()
    Remarks

    Call Dispose() when you are finished using the SfSchedule. The Dispose() method leaves the SfSchedule in an unusable state. After calling Dispose(), you must release all references to the SfSchedule so the garbage collector can reclaim the memory that the SfSchedule was occupying.

    Dispose(Boolean)

    Disposing all resource used by the SfSchedule object.

    Declaration
    protected virtual void Dispose(bool disposing)
    Parameters
    Type Name Description
    System.Boolean disposing

    Dispose.

    Forward()

    Navigates the schedule in Forward direction to display the next visible date(s) of the corresponding view.

    Declaration
    public void Forward()

    GetRecurrenceDateTimeCollection(String, DateTime, Nullable<DateTime>, Nullable<DateTime>)

    Gets the date collection from the RRule, recStartDate, rangeStartDate, rangeEndDate.

    Declaration
    public IEnumerable<DateTime> GetRecurrenceDateTimeCollection(string rRule, DateTime recStartDate, Nullable<DateTime> rangeStartDate = null, Nullable<DateTime> rangeEndDate = null)
    Parameters
    Type Name Description
    System.String rRule

    Recurrence rule.

    System.DateTime recStartDate

    Recurrence start date.

    System.Nullable<System.DateTime> rangeStartDate

    Range start date.

    System.Nullable<System.DateTime> rangeEndDate

    Range end date.

    Returns
    Type Description
    System.Collections.Generic.IEnumerable<System.DateTime>

    Recurrence date time collection.

    GetVisibleAppointments(DateTime, Nullable<DateTime>)

    Get visible appointment within the given dates.

    Declaration
    public List<ScheduleAppointment> GetVisibleAppointments(DateTime startDate, Nullable<DateTime> endDate = null)
    Parameters
    Type Name Description
    System.DateTime startDate

    Start date.

    System.Nullable<System.DateTime> endDate

    End date.

    Returns
    Type Description
    System.Collections.Generic.List<ScheduleAppointment>

    List of ScheduleAppointment within the specified date range.

    NavigateTo(DateTime)

    Navigates the schedule visible view to based on the given date and time value of the date parameter.

    Declaration
    public void NavigateTo(DateTime date)
    Parameters
    Type Name Description
    System.DateTime date

    Date.

    OnMeasure(Double, Double)

    Measures the children.

    Declaration
    protected override SizeRequest OnMeasure(double widthConstraint, double heightConstraint)
    Parameters
    Type Name Description
    System.Double widthConstraint

    Width.

    System.Double heightConstraint

    Height.

    Returns
    Type Description
    Xamarin.Forms.SizeRequest

    SizeRequest.

    ResumeAppointmentUpdate()

    Resume the appointment collection update for schedule to update the appointments to schedule data source.

    Declaration
    public void ResumeAppointmentUpdate()

    RRuleGenerator(RecurrenceProperties, DateTime, DateTime)

    Gets the RRule string value from the RecurrenceProperties, Appointment StartTime and EndTime.

    Declaration
    public string RRuleGenerator(RecurrenceProperties recurrenceProperties, DateTime startTime, DateTime endTime)
    Parameters
    Type Name Description
    RecurrenceProperties recurrenceProperties

    Recurrence properties.

    System.DateTime startTime

    Start time.

    System.DateTime endTime

    End time.

    Returns
    Type Description
    System.String

    Recurrence rule.

    RRuleParser(String, DateTime)

    Returns the recurrence properties details for the recurring appointment from the given recurrence rule and the recurrence start date.

    Declaration
    public RecurrenceProperties RRuleParser(string rRule, DateTime recStartDate)
    Parameters
    Type Name Description
    System.String rRule

    Recurrence rule.

    System.DateTime recStartDate

    Recurrence start date.

    Returns
    Type Description
    RecurrenceProperties

    Recurrence properties.

    SuspendAppointmentUpdate()

    Suspends the appointment collection update for schedule to prevent the data source collection update until the resume appointment update method call.

    Declaration
    public void SuspendAppointmentUpdate()

    Events

    AppointmentDragOver

    The Appointment Drag Over Event will raised when the appointment is dragging over the view in schedule

    Declaration
    public event EventHandler<AppointmentDragEventArgs> AppointmentDragOver
    Event Type
    Type
    System.EventHandler<AppointmentDragEventArgs>

    AppointmentDragStarting

    The Appointment Drag Starting Event Will be raised when an appointment starts to drag on the view in schedule

    Declaration
    public event EventHandler<AppointmentDragStartingEventArgs> AppointmentDragStarting
    Event Type
    Type
    System.EventHandler<AppointmentDragStartingEventArgs>

    AppointmentDrop

    The Appointment Drop Event will be raised when the dragging appointment is drop on the view in schedule

    Declaration
    public event EventHandler<AppointmentDropEventArgs> AppointmentDrop
    Event Type
    Type
    System.EventHandler<AppointmentDropEventArgs>

    CellDoubleTapped

    Event that is raised when tapped twice on any appointment or time slot or month cell of Schedule.

    Declaration
    public event EventHandler<CellTappedEventArgs> CellDoubleTapped
    Event Type
    Type
    System.EventHandler<CellTappedEventArgs>

    CellLongPressed

    Event that is raised when pressed and hold on any appointment or time slot or month cell of Schedule.

    Declaration
    public event EventHandler<CellTappedEventArgs> CellLongPressed
    Event Type
    Type
    System.EventHandler<CellTappedEventArgs>

    CellTapped

    Event that is raised when tapped on any appointment or time slot or month cell of Schedule.

    Declaration
    public event EventHandler<CellTappedEventArgs> CellTapped
    Event Type
    Type
    System.EventHandler<CellTappedEventArgs>

    HeaderTapped

    The Header Tapped Event will be raised when tapped on the header view of schedule it contains the Header Tapped Event Argument

    Declaration
    public event EventHandler<HeaderTappedEventArgs> HeaderTapped
    Event Type
    Type
    System.EventHandler<HeaderTappedEventArgs>

    MonthInlineAppointmentTapped

    Event that is raised when tapped on any appointment which are listed in month view of schedule.

    Declaration
    public event EventHandler<MonthInlineAppointmentTappedEventArgs> MonthInlineAppointmentTapped
    Event Type
    Type
    System.EventHandler<MonthInlineAppointmentTappedEventArgs>

    OnAppointmentLoadedEvent

    Event that is raised when an appointment is loaded in the schedule view (day view, work view or month view).

    Declaration
    public event EventHandler<AppointmentLoadedEventArgs> OnAppointmentLoadedEvent
    Event Type
    Type
    System.EventHandler<AppointmentLoadedEventArgs>

    OnMonthCellLoadedEvent

    Event that is raised when each cells (for every date) for month view of schedule loaded.

    Declaration
    public event EventHandler<MonthCellLoadedEventArgs> OnMonthCellLoadedEvent
    Event Type
    Type
    System.EventHandler<MonthCellLoadedEventArgs>

    OnMonthInlineAppointmentLoadedEvent

    Event that is raised while list of appointments loaded in inline view when tapped on any date in the month view.

    Declaration
    public event EventHandler<MonthInlineAppointmentLoadedEventArgs> OnMonthInlineAppointmentLoadedEvent
    Event Type
    Type
    System.EventHandler<MonthInlineAppointmentLoadedEventArgs>

    OnMonthInlineLoadedEvent

    Event that is raised while inline view is loaded when tapped on any date in the month view.

    Declaration
    public event EventHandler<MonthInlineLoadedEventArgs> OnMonthInlineLoadedEvent
    Event Type
    Type
    System.EventHandler<MonthInlineLoadedEventArgs>

    ResourceItemTapped

    The Resource item tapped Event that is raised when any schedule resource item view tapped on the schedule.

    Declaration
    public event EventHandler<ResourceItemTappedEventArgs> ResourceItemTapped
    Event Type
    Type
    System.EventHandler<ResourceItemTappedEventArgs>

    ViewHeaderTapped

    Event that is raised when tapped on the view header layout of Schedule.

    Declaration
    public event EventHandler<ViewHeaderTappedEventArgs> ViewHeaderTapped
    Event Type
    Type
    System.EventHandler<ViewHeaderTappedEventArgs>

    VisibleDatesChangedEvent

    Event that is raised when visible dates changed due to date navigation or when view type changed.

    Declaration
    public event EventHandler<VisibleDatesChangedEventArgs> VisibleDatesChangedEvent
    Event Type
    Type
    System.EventHandler<VisibleDatesChangedEventArgs>

    Implements

    System.IDisposable
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved