Schedule / Commanding / Ribbon / Schedule Ribbon via Code
In This Topic
    Schedule Ribbon via Code
    In This Topic

    NOV Schedule provides two ways to create a schedule view with ribbon commanding UI.

     Schedule View with Ribbon Widget

    The easiest way to create a ribbon commanding UI for a schedule view is to use the NScheduleViewWithRibbon widget or if you are not creating a cross-platform application - to drop an NScheduleViewWithRibbonControl to a form/window using the Visual Studio Designer. You can then use the following approaches to modify the ribbon:

    1. Hiding Ribbon Tab Pages and Ribbon Groups

    To hide a an element from the ribbon use the corresponding Get... method of the NScheduleViewWithRibbon or the NScheduleViewWithRibbonControl class and set its Visibility property to Collapsed:

    • GetApplicationMenu - gets the ribbon application menu.
    • GetRibbonTabPage - gets the ribbon tab page with a given title.
    • GetRibbonGroup - gets the ribbon group with a given groupTitle in the tab page with a specified pageTitle.
    • GetRibbonSearchBox - gets the ribbon search box.
    • GetRibbonQuickAccessToolbar - gets the ribbon quick access toolbar.
    • GetStatusBar - gets the status bar.

    The following code snippet hides the "Settings" ribbon tab page and the "Orientation" ribbon group of the "Home" ribbon tab page:

    Hide ribbon tab pages and ribbon groups
    Copy Code
    // Hide the "Settings" ribbon tab page
    nScheduleViewWithRibbonControl1.GetRibbonTabPage(NScheduleRibbonBuilder.TabPageSettingsName).Header.Visibility = ENVisibility.Collapsed;
    
    // Hide the "Orientation" ribbon group of the "Home" ribbon tab page
    nScheduleViewWithRibbonControl1.GetRibbonGroup(NScheduleRibbonBuilder.TabPageHomeName, NHomeTabPageBuilder.GroupOrientationName).Visibility = ENVisibility.Collapsed;
    
    Note that instead of using string literals like "Settings", it is better to use the string constants defined in the NScheduleRibbonBuilder class to get ribbon tab page names as shown in the code snippet above. You should use the constants in the corresponding tab page builder to get ribbon group names, for example NHomeTabPageBuilder.GroupOrientationName.

    2. Removing commands

    To remove all widgets associated with specific commands from the commanding UI, use the RemoveCommands method of the schedule view with ribbon. For example, the code snippet below removes the Open and Save commands and hides the widgets associated with them from the ribbon:

    Remove commands
    Copy Code
    NScheduleViewWithRibbon scheduleViewWithRibbon = new NScheduleViewWithRibbon();
    scheduleViewWithRibbon.RemoveCommands(NScheduleView.OpenCommand, NScheduleView.SaveCommand, NScheduleView.SaveAsCommand);
    
     Schedule Ribbon Builder

    You can also create a NOV Schedule ribbon commanding UI using the NOV Schedule ribbon builder. This gives you greater flexibility and more ways to customize the NOV Schedule ribbon:

    Creating a NOV Schedule ribbon UI
    Copy Code
    NScheduleRibbonBuilder ribbonBuilder = new NScheduleRibbonBuilder();
    NCommandUIHolder scheduleViewWithRibbon = ribbonBuilder.CreateUI(scheduleView);
    

    1. Modifying the Ribbon Group Builders Collection

    If you want to remove a given ribbon tab page, you can easily do so by using the Remove method of the TabPageBuilders collection of the schedule ribbon builder. To remove a ribbon group from a tab page, you should use the Remove method of the RibbonGroupBuilders collection of the ribbon group builder.

    The names of all schedule ribbon tab pages are exposed as constants in the NScheduleRibbonBuilder class. Each of the tab page builders exposes as constants the names of its ribbon group builders. The following piece of code demonstrates how to remove the "Editing" ribbon group of the "Home" tab page of the schedule ribbon:

    Remove ribbon group
    Copy Code
    NRibbonTabPageBuilder homeTabBuilder = ribbonBuilder.TabPageBuilders[NScheduleRibbonBuilder.TabPageHomeName];
    homeTabBuilder.RibbonGroupBuilders.Remove(NHomeTabPageBuilder.GroupEditingName);
    

    In order to add or insert your own ribbon group builders, you can use the Add or Insert methods of the RibbonGroupBuilders collection respectively.

    Add custom ribbon group
    Copy Code
    NRibbonTabPageBuilder homeTabBuilder = ribbonBuilder.TabPageBuilders[NScheduleRibbonBuilder.TabPageHomeName];
    homeTabBuilder.RibbonGroupBuilders.Insert(0, new CustomRibbonGroupBuilder());
    

    2. Removing commands

    To hide all widgets associated with specific commands from the commanding UI, use the RemoveCommands method of the command UI holder created by the ribbon builder. For example, the code snippet below removes the Open and Save commands and hides the widgets associated with them from the ribbon:

    Remove commands
    Copy Code
    NScheduleRibbonBuilder ribbonBuilder = new NScheduleRibbonBuilder();
    NCommandUIHolder scheduleViewWithRibbon = ribbonBuilder.CreateUI(scheduleView);
    scheduleViewWithRibbon.RemoveCommands(NScheduleView.OpenCommand, NScheduleView.SaveCommand, NScheduleView.SaveAsCommand);
    

    3. Custom Ribbon Group Builders

    To create a custom ribbon group builder you should create a class, which inherits NRibbonGroupBuilder:

    Custom ribbon group builder
    Copy Code
    public class CustomRibbonGroupBuilder : NRibbonGroupBuilder
    {
        public CustomRibbonGroupBuilder()
            : base("Custom Group", NResources.Image_Ribbon_16x16_smiley_png)
        {
        }
    
        protected override void AddRibbonGroupItems(NRibbonGroupItemCollection items)
        {
            // Add the "Add Appointment" command
            items.Add(CreateRibbonButton(Nevron.Nov.Schedule.NResources.Image_Ribbon_32x32_AddAppointment_png,
                Nevron.Nov.Schedule.NResources.Image_Edit_AddAppointment_png, NScheduleView.AddAppointmentCommand));
    
            // Add the custom command
            items.Add(CreateRibbonButton(NResources.Image_Ribbon_32x32_smiley_png, NResources.Image_Ribbon_16x16_smiley_png, CustomCommand));
        }
    }
    

    To see how to define a custom command and a custom command action, take a look at the Schedule Commanding Overview topic.

    See Also