Back to Devexpress

Year View

windowsforms-401984-controls-and-libraries-scheduler-views-year-view.md

latest3.9 KB
Original Source

Year View

  • Oct 13, 2020
  • 2 minutes to read

The Year View displays appointments for the entire year in a customizable number of months.

To enable the Year View, set the SchedulerControl.ActiveViewType property to Year. To specify the view, use the SchedulerControl.YearView property. This property returns a YearView object.

Tip

Run the following demo to see the view in action: Year View module in the XtraScheduler MainDemo. To view source code, click Open Solution in the ribbon.

The following options customize the view:

Member NameDescription
MonthCountGets or sets the number of months that are displayed in the Year View.
StartGets or sets the first date of the time interval displayed by the scheduler view.
AppointmentDisplayOptionsContains options that specify how appointments are displayed in the Year View.
AppearanceContains appearance settings for the view’s visual elements.
SelectedIntervalGets the time interval currently selected in the scheduler’s active view by an end-user.
GetVisibleIntervals()Returns a copy of the visible time interval collection for the current view.
SetVisibleIntervals(TimeIntervalCollection)Fills the visible time interval collection with new items.

The following table contains events used to customize the view:

Event NameDescription
CustomDrawTimeCellUse this event to draw Time Cells.
CustomDrawNavigationButtonUse this event to draw Navigation Buttons.
CustomDrawDayOfWeekHeaderUse this event to draw Day of Week Headers.
CustomDrawWeekViewTopLeftCornerUse this event to draw a square area in the upper-left corner of the view.

The table below contains services used to customize the view. Services is a design pattern that separates the implementation of a feature from the control.

ServiceDescription
HeaderCaptionServiceUse this service to format header captions.
HeaderToolTipServiceUse this service to specify custom tooltips for day headers.