Class SchedulerAgendaView

Represents a class which is used to configure all the properties of agenda view in the SfScheduler.

Inheritance

System.Object

SchedulerAgendaView

Namespace: Syncfusion.Maui.Scheduler

Assembly: Syncfusion.Maui.Scheduler.dll

Syntax

public class SchedulerAgendaView : Element, IThemeElement

Constructors

SchedulerAgendaView()

Initializes a new instance of the SchedulerAgendaView class.

Declaration

public SchedulerAgendaView()

Fields

AppointmentTemplateProperty

Identifies the AppointmentTemplate dependency property.

Declaration

public static readonly BindableProperty AppointmentTemplateProperty

Field Value

Type	Description
Microsoft.Maui.Controls.BindableProperty	Identifies the AppointmentTemplate bindable property.

AppointmentTimeFormatProperty

Identifies the AppointmentTimeFormat dependency property.

Declaration

public static readonly BindableProperty AppointmentTimeFormatProperty

Field Value

Type	Description
Microsoft.Maui.Controls.BindableProperty	Identifies the AppointmentTimeFormat bindable property.

DayHeaderSettingsProperty

Identifies the DayHeaderSettings dependency property.

Declaration

public static readonly BindableProperty DayHeaderSettingsProperty

Field Value

Type	Description
Microsoft.Maui.Controls.BindableProperty	Identifies the DayHeaderSettings bindable property.

DayHeaderTemplateProperty

Identifies the DayHeaderTemplate dependency property.

Declaration

public static readonly BindableProperty DayHeaderTemplateProperty

Field Value

Type	Description
Microsoft.Maui.Controls.BindableProperty	Identifies the DayHeaderTemplate bindable property.

HideEmptyDaysProperty

Identifies the HideEmptyDays dependency property.

Declaration

public static readonly BindableProperty HideEmptyDaysProperty

Field Value

Type	Description
Microsoft.Maui.Controls.BindableProperty	Identifies the HideEmptyDays bindable property.

LayoutModeProperty

Identifies the LayoutMode dependency property.

Declaration

public static readonly BindableProperty LayoutModeProperty

Field Value

Type	Description
Microsoft.Maui.Controls.BindableProperty	Identifies the LayoutMode bindable property.

MonthHeaderSettingsProperty

Identifies the MonthHeaderSettings dependency property.

Declaration

public static readonly BindableProperty MonthHeaderSettingsProperty

Field Value

Type	Description
Microsoft.Maui.Controls.BindableProperty	Identifies the MonthHeaderSettings bindable property.

MonthHeaderTemplateProperty

Identifies the MonthHeaderTemplate dependency property.

Declaration

public static readonly BindableProperty MonthHeaderTemplateProperty

Field Value

Type	Description
Microsoft.Maui.Controls.BindableProperty	Identifies the MonthHeaderTemplate bindable property.

NoEventsTextStyleProperty

Identifies the NoEventsTextStyle dependency property.

Declaration

public static readonly BindableProperty NoEventsTextStyleProperty

Field Value

Type	Description
Microsoft.Maui.Controls.BindableProperty	Identifies the NoEventsTextStyle bindable property.

WeekHeaderSettingsProperty

Identifies the WeekHeaderSettings dependency property.

Declaration

public static readonly BindableProperty WeekHeaderSettingsProperty

Field Value

Type	Description
Microsoft.Maui.Controls.BindableProperty	Identifies the WeekHeaderSettings bindable property.

WeekHeaderTemplateProperty

Identifies the WeekHeaderTemplate dependency property.

Declaration

public static readonly BindableProperty WeekHeaderTemplateProperty

Field Value

Type	Description
Microsoft.Maui.Controls.BindableProperty	Identifies the WeekHeaderTemplate bindable property.

Properties

AppointmentTemplate

Gets or sets the appointment's template to customize the default UI.

Declaration

public DataTemplate AppointmentTemplate { get; set; }

Property Value

Type
Microsoft.Maui.Controls.DataTemplate

AppointmentTimeFormat

Gets or sets the appointment's time format in the agenda view of the SfScheduler.

Declaration

public string AppointmentTimeFormat { get; set; }

Property Value

Type	Description
System.String	The default value is "hh:mm tt".

Examples

The below examples shows, how to use the AppointmentTimeFormat property of SchedulerAgendaView in the SfScheduler.

this.Scheduler.View = SchedulerView.Agenda;
this.Scheduler.AgendaView.AppointmentTimeFormat = "HH:mm";

DayHeaderSettings

Gets or sets properties which allows to customize the all the properties of day header settings of agenda view in the SfScheduler.

Declaration

public SchedulerDayHeaderSettings DayHeaderSettings { get; set; }

Property Value

Type	Description
SchedulerDayHeaderSettings	The properties settings used to customize the agenda day header setting.

Examples

The below examples shows, how to use the DayHeaderSettings property of AgendaView in the SfScheduler.

• XAML
• C#

<scheduler:SfScheduler x:Name="scheduler"
                       View="Agenda" >
   <scheduler:SfScheduler.AgendaView>
       <scheduler:SchedulerAgendaView>
           <scheduler:SchedulerAgendaView.DayHeaderSettings>
               <scheduler:SchedulerDayHeaderSettings Background="LightGreen"
                                                     Width="100" />
           </scheduler:SchedulerAgendaView.DayHeaderSettings>
       </scheduler:SchedulerAgendaView>
   </scheduler:SfScheduler.AgendaView>
</scheduler:SfScheduler>

See Also

Agenda

DayHeaderTemplate

Gets or sets the day header template to customize the default UI.

Declaration

public DataTemplate DayHeaderTemplate { get; set; }

Property Value

Type
Microsoft.Maui.Controls.DataTemplate

Remarks

The BindingContext of the DayHeaderTemplate is the System.DateTime representing the corresponding agenda date.

Examples

The following code used to configure the day header view using the Microsoft.Maui.Controls.DataTemplate.

 <scheduler:SfScheduler x:Name="scheduler"
                        View="Agenda">
   <scheduler:SfScheduler.AgendaView>
       <scheduler:SchedulerAgendaView>
           <scheduler:SchedulerAgendaView.DayHeaderTemplate>
               <DataTemplate>
                   <Grid BackgroundColor="LightGreen">
                       <VerticalStackLayout HorizontalOptions="Center"
                                             VerticalOptions="Center">
                           <Label FontSize="14"
                                  TextColor="Gray"
                                  HorizontalTextAlignment="Center"
                                  Text="{Binding StringFormat='{0:ddd}'}" />
                           <Label FontSize="20"
                                  FontAttributes="Bold"
                                  TextColor="Black"
                                  HorizontalTextAlignment="Center"
                                  Text="{Binding StringFormat='{0:dd}'}" />
                       </VerticalStackLayout>
                   </Grid>
               </DataTemplate>
           </scheduler:SchedulerAgendaView.DayHeaderTemplate>
       </scheduler:SchedulerAgendaView>
   </scheduler:SfScheduler.AgendaView>
</scheduler:SfScheduler>

HideEmptyDays

Gets or sets a value indicating whether empty days should be hidden in the Agenda View. When set to true, days without any appointments will not be displayed.

Declaration

public bool HideEmptyDays { get; set; }

Property Value

Type	Description
System.Boolean	A boolean value: true: Hide days with no appointments false: Show all days, including empty ones

Examples

The below examples shows, how to use the WeekHeaderSettings property of AgendaView in the SfScheduler.

• XAML
• C#

<scheduler:SfScheduler x:Name="scheduler"
                       View="Agenda" >
   <scheduler:SfScheduler.AgendaView>
       <scheduler:SchedulerAgendaView HideEmptyDays="True"/>
   </scheduler:SfScheduler.AgendaView>
</scheduler:SfScheduler>

LayoutMode

Gets or sets a value indicating the layout mode used to render the agenda view.

Declaration

public AgendaViewLayoutMode LayoutMode { get; set; }

Property Value

Type

Description

AgendaViewLayoutMode

One of the AgendaViewLayoutMode enumeration values that specifies the layout mode: Auto: The layout is determined automatically based on the available width and the platform. Mobile: The mobile layout is always used, regardless of the platform, device type, or available width. Desktop: The desktop layout is always used, regardless of the platform, device type, or available width. The default value is Auto.

Examples

The below examples shows, how to use the LayoutMode property of AgendaView in the SfScheduler.

• XAML
• C#

<scheduler:SfScheduler x:Name="scheduler"
                       View="Agenda" >
   <scheduler:SfScheduler.AgendaView>
       <scheduler:SchedulerAgendaView LayoutMode="Desktop"/>
   </scheduler:SfScheduler.AgendaView>
</scheduler:SfScheduler>

MonthHeaderSettings

Gets or sets properties which allows to customize the all the properties of month header settings of agenda view in the SfScheduler.

Declaration

public SchedulerMonthHeaderSettings MonthHeaderSettings { get; set; }

Property Value

Type	Description
SchedulerMonthHeaderSettings	The properties settings used to customize the month week header setting.

Examples

The below examples shows, how to use the MonthHeaderSettings property of AgendaView in the SfScheduler.

• XAML
• C#

<scheduler:SfScheduler x:Name="scheduler"
                       View="Agenda" >
   <scheduler:SfScheduler.AgendaView>
       <scheduler:SchedulerAgendaView>
           <scheduler:SchedulerAgendaView.MonthHeaderSettings>
               <scheduler:SchedulerMonthHeaderSettings Background = "LightGreen"
                                                       Height="200" />
           </scheduler:SchedulerAgendaView.MonthHeaderSettings>
       </scheduler:SchedulerAgendaView>
   </scheduler:SfScheduler.AgendaView>
</scheduler:SfScheduler>

See Also

Agenda

MonthHeaderTemplate

Gets or sets the month header template to customize the default UI.

Declaration

public DataTemplate MonthHeaderTemplate { get; set; }

Property Value

Type
Microsoft.Maui.Controls.DataTemplate

Remarks

The BindingContext of the MonthHeaderTemplate is the Syncfusion.Maui.Scheduler.AgendaMonthHeaderTemplate.

Examples

The following code used to configure the month header view using the Microsoft.Maui.Controls.DataTemplate.

 <scheduler:SfScheduler x:Name="scheduler"
                        View="Agenda">
   <scheduler:SfScheduler.AgendaView>
       <scheduler:SchedulerAgendaView>
           <scheduler:SchedulerAgendaView.MonthHeaderTemplate>
               <DataTemplate>
                   <Grid>
                       <Label x:Name="label" HorizontalOptions="Start" Background="LightGreen" VerticalOptions="Start" TextColor="Black" FontSize="16"  Text="{Binding StringFormat='{0:MMMM yyyy}'}"/>
                   </Grid>
               </DataTemplate>
           </scheduler:SchedulerAgendaView.MonthHeaderTemplate>
       </scheduler:SchedulerAgendaView>
   </scheduler:SfScheduler.AgendaView>
</scheduler:SfScheduler>

NoEventsTextStyle

Gets or sets the Text Style of the agenda's No Events text.

Declaration

public SchedulerTextStyle NoEventsTextStyle { get; set; }

Property Value

Type
SchedulerTextStyle

Examples

The below examples shows, how to use the No Events TextStyle property of AgendaView in the SfScheduler.

var textStyle = new SchedulerTextStyle()
{
   TextColor = Colors.Red,
   FontSize = 12,
};
this.scheduler.View = SchedulerView.Agenda;
this.scheduler.AgendaView.NoEventsTextStyle = textStyle;

WeekHeaderSettings

Gets or sets properties which allows to customize the all the properties of week header settings of agenda view in the SfScheduler.

Declaration

public SchedulerWeekHeaderSettings WeekHeaderSettings { get; set; }

Property Value

Type	Description
SchedulerWeekHeaderSettings	The properties settings used to customize the agenda week header setting.

Examples

The below examples shows, how to use the WeekHeaderSettings property of AgendaView in the SfScheduler.

• XAML
• C#

<scheduler:SfScheduler x:Name="scheduler"
                       View="Agenda" >
   <scheduler:SfScheduler.AgendaView>
       <scheduler:SchedulerAgendaView>
           <scheduler:SchedulerAgendaView.WeekHeaderSettings>
               <scheduler:SchedulerWeekHeaderSettings Background = "LightGreen"
                                                      Height="200" />
           </scheduler:SchedulerAgendaView.WeekHeaderSettings>
       </scheduler:SchedulerAgendaView>
   </scheduler:SfScheduler.AgendaView>
</scheduler:SfScheduler>

See Also

Agenda

WeekHeaderTemplate

Gets or sets the week header template to customize the default UI.

Declaration

public DataTemplate WeekHeaderTemplate { get; set; }

Property Value

Type
Microsoft.Maui.Controls.DataTemplate

Remarks

The BindingContext of the WeekHeaderTemplate is the AgendaViewWeekHeaderDetails.

Examples

The following code used to configure the week header view using the Microsoft.Maui.Controls.DataTemplate.

 <scheduler:SfScheduler x:Name="scheduler"
                        View="Agenda">
   <scheduler:SfScheduler.AgendaView>
       <scheduler:SchedulerAgendaView>
           <scheduler:SchedulerAgendaView.WeekHeaderTemplate>
               <DataTemplate>
                   <Grid BackgroundColor="LightBlue">
                       <Label HorizontalOptions="Center"
                              VerticalOptions="Center"
                              FontSize="18"
                              TextColor="Black">
                           <Label.FormattedText>
                               <FormattedString>
                                   <Span Text="{Binding StartDate, StringFormat='{0:MMM dd}'}" />
                                   <Span Text=" - " />
                                   <Span Text="{Binding EndDate, StringFormat='{0:MMM dd, yyyy}'}" />
                               </FormattedString>
                           </Label.FormattedText>
                       </Label>
                   </Grid>
               </DataTemplate>
           </scheduler:SchedulerAgendaView.WeekHeaderTemplate>
       </scheduler:SchedulerAgendaView>
   </scheduler:SfScheduler.AgendaView>
</scheduler:SfScheduler>