Class MonthViewSettings

The Month View Settings class contains properties to customize and configure the appearance of the month view.

Inheritance

System.Object

MonthViewSettings

Namespace: Syncfusion.SfSchedule.XForms

Assembly: Syncfusion.SfSchedule.XForms.dll

Syntax

public class MonthViewSettings : Element, IThemeElement

Constructors

MonthViewSettings()

Initializes a new instance of the MonthViewSettings class.

Declaration

public MonthViewSettings()

Fields

AgendaItemTemplateProperty

Gets or sets the Agenda Item Template. This is a bindable property.

Declaration

public static readonly BindableProperty AgendaItemTemplateProperty

Field Value

Type	Description
Xamarin.Forms.BindableProperty

AgendaViewHeightProperty

Gets or sets the AgendaViewHeight property in MonthView.This is bindabel property.

Declaration

public static readonly BindableProperty AgendaViewHeightProperty

Field Value

Type	Description
Xamarin.Forms.BindableProperty

AgendaViewStyleProperty

The agenda view style property.

Declaration

public static readonly BindableProperty AgendaViewStyleProperty

Field Value

Type	Description
Xamarin.Forms.BindableProperty

AppointmentDisplayCountProperty

Gets or sets the Appointment Display Count property. This is a bindable property.

Declaration

public static readonly BindableProperty AppointmentDisplayCountProperty

Field Value

Type	Description
Xamarin.Forms.BindableProperty

AppointmentDisplayModeProperty

Gets or sets the AppointmentDisplayMode property.

Declaration

public static readonly BindableProperty AppointmentDisplayModeProperty

Field Value

Type	Description
Xamarin.Forms.BindableProperty

AppointmentIndicatorCountProperty

Gets or sets the Indicator Count property.

Declaration

public static readonly BindableProperty AppointmentIndicatorCountProperty

Field Value

Type	Description
Xamarin.Forms.BindableProperty

BlackoutDatesProperty

Gets or sets the BlackoutDates property.

Declaration

public static readonly BindableProperty BlackoutDatesProperty

Field Value

Type	Description
Xamarin.Forms.BindableProperty

MonthCellTemplateProperty

Gets or sets the Month Cell Template to customize the Default month view's month cell UI with custom UI. This is a bindable property.

Declaration

public static readonly BindableProperty MonthCellTemplateProperty

Field Value

Type	Description
Xamarin.Forms.BindableProperty

MonthNavigationDirectionProperty

Gets or sets the SwipeDirection property.

Declaration

public static readonly BindableProperty MonthNavigationDirectionProperty

Field Value

Type	Description
Xamarin.Forms.BindableProperty

MonthViewLabelSettingsProperty

Gets or sets the MonthLabelSettings property.

Declaration

public static readonly BindableProperty MonthViewLabelSettingsProperty

Field Value

Type	Description
Xamarin.Forms.BindableProperty

SelectionTextColorProperty

Gets or sets Selection Text Color to customize the displaying text color of the selected date in month view. This is a bindable property.

Declaration

public static readonly BindableProperty SelectionTextColorProperty

Field Value

Type	Description
Xamarin.Forms.BindableProperty

ShowAgendaViewProperty

Gets or sets the ShowAgendaView property.

Declaration

public static readonly BindableProperty ShowAgendaViewProperty

Field Value

Type	Description
Xamarin.Forms.BindableProperty

ShowWeekNumberProperty

Gets or sets the ShowWeekNumber property.

Declaration

public static readonly BindableProperty ShowWeekNumberProperty

Field Value

Type	Description
Xamarin.Forms.BindableProperty

TodayBackgroundProperty

The today's circle background property.

Declaration

public static readonly BindableProperty TodayBackgroundProperty

Field Value

Type	Description
Xamarin.Forms.BindableProperty

WeekNumberStyleProperty

Gets or sets the WeekNumberStyle property.

Declaration

public static readonly BindableProperty WeekNumberStyleProperty

Field Value

Type	Description
Xamarin.Forms.BindableProperty

Properties

AgendaItemTemplate

Gets or sets the Agenda Item Template to customize the Default agenda view appointment UI with custom UI.

Declaration

public DataTemplate AgendaItemTemplate { get; set; }

Property Value

Type	Description
Xamarin.Forms.DataTemplate	The agenda item template.

AgendaViewHeight

Gets or sets agendaViewHeight property used to set the agenda view height in MonthView.

Declaration

public double AgendaViewHeight { get; set; }

Property Value

Type	Description
System.Double

AgendaViewStyle

Gets or sets the Agenda View Style and it's properties to customize the appearance of agenda view in month view.

Declaration

public AgendaViewStyle AgendaViewStyle { get; set; }

Property Value

Type	Description
AgendaViewStyle	The agenda view style.

AppointmentDisplayCount

Gets or sets the Appointment Display Count property to define the maximum number of the appointment to be displayed in a month cell.

Declaration

public int AppointmentDisplayCount { get; set; }

Property Value

Type

Description

System.Int32

This property takes the AppointmentDisplayCount value. For AppointmentDisplayCount value is 1 and month cell have more than 1 appointments, single appointment will be displayed and remaining appointments in month cell displayed in more appointments count. If an AppointmentDisplayCount value is more than one, for an example value is 3 and month cell have more than 3 appointments, 2 appointments will be displayed and remaining appointments in month cell displayed in more appointments count.

Remarks

It will be applicable only for Xamarin.Forms.UWP desktop month view while AppointmentDisplayMode as Appointment.

AppointmentDisplayMode

Gets or sets the AppointmentDisplayMode property to define the display mode for appointment in month view. This is a bindable property.

Declaration

public AppointmentDisplayMode AppointmentDisplayMode { get; set; }

Property Value

Type	Description
AppointmentDisplayMode	This property takes the AppointmentDisplayMode value.

AppointmentIndicatorCount

Gets or sets the AppointmentIndicatorCount property to define the maximum number of the appointment indicators can be displayed in a month cell which indicates appointment availability for the date. This is a bindable property.

Declaration

public int AppointmentIndicatorCount { get; set; }

Property Value

Type	Description
System.Int32	This property takes the AppointmentIndicatorCount value.

BlackoutDates

Gets or sets the Black out Dates property to set the blackout days in the MonthView. This is a bindable property.

Declaration

public ObservableCollection<DateTime> BlackoutDates { get; set; }

Property Value

Type	Description
System.Collections.ObjectModel.ObservableCollection<System.DateTime>

MonthCellTemplate

Gets or sets the Month Cell Template to customize the Default month view's month cell UI with custom UI.

Declaration

public DataTemplate MonthCellTemplate { get; set; }

Property Value

Type	Description
Xamarin.Forms.DataTemplate	The month cell template.

MonthLabelSettings

Gets or sets the Month Label Settings property to define the Settings for MonthView Labels. This is a bindable property.

Declaration

public MonthLabelSettings MonthLabelSettings { get; set; }

Property Value

Type	Description
MonthLabelSettings	This property takes the MonthLabelSettings value.

MonthNavigationDirection

Gets or sets the Month Navigation Direction property to define the month view swipe navigation direction of the Schedule.

Declaration

public MonthNavigationDirections MonthNavigationDirection { get; set; }

Property Value

Type	Description
MonthNavigationDirections	This property takes the MonthNavigationDirection value.

SelectionTextColor

Gets or sets Selection Text Color to customize the displaying text color of the selected date in month view.

Declaration

public Color SelectionTextColor { get; set; }

Property Value

Type	Description
Xamarin.Forms.Color	The color of the selection text.

ShowAgendaView

Gets or sets a value indicating whether the Agenda view can be show or not in the schedule month view.

Declaration

public bool ShowAgendaView { get; set; }

Property Value

Type	Description
System.Boolean	This property takes the System.Boolean value.

ShowWeekNumber

Gets or sets a value indicating whether the Week Numbers can be display or not in the schedule month view.

Declaration

public bool ShowWeekNumber { get; set; }

Property Value

Type	Description
System.Boolean	This property takes the System.Boolean value.

TodayBackground

Gets or sets the Today Background to customize the circle background color which indicates today's date in month view.

Declaration

public Color TodayBackground { get; set; }

Property Value

Type	Description
Xamarin.Forms.Color	The today circle background.

WeekNumberStyle

Gets or sets the Week Number Style property to customize the appearance of displaying week number in month view.

Declaration

public WeekNumberStyle WeekNumberStyle { get; set; }

Property Value

Type	Description
WeekNumberStyle	This property takes the WeekNumberStyle value.