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

    NOV Diagram provides two ways to create a drawing view with a ribbon commanding UI.

     Drawing View with Ribbon Widget

    The easiest way to create a ribbon commanding UI for a drawing view is to use the NDrawingViewWithRibbon widget or if you are not creating a cross-platform application - to drop an NDrawingViewWithRibbonControl 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 an element from the ribbon use the corresponding Get... method of the NDrawingViewWithRibbon or the NDrawingViewWithRibbonControl 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 "Mailings" ribbon tab page and the "Zoom" ribbon group of the "View" ribbon tab page:

    Hide ribbon tab pages and ribbon groups
    Copy Code
    // Hide the "Mailings" ribbon tab page
    nDrawingViewWithRibbonControl1.GetRibbonTabPage(NDiagramRibbonBuilder.TabPageMailingsName)
        .Header.Visibility = ENVisibility.Collapsed;
    
    // Hide the "Zoom" ribbon group of the "View" ribbon tab page
    nDrawingViewWithRibbonControl1.GetRibbonGroup(NDiagramRibbonBuilder.TabPageViewName, NViewTabPageBuilder.GroupZoomName)
        .Visibility = ENVisibility.Collapsed;
    
    Note that instead of using string literals like "View", it is better to use the string constants defined in the NDiagramRibbonBuilder 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 NViewTabPageBuilder.GroupZoomName.

    2. Removing Commands

    To hide all widgets associated with specific commands from the commanding UI, use the RemoveCommands method of the drawing view with ribbon. For example, the code snippet below removes the Open command and hides the widgets associated with them from the ribbon and also removes the page number ommand from the status bar:

    Remove commands
    Copy Code
    NDrawingViewWithRibbon drawingViewWithRibbon = new NDrawingViewWithRibbon();
    drawingViewWithRibbon.RemoveCommands(NDrawingView.OpenCommand, NDrawingView.PageNumberStatusBarCommand);
    
     Diagram Ribbon Builder

    You can also create a NOV Diagram ribbon commanding UI using the NOV Diagram ribbon builder. This gives you greater flexibility and more ways to customize the NOV Diagram ribbon, including an option to add custom commands to the ribbon:

    Creating a NOV Diagram ribbon UI
    Copy Code
    NDiagramRibbonBuilder ribbonBuilder = new NDiagramRibbonBuilder();
    NCommandUIHolder drawingViewWithRibbon = ribbonBuilder.CreateUI(drawingView);
    

    1. Renaming Ribbon Tabs and Groups

    To rename a ribbon tab or a ribbon group command builder, change its name property prior to using it for building the ribbon UI. The following piece of code demonstrates how to rename the "Home" tab page and the "Font" ribbon group:

    Rename ribbon tab and group
    Copy Code
    // Rename the "Home" ribbon tab page
    NRibbonTabPageBuilder homeTabBuilder = ribbonBuilder.TabPageBuilders[NDiagramRibbonBuilder.TabPageHomeName];
    homeTabBuilder.Name = "Start";
    
    // Rename the "Font" ribbon group of the "Home" tab page
    NRibbonGroupBuilder fontGroupBuilder = homeTabBuilder.RibbonGroupBuilders[NHomeTabPageBuilder.GroupFontName];
    fontGroupBuilder.Name = "Text";
    

    2. 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 diagram 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 diagram ribbon tab pages are exposed as constants in the NDiagramRibbonBuilder 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 diagram ribbon:

    Remove ribbon group
    Copy Code
    NRibbonTabPageBuilder homeTabBuilder = ribbonBuilder.TabPageBuilders[NDrawingRibbonBuilder.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[NDrawingRibbonBuilder.TabPageHomeName];
    homeTabBuilder.RibbonGroupBuilders.Insert(0, new CustomRibbonGroupBuilder());
    

    3. 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 command and hides the widgets associated with them from the ribbon and also removes the page number command from the status bar:

    Remove commands
    Copy Code
    NDiagramRibbonBuilder ribbonBuilder = new NDiagramRibbonBuilder();
    NCommandUIHolder drawingViewWithRibbon = ribbonBuilder.CreateUI(drawingView);
    drawingViewWithRibbon.RemoveCommands(NDrawingView.OpenCommand, NDrawingView.PageNumberStatusBarCommand);
    

    4. 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 "Copy" command
            items.Add(CreateRibbonButton(NResources.Image_Ribbon_32x32_clipboard_copy_png,
                Nevron.Nov.Presentation.NResources.Image_Edit_Copy_png, NDrawingView.CopyCommand));
    
            // 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 Diagram Commanding Overview topic.

    See Also