Xamarin.iOS

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class SFCalendar - Xamarin.iOS API Reference | Syncfusion

    Show / Hide Table of Contents

    Class SFCalendar

    Calendar widget provides the multi-view representation to display and select one or more dates within specified ranges. Also provides a gesture friendly UI to perform operations like navigations, events, etc.

    Inheritance
    System.Object
    SFCalendar
    Namespace: Syncfusion.SfCalendar.iOS
    Assembly: Syncfusion.SfCalendar.iOS.dll
    Syntax
    public class SFCalendar : UIView

    Constructors

    SFCalendar()

    Initializes a new instance of the SFCalendar class

    Declaration
    public SFCalendar()

    SFCalendar(RectangleF)

    Initializes a new instance of the SFCalendar class

    Declaration
    public SFCalendar(RectangleF frame)
    Parameters
    Type Name Description
    System.Drawing.RectangleF frame

    Frame for calendar

    SFCalendar(IntPtr)

    Initializes a new instance of the SFCalendar class

    Declaration
    public SFCalendar(IntPtr handle)
    Parameters
    Type Name Description
    System.IntPtr handle

    Handle value

    Properties

    AgendaViewHeight

    Gets or sets the height of the agenda view.

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

    The height of the agenda view.

    Appointments

    Gets or sets the appointments.

    Declaration
    public NSMutableArray Appointments { get; set; }
    Property Value
    Type Description
    Foundation.NSMutableArray

    The appointments.

    BlackoutDates

    Gets or sets the blackout dates.

    Declaration
    public NSMutableArray BlackoutDates { get; set; }
    Property Value
    Type Description
    Foundation.NSMutableArray

    The blackout dates.

    BlackoutDatesViewMode

    Gets or sets the black out dates view mode property for month view to define the appearance of blackout dates in calendar

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

    The view mode.

    CustomDayLabels

    Gets or sets the custom day labels.

    Declaration
    public NSMutableArray CustomDayLabels { get; set; }
    Property Value
    Type Description
    Foundation.NSMutableArray

    The custom day labels.

    DisplayDate

    Gets the display date.

    Declaration
    public NSDate DisplayDate { get; }
    Property Value
    Type Description
    Foundation.NSDate

    The display date.

    EnableAddDatesInPast

    Gets or sets a value indicating whether this SFCalendar enable add dates in past.

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

    true if enable add dates in past; otherwise, false.

    EnableInLine

    Gets or sets a value indicating whether this SFCalendar enable in line.

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

    true if enable in line; otherwise, false.

    EnableNavigation

    Gets or sets a value indicating whether this SFCalendar enable navigation.

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

    true if enable navigation; otherwise, false.

    FirstDayofWeek

    Gets or sets the first day of week.

    Declaration
    public nint FirstDayofWeek { get; set; }
    Property Value
    Type Description
    System.nint

    The first day of week.

    Frame

    Gets or sets the frame.

    Declaration
    public override CGRect Frame { get; set; }
    Property Value
    Type Description
    CoreGraphics.CGRect

    The frame.

    HeaderHeight

    Gets or sets the height of the header.

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

    The height of the header.

    HeaderView

    Gets or sets the header view.

    Declaration
    public UIView HeaderView { get; set; }
    Property Value
    Type Description
    UIKit.UIView

    The header view.

    InlineViewMode

    Gets or sets the inline view mode.

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

    The inline view mode.

    IsNullSelectedDate

    Gets or sets a value indicating whether this SFCalendar is null selected date.

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

    true if is null selected date; otherwise, false.

    Locale

    Gets or sets the locale.

    Declaration
    public NSLocale Locale { get; set; }
    Property Value
    Type Description
    Foundation.NSLocale

    The locale.

    MaxDate

    Gets or sets the max date.

    Declaration
    public NSDate MaxDate { get; set; }
    Property Value
    Type Description
    Foundation.NSDate

    The max date.

    MaximumEventIndicatorCount

    Gets or sets the maximum event indicator count.

    Declaration
    public nint MaximumEventIndicatorCount { get; set; }
    Property Value
    Type Description
    System.nint

    The maximum event indicator count.

    MinDate

    Gets or sets the minimum date.

    Declaration
    public NSDate MinDate { get; set; }
    Property Value
    Type Description
    Foundation.NSDate

    The minimum date.

    MonthViewSettings

    Gets or sets the month view settings.

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

    The month view settings.

    NavigateToMonthOnInActiveDatesSelection

    Gets or sets a value indicating whether this SFCalendar navigate to month on in active dates selection.

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

    true if navigate to month on in active dates selection; otherwise, false.

    NavigationArrowThickness

    Gets or sets the navigation arrow thickness.

    Declaration
    public nfloat NavigationArrowThickness { get; set; }
    Property Value
    Type Description
    System.nfloat

    The navigation arrow thickness.

    NavigationButtonHeight

    Gets or sets the height of the navigation button.

    Declaration
    public nfloat NavigationButtonHeight { get; set; }
    Property Value
    Type Description
    System.nfloat

    The height of the navigation button.

    NavigationButtonWidth

    Gets or sets the width of the navigation button.

    Declaration
    public nfloat NavigationButtonWidth { get; set; }
    Property Value
    Type Description
    System.nfloat

    The width of the navigation button.

    NavigationDirection

    Gets or sets the navigation direction.

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

    The navigation direction.

    NumberOfWeeksInView

    Gets or sets the number of weeks in view.

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

    The number of weeks in view.

    SelectedDate

    Gets or sets the selected date.

    Declaration
    public NSDate SelectedDate { get; set; }
    Property Value
    Type Description
    Foundation.NSDate

    The selected date.

    SelectedDates

    Gets or sets the selected dates.

    Declaration
    public NSMutableArray SelectedDates { get; set; }
    Property Value
    Type Description
    Foundation.NSMutableArray

    The selected dates.

    SelectedRange

    Gets or sets the selected range.

    Declaration
    public SFMonthDateRange SelectedRange { get; set; }
    Property Value
    Type Description
    SFMonthDateRange

    The selected range.

    SelectedRanges

    Gets or sets the selected ranges.

    Declaration
    public NSMutableArray SelectedRanges { get; set; }
    Property Value
    Type Description
    Foundation.NSMutableArray

    The selected ranges.

    SelectionMode

    Gets or sets the selection mode.

    Declaration
    public SFCalenderSelectionMode SelectionMode { get; set; }
    Property Value
    Type Description
    SFCalenderSelectionMode

    The selection mode.

    ShowHeader

    Gets or sets a value indicating whether this SFCalendar show header.

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

    true if show header; otherwise, false.

    ShowLeadingAndTrailingDays

    Gets or sets a value indicating whether this SFCalendar show leading and trailing days.

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

    true if show leading and trailing days; otherwise, false.

    ShowNavigationButtons

    Gets or sets a value indicating whether this SFCalendar show navigation buttons.

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

    true if show navigation buttons; otherwise, false.

    ShowYearView

    Gets or sets a value indicating whether this SFCalendar show year view.

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

    true if show year view; otherwise, false.

    ToggleDateSelection

    Gets or sets a value indicating whether this SFCalendar toggle date selection.

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

    true if toggle date selection; otherwise, false.

    TransitionType

    Gets or sets the type of the transition.

    Declaration
    public SFCalendarTransitionType TransitionType { get; set; }
    Property Value
    Type Description
    SFCalendarTransitionType

    The type of the transition.

    ViewMode

    Gets or sets the view mode

    Declaration
    public SFCalendarViewMode ViewMode { get; set; }
    Property Value
    Type Description
    SFCalendarViewMode

    VisibleDates

    Gets the visible dates

    Declaration
    public NSMutableArray VisibleDates { get; }
    Property Value
    Type Description
    Foundation.NSMutableArray

    YearViewMode

    Gets or sets the view mode

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

    YearViewSettings

    Gets or sets the year view settings.

    Declaration
    public SFYearViewSettings YearViewSettings { get; set; }
    Property Value
    Type Description
    SFYearViewSettings

    The year view settings.

    Methods

    AddDatesInPast()

    Adds the dates in past.

    Declaration
    public void AddDatesInPast()

    AwakeFromNib()

    Awake from nib.

    Declaration
    public override void AwakeFromNib()

    ClearSelection()

    Method to clear the date selection in calendar.

    Declaration
    public void ClearSelection()

    CollapseInlineView(NSDate)

    Collapses the inline view.

    Declaration
    public void CollapseInlineView(NSDate date)
    Parameters
    Type Name Description
    Foundation.NSDate date

    Date value

    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

    ExpandInlineView(NSDate)

    Expands the inline view.

    Declaration
    public void ExpandInlineView(NSDate date)
    Parameters
    Type Name Description
    Foundation.NSDate date

    Date value

    LayoutSubviews()

    Layouts the sub views.

    Declaration
    public override void LayoutSubviews()

    MoveToDate(NSDate)

    Moves to date.

    Declaration
    public void MoveToDate(NSDate dateNeedToBeMoved)
    Parameters
    Type Name Description
    Foundation.NSDate dateNeedToBeMoved

    Date need to be moved.

    MoveToNextView()

    Moves to next view.

    Declaration
    public void MoveToNextView()

    MoveToPrevView()

    Moves to previous view.

    Declaration
    public void MoveToPrevView()

    Refresh()

    Refresh this instance.

    Declaration
    public void Refresh()

    ReloadData()

    Refresh appointment views in current view.

    Declaration
    public void ReloadData()

    Events

    CalendarTapped

    Occurs when the calendar tapped

    Declaration
    public event EventHandler<CalendarTappedEventArgs> CalendarTapped
    Event Type
    Type Description
    System.EventHandler<CalendarTappedEventArgs>

    DateCellHolding

    Occurs when the date cell holding

    Declaration
    public event EventHandler<DateCellHoldingEventArgs> DateCellHolding
    Event Type
    Type Description
    System.EventHandler<DateCellHoldingEventArgs>

    DrawHeaderView

    Occurs when header loaded

    Declaration
    public event EventHandler<DrawHeaderViewEventArgs> DrawHeaderView
    Event Type
    Type Description
    System.EventHandler<DrawHeaderViewEventArgs>

    DrawInlineView

    Occurs when inline loaded

    Declaration
    public event EventHandler<DrawInlineViewEventArgs> DrawInlineView
    Event Type
    Type Description
    System.EventHandler<DrawInlineViewEventArgs>

    DrawMonthCell

    Occurs when month cell loaded

    Declaration
    public event EventHandler<DrawMonthCellEventArgs> DrawMonthCell
    Event Type
    Type Description
    System.EventHandler<DrawMonthCellEventArgs>

    DrawYearCell

    Occurs when the year cell loaded

    Declaration
    public event EventHandler<DrawYearCellEventArgs> DrawYearCell
    Event Type
    Type Description
    System.EventHandler<DrawYearCellEventArgs>

    InlineItemLoaded

    Occurs when inline loaded.

    Declaration
    public event EventHandler<InlineItemLoadedEventArgs> InlineItemLoaded
    Event Type
    Type Description
    System.EventHandler<InlineItemLoadedEventArgs>

    InlineItemTapped

    Occurs when inline item tapped.

    Declaration
    public event EventHandler<InlineItemTappedEventArgs> InlineItemTapped
    Event Type
    Type Description
    System.EventHandler<InlineItemTappedEventArgs>

    InlineToggled

    Occurs when inline toggled

    Declaration
    public event EventHandler<InlineToggledEventArgs> InlineToggled
    Event Type
    Type Description
    System.EventHandler<InlineToggledEventArgs>

    MonthChanged

    Occurs when the month changed

    Declaration
    public event EventHandler<MonthChangedEventArgs> MonthChanged
    Event Type
    Type Description
    System.EventHandler<MonthChangedEventArgs>

    MonthChanging

    Occurs when the month changing

    Declaration
    public event EventHandler<MonthChangingEventArgs> MonthChanging
    Event Type
    Type Description
    System.EventHandler<MonthChangingEventArgs>

    SelectionChanged

    Occurs when selection changed

    Declaration
    public event EventHandler<SelectionChangedEventArgs> SelectionChanged
    Event Type
    Type Description
    System.EventHandler<SelectionChangedEventArgs>

    ViewModeChanged

    Occurs when view mode changed

    Declaration
    public event EventHandler<ViewModeChangedEventArgs> ViewModeChanged
    Event Type
    Type Description
    System.EventHandler<ViewModeChangedEventArgs>
    Back to top Generated by DocFX
    Copyright © 2001 - 2021 Syncfusion Inc. All Rights Reserved