Ribbon Customization Example for Blazor

Nevron NOV Diagram for Blazor ships with hundreds of examples with full source code, as part of the Nevron Open Vision Suite. All Blazor Diagram examples are also available as a stand-alone Visual Studio solution in C#, which you can download from the links below.

Ribbon Customization Example for Blazor Description

This example demonstrates how to customize the NOV Diagram ribbon.


Ribbon Customization Example

C# Ribbon Customization Example Code for Nevron Diagram for Blazor
Language: C#

using Nevron.Nov;
using Nevron.Nov.Diagram;
using Nevron.Nov.Diagram.DrawingCommands;
using Nevron.Nov.Diagram.Shapes;
using Nevron.Nov.Diagram.UI;
using Nevron.Nov.Dom;
using Nevron.Nov.Graphics;
using Nevron.Nov.Layout;
using Nevron.Nov.UI;
using Nevron.Nov.Windows.Forms;
using System.Windows.Forms;

namespace NovWinFormsProject
{
	public partial class Form1 : Form
	{
		#region Constructors

		public Form1()
		{
			InitializeComponent();

			// Set form title
			Text = "NOV WinForms - NRibbonCustomizationExample";

			// Create the NOV example and its controls
			NWidget exampleContent = CreateExampleContent();
			NWidget exampleControls = CreateExampleControls();
			if (exampleControls != null)
			{
				exampleControls.PreferredWidth = 300;
			}

			// Place the example and its controls in a pair box
			NPairBox pairBox = new NPairBox(exampleContent, exampleControls);
			pairBox.FillMode = ENStackFillMode.First;
			pairBox.FitMode = ENStackFitMode.First;
			pairBox.Margins = new NMargins(NDesign.HorizontalSpacing, NDesign.VerticalSpacing);

			// Host the example in the form
			NNovWidgetHost host = new NNovWidgetHost(pairBox);
			host.Dock = DockStyle.Fill;
			Controls.Add(host);
		}

		#endregion

		#region Example

		public NWidget CreateExampleContent()
		{
			// Create a simple drawing
			m_DrawingView = new NDrawingView();

			m_DrawingView.Document.HistoryService.Pause();
			try
			{
				InitDiagram(m_DrawingView.Document);
			}
			finally
			{
				m_DrawingView.Document.HistoryService.Resume();
			}

			// Create and customize a ribbon UI builder
			m_RibbonBuilder = new NDiagramRibbonBuilder();

			// Add the custom command action to the drawing view's commander
			m_DrawingView.Commander.Add(new CustomCommandAction());

			// Rename the "Home" ribbon tab page
			NRibbonTabPageBuilder homeTabBuilder = m_RibbonBuilder.TabPageBuilders[NDiagramRibbonBuilder.TabPageHomeName];
			homeTabBuilder.Name = "Start";

			// Rename the "Text" ribbon group of the "Home" tab page
			NRibbonGroupBuilder fontGroupBuilder = homeTabBuilder.RibbonGroupBuilders[NHomeTabPageBuilder.GroupTextName];
			fontGroupBuilder.Name = "Custom Name";

			// Remove the "Clipboard" ribbon group from the "Home" tab page
			homeTabBuilder.RibbonGroupBuilders.Remove(NHomeTabPageBuilder.GroupClipboardName);

			// Insert the custom ribbon group at the beginning of the home tab page
			homeTabBuilder.RibbonGroupBuilders.Insert(0, new CustomRibbonGroupBuilder());

			// Create the commanding UI
			NCommandUIHolder drawingViewWithRibbon = m_RibbonBuilder.CreateUI(m_DrawingView);

			// Remove the Open command from the File menu and the page number command from the status bar
			drawingViewWithRibbon.RemoveCommands(NDrawingView.OpenCommand, NDrawingView.PageNumberStatusBarCommand);

			return drawingViewWithRibbon;
		}
		public NWidget CreateExampleControls()
		{
			return null;
		}
		public string GetExampleDescription()
		{
			return @"

This example demonstrates how to customize the NOV Diagram ribbon.

"; } /// /// Gets the relevant documentation links for the example /// /// public (string Name, string Url)[] GetDocumentationUrls() { return new[] { ("Diagram Ribbon via Code", "https://www.nevron.com/docs/openvision/diagram-ribbon-via-code.html"), ("Commanding Overview", "https://www.nevron.com/docs/openvision/diagram-commanding-overview.html"), }; } private void InitDiagram(NDrawingDocument drawingDocument) { NShape shape = new NBasicShapeFactory().CreateShape(ENBasicShape.Rectangle); shape.SetBounds(100, 100, 150, 100); drawingDocument.Content.ActivePage.Items.Add(shape); } #endregion #region Implementation #endregion #region Event Handlers #endregion #region Fields private NDrawingView m_DrawingView; private NDiagramRibbonBuilder m_RibbonBuilder; #endregion #region Static Methods #endregion #region Constants public static readonly NCommand CustomCommand = NCommand.Create(typeof(Nevron.Nov.Examples.Diagram.NRibbonCustomizationExample), "CustomCommand", "Custom Command"); #endregion #region Nested Types public class CustomRibbonGroupBuilder : NRibbonGroupBuilder { #region Constructors public CustomRibbonGroupBuilder() : base("Custom Group", Nevron.Nov.Graphics.NImage.FromBytes(Nevron.Nov.NConvert.FromBase64String("iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAABsElEQVR4AYWTQ7BjQRSGZz3cjM04Y9u2bdu2bdu29bx83jxzvI79z+munDiVW/Vd/Lf/g0aF0MvyeUJT4ipRTsDLb+ImoQ4zhJifEYjBp2jmfAJWAsmTYP/mN9m+SE08WfsVar7PZuPHcajfRI2M68NFEGn6+3wM6jZSovTRyMAgH9jcgDM5v0/E5+ODUbOBCgeX9oAnfiLccRNxf1c/qV3Z1Ed+B7SjFQHOsiAyplHmSjUUuLZZDoYMemKw1F4eHAjX96AAt7l3MIifIDOZP/k1D5kubuxDCcazxvwTAZyBoouyImUykDCJmMjISeTyA+EAbMbjvf1xaFlP7FrYHTvmS7B7UQ+cWNULj/f0o5bCA+Tyh8jSTKFGU4UGzZXBNCOtWm2FrCYgwB8R4DQL4ue2ud3QpLkGOp0uiGYUZM6YDkDipMAAN0WAOgQYN5XYv0crNGyqhoJMCpUGjZqp0am9HuaP42H9EtRCC94LN1m0EkiahDeHB2LNjC5YOaUzHu3uL6uzBZtfhe7G7KDV+M4rEHH2i0KPQlAlMXga60TW8U5sHuEkXEQBcYFoGDr+P5RkQoMvtntjAAAAAElFTkSuQmCC"))) { } #endregion #region Protected Overrides protected override void AddRibbonGroupItems(NRibbonGroupItemCollection items) { // Add the "Copy" command items.Add(CreateRibbonButton(Nevron.Nov.Graphics.NImage.FromBytes(Nevron.Nov.NConvert.FromBase64String("iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAA10lEQVR4Ae2WsQ3CMBBFswEd4zCX70oGoKLzFqG8EWiZx4cd4e5H4QvrFKF86TWRi6f/r8i0m6SUrpWZ4Kaqp5ECs7tvUkpZBMxsFpF7lwgXcHcgESzASRACl/RAQIEu0W4ipIFGzhkeZpAAhhfgJwgS2GDiM14g5+z1PcNTVc/8BIDPW/8mpZRFwMxcRF5Qgm+AF2jBEnECQGLQBPUbBAl0iXYTIQ20rB1smEBvotNbCZlgJfEN/LcAngADBPh/wvEN8NmJAD/BUIFjgmOCQ8Aq/gM27SVvkCjJreFW3swAAAAASUVORK5CYII=")), Nevron.Nov.Presentation.NResources.Image_Edit_Copy_svg, NDrawingView.CopyCommand)); // Add the custom command items.Add(CreateRibbonButton(Nevron.Nov.Graphics.NImage.FromBytes(Nevron.Nov.NConvert.FromBase64String("iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAADXklEQVR4AcWWA7A8RxDGY5YrxWf7HZ5t29jb2LbNv+24HNs531WlFNsuKzx/6d7shbs7t49b9TvOTH/T0/PNHGbm+e01qYa4mXiW+ID4QeV94mniBsJ+2Eo/odelLTQwTBANvSbdvezANNDVBJbJBUsN/jGBFeKtlAPH3fKJ1CFGYIX5OepyHCkUoBc86pSQcDuEgeLUJuZy6IoQBf9cqyMPGDg4ht1X9QJefRHwyXj4lj68uG0ECY/D1HJwpd+o1SHE769KyCm0IKvAgqc2DiOmkYmoS8IbB8eRkW9Bel4lfnhyFuHXUyxM+E85iv/Qm/0LW0dQVGZFpcWO8xZaeKb/a8eZueWcDpRX2lBaYcMDN/chbrBk/xJASvcarekDN/Upg1qsdkz0NQB+WTP958y1KCJZxIaLuwD9ZeDM3vXPtYcenO7H7h5CSbkNlSTglIlm3QxcdVo7Kiw2lJHYvVf3GtWBQjJ4u1EjXscfn5pFBq1rQakVe6/RHpiFcn3kFVmVWnn7wUlEnMKtaWMBGwWNaHYydl3Vg9nhBkReX9RvR8LOmmnGTWd1Aj5FpIgbWIArhYY8a83Ua9WCulVT4RkW8C2BdeI9FvDzOgr4QSiADYZrQEmtXyWggV/Fp0JLFnWmJuA7o+CePWO4TG6DNNaEcfKAvo5adLfWoLWxWqGtqRrdbTXK7+O9DZDHm3CR1Iq7LupC8OC4SMQHLMBjVFBnTrewC7IJKVhtf2L7B8nfkm3YjAqpz9xwo6hwn2MBW4wqf8cVPYqxVFVVmYLd8I4LDd2QuZkFdOuaEKXvy0dnkF1gMS0gt8iCdx4WmlGt0Iq5wM5baOUsmJo91wyCJwutWD2MHPcaHBpKIbU21fDAwuB8FtTV2KnfIkL6xzH/t/Xv4zhw6vGi8yDiXIQ02sRerxSZ3W5PBlU+82/5JVZMDjbi11cXheeA1oXkbqMOPBsEHPAfGMdZsy2ooGzkkhgWVE7LcwbtFtfuMSAoG85c5Wq9K9n3BITG5JNZDM+U4c/8G/2X0hnwie6dEL6TjzFjpSEVE31i4mu5Rz5plXw/xld+jZC6mfh+BYN/nlJgcWGah2/bSwr+zy0adjruMxuYvGUv37YPW8lHte0thEc9RX9W+ZZwqde7djNj/gH1UgAxN3/AxQAAAABJRU5ErkJggg==")), Nevron.Nov.Graphics.NImage.FromBytes(Nevron.Nov.NConvert.FromBase64String("iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAABsElEQVR4AYWTQ7BjQRSGZz3cjM04Y9u2bdu2bdu29bx83jxzvI79z+munDiVW/Vd/Lf/g0aF0MvyeUJT4ipRTsDLb+ImoQ4zhJifEYjBp2jmfAJWAsmTYP/mN9m+SE08WfsVar7PZuPHcajfRI2M68NFEGn6+3wM6jZSovTRyMAgH9jcgDM5v0/E5+ODUbOBCgeX9oAnfiLccRNxf1c/qV3Z1Ed+B7SjFQHOsiAyplHmSjUUuLZZDoYMemKw1F4eHAjX96AAt7l3MIifIDOZP/k1D5kubuxDCcazxvwTAZyBoouyImUykDCJmMjISeTyA+EAbMbjvf1xaFlP7FrYHTvmS7B7UQ+cWNULj/f0o5bCA+Tyh8jSTKFGU4UGzZXBNCOtWm2FrCYgwB8R4DQL4ue2ud3QpLkGOp0uiGYUZM6YDkDipMAAN0WAOgQYN5XYv0crNGyqhoJMCpUGjZqp0am9HuaP42H9EtRCC94LN1m0EkiahDeHB2LNjC5YOaUzHu3uL6uzBZtfhe7G7KDV+M4rEHH2i0KPQlAlMXga60TW8U5sHuEkXEQBcYFoGDr+P5RkQoMvtntjAAAAAElFTkSuQmCC")), CustomCommand)); } #endregion } public class CustomCommandAction : NDrawingCommandAction { #region Constructors /// /// Default constructor. /// public CustomCommandAction() { } /// /// Static constructor. /// static CustomCommandAction() { CustomCommandActionSchema = NSchema.Create(typeof(CustomCommandAction), NDrawingCommandAction.NDrawingCommandActionSchema); } #endregion #region Public Overrides /// /// Gets the command associated with this command action. /// /// public override NCommand GetCommand() { return CustomCommand; } /// /// Executes the command action. /// /// /// public override void Execute(NNode target, object parameter) { NDrawingView drawingView = GetDrawingView(target); NMessageBox.Show("Drawing Custom Command executed!", "Custom Command", ENMessageBoxButtons.OK, ENMessageBoxIcon.Information); } #endregion #region Schema /// /// Schema associated with CustomCommandAction. /// public static readonly NSchema CustomCommandActionSchema; #endregion } #endregion } }

Download a fully functional C# (.cs) Ribbon Customization Example for Blazor Solution