Class
WeekViewDefinition

Represents a definition of a view that shows all seven week days as in day view mode. This view provides a complete weekly overview with configurable first day of week and the ability to show or hide weekend days for work-week scenarios.

Definition

Namespace:Telerik.Maui.Controls

Assembly:Telerik.Maui.Controls.dll

Syntax:

cs-api-definition
public class WeekViewDefinition : MultidayViewDefinitionBase, INotifyPropertyChanged

Inheritance: objectViewDefinitionBaseMultidayViewDefinitionBaseWeekViewDefinition

Implements: INotifyPropertyChanged

Inherited Members MultidayViewDefinitionBase.DayStartTimePropertyMultidayViewDefinitionBase.DayEndTimePropertyMultidayViewDefinitionBase.MajorTickLengthPropertyMultidayViewDefinitionBase.MinorTickLengthPropertyMultidayViewDefinitionBase.MinTimeRulerExtentPropertyMultidayViewDefinitionBase.MaxTimeRulerExtentPropertyMultidayViewDefinitionBase.IsCurrentTimeIndicatorVisiblePropertyMultidayViewDefinitionBase.SpecialSlotsSourcePropertyMultidayViewDefinitionBase.MajorTickLineStylePropertyMultidayViewDefinitionBase.MinorTickLineStylePropertyMultidayViewDefinitionBase.VerticalLineStylePropertyMultidayViewDefinitionBase.HorizontalLineStylePropertyMultidayViewDefinitionBase.LinesThicknessPropertyMultidayViewDefinitionBase.TimeRulerLabelStylePropertyMultidayViewDefinitionBase.DayStyleSelectorPropertyMultidayViewDefinitionBase.SpecialSlotStyleSelectorPropertyMultidayViewDefinitionBase.SpecialSlotTemplatePropertyMultidayViewDefinitionBase.DayStringFormatPropertyMultidayViewDefinitionBase.TimeRulerMajorTickStringFormatPropertyMultidayViewDefinitionBase.TimeRulerWidthPropertyMultidayViewDefinitionBase.DayStartTimeMultidayViewDefinitionBase.DayEndTimeMultidayViewDefinitionBase.MajorTickLengthMultidayViewDefinitionBase.MinorTickLengthMultidayViewDefinitionBase.MinTimeRulerExtentMultidayViewDefinitionBase.MaxTimeRulerExtentMultidayViewDefinitionBase.IsCurrentTimeIndicatorVisibleMultidayViewDefinitionBase.SpecialSlotsSourceMultidayViewDefinitionBase.MajorTickLineStyleMultidayViewDefinitionBase.MinorTickLineStyleMultidayViewDefinitionBase.VerticalLineStyleMultidayViewDefinitionBase.HorizontalLineStyleMultidayViewDefinitionBase.LinesThicknessMultidayViewDefinitionBase.TimeRulerLabelStyleMultidayViewDefinitionBase.DayStyleSelectorMultidayViewDefinitionBase.SpecialSlotStyleSelectorMultidayViewDefinitionBase.SpecialSlotTemplateMultidayViewDefinitionBase.DayStringFormatMultidayViewDefinitionBase.TimeRulerMajorTickStringFormatMultidayViewDefinitionBase.TimeRulerWidthViewDefinitionBase.TitlePropertyViewDefinitionBase.HeaderTextFormatPropertyViewDefinitionBase.TitleViewDefinitionBase.HeaderTextFormat

Constructors

WeekViewDefinition()

Declaration

cs-api-definition
public WeekViewDefinition()

Fields

FirstDayOfWeekProperty

Identifies the FirstDayOfWeek property.

Declaration

cs-api-definition
public static readonly BindableProperty FirstDayOfWeekProperty

Field Value

BindableProperty

IsWeekendVisibleProperty

Identifies the IsWeekendVisible property.

Declaration

cs-api-definition
public static readonly BindableProperty IsWeekendVisibleProperty

Field Value

BindableProperty

Properties

FirstDayOfWeek

Gets or sets the day that is considered the beginning of the week. When null, the system's default first day of week is used based on culture settings. This affects the order in which days are displayed in the week view.

Declaration

cs-api-definition
public DayOfWeek? FirstDayOfWeek { get; set; }

Property Value

DayOfWeek?

A DayOfWeek value indicating the first day, or null for system default.

Example

csharp
// Week starting on Monday
var weekView = new WeekViewDefinition
{
    FirstDayOfWeek = DayOfWeek.Monday
};

// Week starting on Sunday (US style)
var usWeekView = new WeekViewDefinition
{
    FirstDayOfWeek = DayOfWeek.Sunday
};

// Use system default based on culture
var defaultWeekView = new WeekViewDefinition
{
    FirstDayOfWeek = null
};

IsWeekendVisible

Gets or sets a value indicating whether the weekend days are visible, so that only the work week is displayed. When false, only Monday through Friday are shown, creating a work-week view. When true, all seven days of the week are displayed.

Declaration

cs-api-definition
public bool IsWeekendVisible { get; set; }

Property Value

bool

True to show weekend days, false to show only weekdays. Default is true.

Example

csharp
// Full week view (Monday-Sunday)
var fullWeek = new WeekViewDefinition
{
    IsWeekendVisible = true,
    Title = "Full Week"
};

// Work week view (Monday-Friday only)
var workWeek = new WeekViewDefinition
{
    IsWeekendVisible = false,
    Title = "Work Week"
};

Methods

CreateDefaultTitle()

Creates the default title for the view definition.

Declaration

cs-api-definition
protected override string CreateDefaultTitle()

Returns

string

Overrides MultidayViewDefinitionBase.CreateDefaultTitle()