menu

MAUI

  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class SchedulerWeekHeaderSettings - MAUI API Reference | Syncfusion

    Show / Hide Table of Contents

    Class SchedulerWeekHeaderSettings

    Represents a class which is used to customize the week header of agenda view in the SfScheduler.

    Inheritance
    System.Object
    SchedulerWeekHeaderSettings
    Namespace: Syncfusion.Maui.Scheduler
    Assembly: Syncfusion.Maui.Scheduler.dll
    Syntax
    public class SchedulerWeekHeaderSettings : Element, IThemeElement

    Constructors

    SchedulerWeekHeaderSettings()

    Initializes a new instance of the SchedulerWeekHeaderSettings class.

    Declaration
    public SchedulerWeekHeaderSettings()

    Fields

    BackgroundProperty

    Identifies the Background dependency property.

    Declaration
    public static readonly BindableProperty BackgroundProperty
    Field Value
    Type Description
    Microsoft.Maui.Controls.BindableProperty

    The identifier for Background dependency property.

    DateFormatProperty

    Identifies the DateFormat dependency property.

    Declaration
    public static readonly BindableProperty DateFormatProperty
    Field Value
    Type Description
    Microsoft.Maui.Controls.BindableProperty

    The identifier for DateFormat dependency property.

    HeightProperty

    Identifies the Height dependency property.

    Declaration
    public static readonly BindableProperty HeightProperty
    Field Value
    Type Description
    Microsoft.Maui.Controls.BindableProperty

    The identifier for Height dependency property.

    TextStyleProperty

    Identifies the TextStyle dependency property.

    Declaration
    public static readonly BindableProperty TextStyleProperty
    Field Value
    Type Description
    Microsoft.Maui.Controls.BindableProperty

    The identifier for TextStyle dependency property.

    Properties

    Background

    Gets or sets the header background to customize the default background of the week header in agenda view.

    Declaration
    public Brush Background { get; set; }
    Property Value
    Type Description
    Microsoft.Maui.Controls.Brush

    The default value is Microsoft.Maui.Controls.Brush.Transparent.

    Remarks

    This property will be applicable when the scheduler view set as Agenda.

    Examples

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

    • XAML
    • C#
    <scheduler:SfScheduler x:Name="scheduler"
                           View="Agenda">
      <scheduler:SfScheduler.AgendaView>
      <scheduler:SfScheduler.AgendaView>
       <scheduler:SchedulerAgendaView>
           <scheduler:SchedulerAgendaView.WeekHeaderSettings>
               <scheduler:SchedulerWeekHeaderSettings Background="LightGreen" />
           </scheduler:SchedulerAgendaView.WeekHeaderSettings>
       </scheduler:SchedulerAgendaView>
     </scheduler:SfScheduler.AgendaView>
    </scheduler:SfScheduler>
    this.scheduler.View = SchedulerView.Agenda;
    this.scheduler.AgendaView.WeekHeaderSettings.Background = Brush.LightGreen;;
    See Also
    Height
    DateFormat
    TextStyle

    DateFormat

    Gets or sets the format to customize week header date text in agenda view of the SfScheduler

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

    The default value is "MMM dd".

    Examples

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

    this.scheduler.View = SchedulerView.Agenda;
    this.scheduler.AgendaView.WeekHeaderSettings.DateFormat = "MM, ddd";
    See Also
    Height
    Background
    TextStyle

    Height

    Gets or sets the height to customize the default height property of the week header in agenda view of the scheduler.

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

    The default value is 30.

    Remarks

    This property will be applicable when the scheduler view set as Agenda.

    Examples

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

    • XAML
    • C#
    <scheduler:SfScheduler x:Name="scheduler"
                           View="Agenda">
      <scheduler:SfScheduler.AgendaView>
      <scheduler:SfScheduler.AgendaView>
       <scheduler:SchedulerAgendaView>
           <scheduler:SchedulerAgendaView.WeekHeaderSettings>
               <scheduler:SchedulerWeekHeaderSettings Height="100" />
           </scheduler:SchedulerAgendaView.WeekHeaderSettings>
       </scheduler:SchedulerAgendaView>
     </scheduler:SfScheduler.AgendaView>
    </scheduler:SfScheduler>
    this.scheduler.View = SchedulerView.Agenda;
    this.scheduler.AgendaView.WeekHeaderSettings.Height = 200;
    See Also
    Background
    DateFormat
    TextStyle

    TextStyle

    Gets or sets the style of agenda week header view text, that used to customize the text color, font, font size, font family and font attributes.

    Declaration
    public SchedulerTextStyle TextStyle { get; set; }
    Property Value
    Type
    SchedulerTextStyle
    Remarks

    This property doesn't applicable for today day text.

    Examples

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

    var textStyle = new SchedulerTextStyle()
    {
       TextColor = Colors.Red,
       FontSize = 12,
    };
    this.scheduler.View = SchedulerView.Agenda;
    this.scheduler.AgendaView.WeekHeaderSettings.TextStyle = textStyle;
    See Also
    Height
    Background
    DateFormat
    TodayTextStyle
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved