Ribbon

• Nov 30, 2023
• 2 minutes to read

The SchedulerControl includes a default Ribbon UI that enable end users to manage appointments, switch views and dates and adjust view settings. To show the ribbon, set the SchedulerControl.CommandBarStyle property to CommandBarStyle.Ribbon. You can customize a ribbon by adding or removing items, or replace the default item with a custom one.

To modify the Scheduler’s ribbon UI, add the necessary customization actions to the SchedulerControl.RibbonActions collection. The action’s ElementName property specifies the name of the existing ribbon element you wish to change or remove. This can be a ribbon category, page, page group, or item. Element names are the DefaultBarItemNames class fields.

Note

See the How to: Display and Modify the Integrated Ribbon for the Scheduler -> Customize the Ribbon UI for more information on how to use the default bar item names to modify the ribbon.

The table below lists default ribbon items and groups and the DefaultBarItemNames properties used to access the menu items.

• Home Ribbon Page

• Appointment Ribbon Page

Note

You can find information related to items in SchedulerControl and Resource Tree pop-up menus in the Pop-Up Menus topic.

Home Ribbon Page

The Default Bar Item Name is DefaultBarItemNames.Pages_Home.

DefaultBarItemNames Properties		SchedulerCommands and Properties
Group	Items
Groups_Home_Appointment	Items_Home_Appointment_NewAppointment Items_Home_Appointment_NewRecurringAppointment	ShowNewAppointmentWindowCommand ShowNewRecurringAppointmentWindowCommand
Groups_Home_Navigate	Items_Home_Navigate_Backward Items_Home_Navigate_Forward Items_Home_Navigate_GotoToday	NavigateViewBackwardCommand NavigateViewForwardCommand GoToTodayCommand
Groups_Home_Arrange	Items_Home_Arrange_Views	SwitchViewCommand
Groups_Home_GroupBy	Items_Home_GroupBy_GroupByNone Items_Home_GroupBy_GroupByDate Items_Home_GroupBy_GroupByResource	ChangeGroupTypeCommand
Groups_Home_TimeScale	Items_Home_TimeScale_SwitchTimeScale Items_Home_TimeScale_IntervalCount Items_Home_TimeScale_TimeScaleCaptions	ChangeTimeScaleCommand TimelineView.IntervalCount TimelineView.TimeScales
Groups_Home_Layout	Items_Home_Layout_ShowWorkTimeOnly Items_Home_Layout_SwitchSnapToCells	DayViewBase.ShowWorkTimeOnly ChangeSnapToCellsModeCommand
Groups_Home_Window	Items_Home_Window_ShowRemindersWindow	ShowRemindersWindowCommand

Appointment Ribbon Page

The Default Bar Item Name is DefaultBarItemNames.Pages_Appointment.

DefaultBarItemNames Properties		SchedulerCommands and Properties
Group	Items
Groups_Appointment_Actions	Items_Appointment_Actions_Open Items_Appointment_Actions_Delete	ShowAppointmentWindowCommand DeleteAppointmentsCommand
Groups_Appointment_Options	Items_Appointment_Options_ShowTimeAs Items_Appointment_Options_LabelAs Items_Appointment_Options_Recurrence Items_Appointment_Options_Reminder	ChangeStatusCommand ChangeLabelCommand OpenRecurrenceWindowCommand ChangeReminderTimeBeforeStartCommand